retell-sdk 4.28.0 → 4.29.0

package/src/resources/agent.ts

@@ -7,6 +7,17 @@ import * as Core from '../core';
 export class Agent extends APIResource {
   /**
    * Create a new agent
+   *
+   * @example
+   * ```ts
+   * const agentResponse = await client.agent.create({
+   *   response_engine: {
+   *     llm_id: 'llm_234sdertfsdsfsdf',
+   *     type: 'retell-llm',
+   *   },
+   *   voice_id: '11labs-Adrian',
+   * });
+   * ```
    */
   create(body: AgentCreateParams, options?: Core.RequestOptions): Core.APIPromise<AgentResponse> {
     return this._client.post('/create-agent', { body, ...options });
@@ -14,6 +25,13 @@ export class Agent extends APIResource {
 
   /**
    * Retrieve details of a specific agent
+   *
+   * @example
+   * ```ts
+   * const agentResponse = await client.agent.retrieve(
+   *   '16b980523634a6dc504898cda492e939',
+   * );
+   * ```
    */
   retrieve(
     agentId: string,
@@ -34,6 +52,14 @@ export class Agent extends APIResource {
 
   /**
    * Update an existing agent
+   *
+   * @example
+   * ```ts
+   * const agentResponse = await client.agent.update(
+   *   '16b980523634a6dc504898cda492e939',
+   *   { agent_name: 'Jarvis' },
+   * );
+   * ```
    */
   update(
     agentId: string,
@@ -50,6 +76,11 @@ export class Agent extends APIResource {
 
   /**
    * List all agents
+   *
+   * @example
+   * ```ts
+   * const agentResponses = await client.agent.list();
+   * ```
    */
   list(options?: Core.RequestOptions): Core.APIPromise<AgentListResponse> {
     return this._client.get('/list-agents', options);
@@ -57,6 +88,13 @@ export class Agent extends APIResource {
 
   /**
    * Delete an existing agent
+   *
+   * @example
+   * ```ts
+   * await client.agent.delete(
+   *   'oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD',
+   * );
+   * ```
    */
   delete(agentId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.delete(`/delete-agent/${agentId}`, {
@@ -67,6 +105,13 @@ export class Agent extends APIResource {
 
   /**
    * Get all versions of an agent
+   *
+   * @example
+   * ```ts
+   * const agentResponses = await client.agent.getVersions(
+   *   '16b980523634a6dc504898cda492e939',
+   * );
+   * ```
    */
   getVersions(agentId: string, options?: Core.RequestOptions): Core.APIPromise<AgentGetVersionsResponse> {
     return this._client.get(`/get-agent-versions/${agentId}`, options);
@@ -106,6 +151,12 @@ export interface AgentResponse {
    */
   agent_name?: string | null;
 
+  /**
+   * If set to true, DTMF input will be accepted and processed. If false, any DTMF
+   * input will be ignored. Default to true.
+   */
+  allow_user_dtmf?: boolean;
+
   /**
    * If set, will add ambient environment sound to the call to make experience more
    * realistic. Currently supports the following options:
@@ -180,6 +231,11 @@ export interface AgentResponse {
    */
   boosted_keywords?: Array<string> | null;
 
+  /**
+   * If set, determines what denoising mode to use. Default to noise-cancellation.
+   */
+  denoising_mode?: 'noise-cancellation' | 'noise-and-background-speech-cancellation';
+
   /**
    * Controls whether the agent would backchannel (agent interjects the speaker with
    * phrases like "yeah", "uh-huh" to signify interest and engagement). Backchannel
@@ -225,6 +281,11 @@ export interface AgentResponse {
    */
   interruption_sensitivity?: number;
 
+  /**
+   * Whether the agent is published.
+   */
+  is_published?: boolean;
+
   /**
    * Specifies what language (and dialect) the speech recognition will operate in.
    * For instance, selecting `en-GB` optimizes speech recognition for British
@@ -359,10 +420,12 @@ export interface AgentResponse {
    */
   stt_mode?: 'fast' | 'accurate';
 
+  user_dtmf_options?: AgentResponse.UserDtmfOptions | null;
+
   /**
    * Version of the agent.
    */
-  version?: number | null;
+  version?: unknown;
 
   /**
    * Optionally set the voice model used for the selected voice. Currently only
@@ -567,6 +630,27 @@ export namespace AgentResponse {
      */
     word: string;
   }
+
+  export interface UserDtmfOptions {
+    /**
+     * The maximum number of digits allowed in the user's DTMF (Dual-Tone
+     * Multi-Frequency) input per turn. Once this limit is reached, the input is
+     * considered complete and a response will be generated immediately.
+     */
+    digit_limit?: number | null;
+
+    /**
+     * A single key that signals the end of DTMF input. Acceptable values include any
+     * digit (0–9), the pound/hash symbol (#), or the asterisk (\*).
+     */
+    termination_key?: string | null;
+
+    /**
+     * The time (in milliseconds) to wait for user DTMF input before timing out. The
+     * timer resets with each digit received.
+     */
+    timeout_ms?: number;
+  }
 }
 
 export type AgentListResponse = Array<AgentResponse>;
@@ -595,6 +679,12 @@ export interface AgentCreateParams {
    */
   agent_name?: string | null;
 
+  /**
+   * If set to true, DTMF input will be accepted and processed. If false, any DTMF
+   * input will be ignored. Default to true.
+   */
+  allow_user_dtmf?: boolean;
+
   /**
    * If set, will add ambient environment sound to the call to make experience more
    * realistic. Currently supports the following options:
@@ -669,6 +759,11 @@ export interface AgentCreateParams {
    */
   boosted_keywords?: Array<string> | null;
 
+  /**
+   * If set, determines what denoising mode to use. Default to noise-cancellation.
+   */
+  denoising_mode?: 'noise-cancellation' | 'noise-and-background-speech-cancellation';
+
   /**
    * Controls whether the agent would backchannel (agent interjects the speaker with
    * phrases like "yeah", "uh-huh" to signify interest and engagement). Backchannel
@@ -848,6 +943,8 @@ export interface AgentCreateParams {
    */
   stt_mode?: 'fast' | 'accurate';
 
+  user_dtmf_options?: AgentCreateParams.UserDtmfOptions | null;
+
   /**
    * Version of the agent.
    */
@@ -1056,6 +1153,27 @@ export namespace AgentCreateParams {
      */
     word: string;
   }
+
+  export interface UserDtmfOptions {
+    /**
+     * The maximum number of digits allowed in the user's DTMF (Dual-Tone
+     * Multi-Frequency) input per turn. Once this limit is reached, the input is
+     * considered complete and a response will be generated immediately.
+     */
+    digit_limit?: number | null;
+
+    /**
+     * A single key that signals the end of DTMF input. Acceptable values include any
+     * digit (0–9), the pound/hash symbol (#), or the asterisk (\*).
+     */
+    termination_key?: string | null;
+
+    /**
+     * The time (in milliseconds) to wait for user DTMF input before timing out. The
+     * timer resets with each digit received.
+     */
+    timeout_ms?: number;
+  }
 }
 
 export interface AgentRetrieveParams {
@@ -1077,6 +1195,12 @@ export interface AgentUpdateParams {
    */
   agent_name?: string | null;
 
+  /**
+   * Body param: If set to true, DTMF input will be accepted and processed. If false,
+   * any DTMF input will be ignored. Default to true.
+   */
+  allow_user_dtmf?: boolean;
+
   /**
    * Body param: If set, will add ambient environment sound to the call to make
    * experience more realistic. Currently supports the following options:
@@ -1151,6 +1275,12 @@ export interface AgentUpdateParams {
    */
   boosted_keywords?: Array<string> | null;
 
+  /**
+   * Body param: If set, determines what denoising mode to use. Default to
+   * noise-cancellation.
+   */
+  denoising_mode?: 'noise-cancellation' | 'noise-and-background-speech-cancellation';
+
   /**
    * Body param: Controls whether the agent would backchannel (agent interjects the
    * speaker with phrases like "yeah", "uh-huh" to signify interest and engagement).
@@ -1344,6 +1474,11 @@ export interface AgentUpdateParams {
    */
   stt_mode?: 'fast' | 'accurate';
 
+  /**
+   * Body param:
+   */
+  user_dtmf_options?: AgentUpdateParams.UserDtmfOptions | null;
+
   /**
    * Body param: Version of the agent.
    */
@@ -1558,6 +1693,27 @@ export namespace AgentUpdateParams {
      */
     version?: number | null;
   }
+
+  export interface UserDtmfOptions {
+    /**
+     * The maximum number of digits allowed in the user's DTMF (Dual-Tone
+     * Multi-Frequency) input per turn. Once this limit is reached, the input is
+     * considered complete and a response will be generated immediately.
+     */
+    digit_limit?: number | null;
+
+    /**
+     * A single key that signals the end of DTMF input. Acceptable values include any
+     * digit (0–9), the pound/hash symbol (#), or the asterisk (\*).
+     */
+    termination_key?: string | null;
+
+    /**
+     * The time (in milliseconds) to wait for user DTMF input before timing out. The
+     * timer resets with each digit received.
+     */
+    timeout_ms?: number;
+  }
 }
 
 export declare namespace Agent {

package/src/resources/batch-call.ts

@@ -6,6 +6,15 @@ import * as Core from '../core';
 export class BatchCall extends APIResource {
   /**
    * Create a batch call
+   *
+   * @example
+   * ```ts
+   * const batchCallResponse =
+   *   await client.batchCall.createBatchCall({
+   *     from_number: '+14157774444',
+   *     tasks: [{ to_number: '+12137774445' }],
+   *   });
+   * ```
    */
   createBatchCall(
     body: BatchCallCreateBatchCallParams,

package/src/resources/call.ts

@@ -6,6 +6,13 @@ import * as Core from '../core';
 export class Call extends APIResource {
   /**
    * Retrieve details of a specific call
+   *
+   * @example
+   * ```ts
+   * const callResponse = await client.call.retrieve(
+   *   '119c3f8e47135a29e65947eeb34cf12d',
+   * );
+   * ```
    */
   retrieve(callId: string, options?: Core.RequestOptions): Core.APIPromise<CallResponse> {
     return this._client.get(`/v2/get-call/${callId}`, options);
@@ -13,6 +20,20 @@ export class Call extends APIResource {
 
   /**
    * Update metadata and sensitive data storage settings for an existing call
+   *
+   * @example
+   * ```ts
+   * const callResponse = await client.call.update(
+   *   'call_a4441234567890777c4a4a123e6',
+   *   {
+   *     metadata: {
+   *       customer_id: 'cust_123',
+   *       notes: 'Follow-up required',
+   *     },
+   *     opt_out_sensitive_data_storage: true,
+   *   },
+   * );
+   * ```
    */
   update(
     callId: string,
@@ -24,6 +45,11 @@ export class Call extends APIResource {
 
   /**
    * Retrieve call details
+   *
+   * @example
+   * ```ts
+   * const callResponses = await client.call.list();
+   * ```
    */
   list(body: CallListParams, options?: Core.RequestOptions): Core.APIPromise<CallListResponse> {
     return this._client.post('/v2/list-calls', { body, ...options });
@@ -31,6 +57,13 @@ export class Call extends APIResource {
 
   /**
    * Delete a specific call and its associated data
+   *
+   * @example
+   * ```ts
+   * await client.call.delete(
+   *   '119c3f8e47135a29e65947eeb34cf12d',
+   * );
+   * ```
    */
   delete(callId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.delete(`/v2/delete-call/${callId}`, {
@@ -41,6 +74,16 @@ export class Call extends APIResource {
 
   /**
    * Create a new outbound phone call
+   *
+   * @example
+   * ```ts
+   * const phoneCallResponse = await client.call.createPhoneCall(
+   *   {
+   *     from_number: '+14157774444',
+   *     to_number: '+12137774445',
+   *   },
+   * );
+   * ```
    */
   createPhoneCall(
     body: CallCreatePhoneCallParams,
@@ -51,6 +94,13 @@ export class Call extends APIResource {
 
   /**
    * Create a new web call
+   *
+   * @example
+   * ```ts
+   * const webCallResponse = await client.call.createWebCall({
+   *   agent_id: 'oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD',
+   * });
+   * ```
    */
   createWebCall(
     body: CallCreateWebCallParams,
@@ -61,6 +111,14 @@ export class Call extends APIResource {
 
   /**
    * Register a new phone call for custom telephony
+   *
+   * @example
+   * ```ts
+   * const phoneCallResponse =
+   *   await client.call.registerPhoneCall({
+   *     agent_id: 'oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD',
+   *   });
+   * ```
    */
   registerPhoneCall(
     body: CallRegisterPhoneCallParams,

package/src/resources/knowledge-base.ts

@@ -6,6 +6,14 @@ import * as Core from '../core';
 export class KnowledgeBase extends APIResource {
   /**
    * Create a new knowledge base
+   *
+   * @example
+   * ```ts
+   * const knowledgeBaseResponse =
+   *   await client.knowledgeBase.create({
+   *     knowledge_base_name: 'Sample KB',
+   *   });
+   * ```
    */
   create(
     body: KnowledgeBaseCreateParams,
@@ -19,6 +27,12 @@ export class KnowledgeBase extends APIResource {
 
   /**
    * Retrieve details of a specific knowledge base
+   *
+   * @example
+   * ```ts
+   * const knowledgeBaseResponse =
+   *   await client.knowledgeBase.retrieve('kb_1234567890');
+   * ```
    */
   retrieve(knowledgeBaseId: string, options?: Core.RequestOptions): Core.APIPromise<KnowledgeBaseResponse> {
     return this._client.get(`/get-knowledge-base/${knowledgeBaseId}`, options);
@@ -26,6 +40,12 @@ export class KnowledgeBase extends APIResource {
 
   /**
    * List all knowledge bases
+   *
+   * @example
+   * ```ts
+   * const knowledgeBaseResponses =
+   *   await client.knowledgeBase.list();
+   * ```
    */
   list(options?: Core.RequestOptions): Core.APIPromise<KnowledgeBaseListResponse> {
     return this._client.get('/list-knowledge-bases', options);
@@ -33,6 +53,11 @@ export class KnowledgeBase extends APIResource {
 
   /**
    * Delete an existing knowledge base
+   *
+   * @example
+   * ```ts
+   * await client.knowledgeBase.delete('kb_1234567890');
+   * ```
    */
   delete(knowledgeBaseId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.delete(`/delete-knowledge-base/${knowledgeBaseId}`, {
@@ -43,6 +68,12 @@ export class KnowledgeBase extends APIResource {
 
   /**
    * Add sources to a knowledge base
+   *
+   * @example
+   * ```ts
+   * const knowledgeBaseResponse =
+   *   await client.knowledgeBase.addSources('kb_1234567890');
+   * ```
    */
   addSources(
     knowledgeBaseId: string,
@@ -57,6 +88,15 @@ export class KnowledgeBase extends APIResource {
 
   /**
    * Delete an existing source from knowledge base
+   *
+   * @example
+   * ```ts
+   * const knowledgeBaseResponse =
+   *   await client.knowledgeBase.deleteSource(
+   *     'kb_1234567890',
+   *     'source_1234567890',
+   *   );
+   * ```
    */
   deleteSource(
     knowledgeBaseId: string,

package/src/resources/llm.ts

@@ -8,6 +8,11 @@ export class Llm extends APIResource {
   /**
    * Create a new Retell LLM Response Engine that can be attached to an agent. This
    * is used to generate response output for the agent.
+   *
+   * @example
+   * ```ts
+   * const llmResponse = await client.llm.create();
+   * ```
    */
   create(body: LlmCreateParams, options?: Core.RequestOptions): Core.APIPromise<LlmResponse> {
     return this._client.post('/create-retell-llm', { body, ...options });
@@ -15,6 +20,13 @@ export class Llm extends APIResource {
 
   /**
    * Retrieve details of a specific Retell LLM Response Engine
+   *
+   * @example
+   * ```ts
+   * const llmResponse = await client.llm.retrieve(
+   *   '16b980523634a6dc504898cda492e939',
+   * );
+   * ```
    */
   retrieve(
     llmId: string,
@@ -35,6 +47,17 @@ export class Llm extends APIResource {
 
   /**
    * Update an existing Retell LLM Response Engine
+   *
+   * @example
+   * ```ts
+   * const llmResponse = await client.llm.update(
+   *   '16b980523634a6dc504898cda492e939',
+   *   {
+   *     begin_message:
+   *       'Hey I am a virtual assistant calling from Retell Hospital.',
+   *   },
+   * );
+   * ```
    */
   update(
     llmId: string,
@@ -51,6 +74,11 @@ export class Llm extends APIResource {
 
   /**
    * List all Retell LLM Response Engines that can be attached to an agent.
+   *
+   * @example
+   * ```ts
+   * const llmResponses = await client.llm.list();
+   * ```
    */
   list(options?: Core.RequestOptions): Core.APIPromise<LlmListResponse> {
     return this._client.get('/list-retell-llms', options);
@@ -58,6 +86,11 @@ export class Llm extends APIResource {
 
   /**
    * Delete an existing Retell LLM Response Engine
+   *
+   * @example
+   * ```ts
+   * await client.llm.delete('oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD');
+   * ```
    */
   delete(llmId: string, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.delete(`/delete-retell-llm/${llmId}`, {
@@ -119,6 +152,11 @@ export interface LlmResponse {
     | LlmResponse.CustomTool
   > | null;
 
+  /**
+   * Whether the Retell LLM Response Engine is published.
+   */
+  is_published?: boolean;
+
   /**
    * A list of knowledge base ids to use for this resource. Set to null to remove all
    * knowledge bases.
@@ -186,7 +224,7 @@ export interface LlmResponse {
   /**
    * Version of the Retell LLM.
    */
-  version?: number | null;
+  version?: unknown;
 }
 
 export namespace LlmResponse {

package/src/resources/phone-number.ts

@@ -6,6 +6,12 @@ import * as Core from '../core';
 export class PhoneNumber extends APIResource {
   /**
    * Buy a new phone number & Bind agents
+   *
+   * @example
+   * ```ts
+   * const phoneNumberResponse =
+   *   await client.phoneNumber.create();
+   * ```
    */
   create(body: PhoneNumberCreateParams, options?: Core.RequestOptions): Core.APIPromise<PhoneNumberResponse> {
     return this._client.post('/create-phone-number', { body, ...options });
@@ -13,6 +19,12 @@ export class PhoneNumber extends APIResource {
 
   /**
    * Retrieve details of a specific phone number
+   *
+   * @example
+   * ```ts
+   * const phoneNumberResponse =
+   *   await client.phoneNumber.retrieve('+14157774444');
+   * ```
    */
   retrieve(phoneNumber: string, options?: Core.RequestOptions): Core.APIPromise<PhoneNumberResponse> {
     return this._client.get(`/get-phone-number/${phoneNumber}`, options);
@@ -20,6 +32,18 @@ export class PhoneNumber extends APIResource {
 
   /**
    * Update agent bound to a purchased phone number
+   *
+   * @example
+   * ```ts
+   * const phoneNumberResponse = await client.phoneNumber.update(
+   *   '+14157774444',
+   *   {
+   *     inbound_agent_id: 'oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD',
+   *     nickname: 'Frontdesk Number',
+   *     outbound_agent_id: 'oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD',
+   *   },
+   * );
+   * ```
    */
   update(
     phoneNumber: string,
@@ -31,6 +55,12 @@ export class PhoneNumber extends APIResource {
 
   /**
    * List all phone numbers
+   *
+   * @example
+   * ```ts
+   * const phoneNumberResponses =
+   *   await client.phoneNumber.list();
+   * ```
    */
   list(options?: Core.RequestOptions): Core.APIPromise<PhoneNumberListResponse> {
     return this._client.get('/list-phone-numbers', options);
@@ -38,6 +68,11 @@ export class PhoneNumber extends APIResource {
 
   /**
    * Delete an existing phone number
+   *
+   * @example
+   * ```ts
+   * await client.phoneNumber.delete('+14157774444');
+   * ```
    */
   delete(phoneNumber: string, options?: Core.RequestOptions): Core.APIPromise<void> {
     return this._client.delete(`/delete-phone-number/${phoneNumber}`, {
@@ -48,6 +83,16 @@ export class PhoneNumber extends APIResource {
 
   /**
    * Import a phone number from custom telephony & Bind agents
+   *
+   * @example
+   * ```ts
+   * const phoneNumberResponse = await client.phoneNumber.import(
+   *   {
+   *     phone_number: '+14157774444',
+   *     termination_uri: 'someuri.pstn.twilio.com',
+   *   },
+   * );
+   * ```
    */
   import(body: PhoneNumberImportParams, options?: Core.RequestOptions): Core.APIPromise<PhoneNumberResponse> {
     return this._client.post('/import-phone-number', { body, ...options });

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.28.0'; // x-release-please-version
+export const VERSION = '4.29.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "4.28.0";
+export declare const VERSION = "4.29.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '4.28.0'; // x-release-please-version
+exports.VERSION = '4.29.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '4.28.0'; // x-release-please-version
+export const VERSION = '4.29.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map