telnyx 7.23.0 → 7.24.0

package/src/resources/ai/assistants/assistants.ts

@@ -806,6 +806,15 @@ export namespace AssistantTool {
          */
         to: string;
 
+        /**
+         * DTMF digits to send automatically after the transfer destination answers. Useful
+         * for reaching an extension behind an IVR (e.g. `"200"` to dial extension 200 once
+         * the called party picks up). Allowed characters: `0-9`, `A-D`, `w` (0.5s pause),
+         * `W` (1s pause), `*`, `#`. Maximum 64 characters. When omitted, no automatic DTMF
+         * is sent.
+         */
+        extension?: string;
+
         /**
          * The warm transfer message to deliver to this specific target. When set, it takes
          * precedence over the message the assistant composes from
@@ -817,6 +826,18 @@ export namespace AssistantTool {
          * The name of the target.
          */
         name?: string;
+
+        /**
+         * SIP Authentication password used for SIP challenges. Applies when `to` is a SIP
+         * URI.
+         */
+        sip_auth_password?: string;
+
+        /**
+         * SIP Authentication username used for SIP challenges. Applies when `to` is a SIP
+         * URI.
+         */
+        sip_auth_username?: string;
       }
 
       export interface CustomHeader {
@@ -1843,7 +1864,7 @@ export interface FlowNode {
   /**
    * Per-node voice override (response form).
    */
-  voice_settings?: VoiceSettings;
+  voice_settings?: InferenceEmbeddingVoiceSettings;
 }
 
 /**
@@ -1935,7 +1956,7 @@ export interface FlowNodeReq {
    * Per-node voice override. Only fields set here override the assistant-level voice
    * settings; unset fields cascade.
    */
-  voice_settings?: VoiceSettings;
+  voice_settings?: InferenceEmbeddingVoiceSettings;
 }
 
 export interface HangupTool {
@@ -2140,7 +2161,7 @@ export interface InferenceEmbedding {
    */
   version_name?: string;
 
-  voice_settings?: VoiceSettings;
+  voice_settings?: InferenceEmbeddingVoiceSettings;
 
   /**
    * Configuration settings for the assistant's web widget.
@@ -2182,6 +2203,184 @@ export interface InferenceEmbeddingInterruptionSettings {
   start_speaking_plan?: StartSpeakingPlan;
 }
 
+export interface InferenceEmbeddingVoiceSettings {
+  /**
+   * The voice to be used by the voice assistant. Check the full list of
+   * [available voices](https://developers.telnyx.com/docs/tts-stt/tts-available-voices)
+   * via our voices API. To use ElevenLabs, you must reference your ElevenLabs API
+   * key as an integration secret under the `api_key_ref` field. See
+   * [integration secrets documentation](https://developers.telnyx.com/api-reference/integration-secrets/create-a-secret)
+   * for details. For Telnyx voices, use `Telnyx.<model_id>.<voice_id>` (e.g.
+   * Telnyx.KokoroTTS.af_heart). For Soniox voices, use `Soniox.tts-rt-v2.<voice_id>`
+   * (e.g. Soniox.tts-rt-v2.Emma); every Soniox voice speaks all supported languages.
+   * The voice portion of the identifier supports
+   * [dynamic variables](https://developers.telnyx.com/docs/inference/ai-assistants/dynamic-variables)
+   * using mustache syntax (e.g. `Telnyx.Ultra.{{voice_id}}`). The variable is
+   * resolved at call time from your dynamic variables webhook, allowing you to
+   * select the voice dynamically per call.
+   */
+  voice: string;
+
+  /**
+   * The `identifier` for an integration secret
+   * [/v2/integration_secrets](https://developers.telnyx.com/api-reference/integration-secrets/create-a-secret)
+   * that refers to your ElevenLabs API key. Warning: Free plans are unlikely to work
+   * with this integration.
+   */
+  api_key_ref?: string;
+
+  /**
+   * Optional background audio to play on the call. Use a predefined media bed, or
+   * supply a looped MP3 URL. If a media URL is chosen in the portal, customers can
+   * preview it before saving.
+   */
+  background_audio?:
+    | InferenceEmbeddingVoiceSettings.UnionMember0
+    | InferenceEmbeddingVoiceSettings.UnionMember1
+    | InferenceEmbeddingVoiceSettings.UnionMember2;
+
+  /**
+   * Enables emotionally expressive speech using SSML emotion tags. When enabled, the
+   * assistant uses audio tags like angry, excited, content, and sad to add emotional
+   * nuance. Only supported for Telnyx Ultra voices.
+   */
+  expressive_mode?: boolean;
+
+  /**
+   * Enhances recognition for specific languages and dialects during MiniMax TTS
+   * synthesis. Default is null (no boost). Set to 'auto' for automatic language
+   * detection. Only applicable when using MiniMax voices.
+   */
+  language_boost?:
+    | 'auto'
+    | 'Chinese'
+    | 'Chinese,Yue'
+    | 'English'
+    | 'Arabic'
+    | 'Russian'
+    | 'Spanish'
+    | 'French'
+    | 'Portuguese'
+    | 'German'
+    | 'Turkish'
+    | 'Dutch'
+    | 'Ukrainian'
+    | 'Vietnamese'
+    | 'Indonesian'
+    | 'Japanese'
+    | 'Italian'
+    | 'Korean'
+    | 'Thai'
+    | 'Polish'
+    | 'Romanian'
+    | 'Greek'
+    | 'Czech'
+    | 'Finnish'
+    | 'Hindi'
+    | 'Bulgarian'
+    | 'Danish'
+    | 'Hebrew'
+    | 'Malay'
+    | 'Persian'
+    | 'Slovak'
+    | 'Swedish'
+    | 'Croatian'
+    | 'Filipino'
+    | 'Hungarian'
+    | 'Norwegian'
+    | 'Slovenian'
+    | 'Catalan'
+    | 'Nynorsk'
+    | 'Tamil'
+    | 'Afrikaans'
+    | null;
+
+  /**
+   * Determines how closely the AI should adhere to the original voice when
+   * attempting to replicate it. Only applicable when using ElevenLabs.
+   */
+  similarity_boost?: number;
+
+  /**
+   * Adjusts speech velocity. 1.0 is default speed; values less than 1.0 slow speech;
+   * values greater than 1.0 accelerate it. Only applicable when using ElevenLabs.
+   */
+  speed?: number;
+
+  /**
+   * Determines the style exaggeration of the voice. Amplifies speaker style but
+   * consumes additional resources when set above 0. Only applicable when using
+   * ElevenLabs.
+   */
+  style?: number;
+
+  /**
+   * Determines how stable the voice is and the randomness between each generation.
+   * Lower values create a broader emotional range; higher values produce more
+   * consistent, monotonous output. Only applicable when using ElevenLabs.
+   */
+  temperature?: number;
+
+  /**
+   * Amplifies similarity to the original speaker voice. Increases computational load
+   * and latency slightly. Only applicable when using ElevenLabs.
+   */
+  use_speaker_boost?: boolean;
+
+  /**
+   * The speed of the voice in the range [0.25, 2.0]. 1.0 is deafult speed. Larger
+   * numbers make the voice faster, smaller numbers make it slower. This is only
+   * applicable for Telnyx Natural voices and Soniox voices (0.7 to 1.3 for Soniox).
+   */
+  voice_speed?: number;
+}
+
+export namespace InferenceEmbeddingVoiceSettings {
+  export interface UnionMember0 {
+    /**
+     * Select from predefined media options.
+     */
+    type: 'predefined_media';
+
+    /**
+     * The predefined media to use. `silence` disables background audio.
+     */
+    value: 'silence' | 'office';
+
+    /**
+     * Volume level for the predefined background audio. Supports values from 0.1 to
+     * 1.0 in 0.1 increments.
+     */
+    volume?: number;
+  }
+
+  export interface UnionMember1 {
+    /**
+     * Provide a direct URL to an MP3 file. The audio will loop during the call.
+     */
+    type: 'media_url';
+
+    /**
+     * HTTPS URL to an MP3 file.
+     */
+    value: string;
+  }
+
+  export interface UnionMember2 {
+    /**
+     * Reference a previously uploaded media by its name from Telnyx Media Storage.
+     */
+    type: 'media_name';
+
+    /**
+     * The `name` of a media asset created via
+     * [Media Storage API](https://developers.telnyx.com/api/media-storage/create-media-storage).
+     * The audio will loop during the call.
+     */
+    value: string;
+  }
+}
+
 export interface InferenceEmbeddingWebhookToolParams {
   type: 'webhook';
 
@@ -2197,6 +2396,14 @@ export interface InferenceEmbeddingWebhookToolParams {
    * per assistant).
    */
   shared?: boolean;
+
+  /**
+   * The maximum number of milliseconds to wait for the webhook to respond before the
+   * tool call is aborted. Set this at the tool level, as a sibling of `type` — a
+   * `timeout_ms` nested inside the `webhook` object is stored but not applied, and
+   * the tool runs at this default instead. Applies when `webhook.async` is false.
+   */
+  timeout_ms?: number;
 }
 
 export namespace InferenceEmbeddingWebhookToolParams {
@@ -2308,12 +2515,6 @@ export namespace InferenceEmbeddingWebhookToolParams {
      * dot-notation path to the value in the response body.
      */
     store_fields_as_variables?: Array<Webhook.StoreFieldsAsVariable>;
-
-    /**
-     * The maximum number of milliseconds to wait for the webhook to respond. Only
-     * applicable when async is false.
-     */
-    timeout_ms?: number;
   }
 
   export namespace Webhook {
@@ -3454,6 +3655,14 @@ export interface WebhookTool {
   type: 'webhook';
 
   webhook: WebhookTool.Webhook;
+
+  /**
+   * The maximum number of milliseconds to wait for the webhook to respond before the
+   * tool call is aborted. Set this at the tool level, as a sibling of `type` — a
+   * `timeout_ms` nested inside the `webhook` object is not applied, and the tool
+   * runs at this default instead.
+   */
+  timeout_ms?: number;
 }
 
 export namespace WebhookTool {
@@ -3866,7 +4075,7 @@ export interface AssistantCreateParams {
   /**
    * Body param
    */
-  voice_settings?: VoiceSettings;
+  voice_settings?: InferenceEmbeddingVoiceSettings;
 
   /**
    * Body param: Configuration settings for the assistant's web widget.
@@ -4120,7 +4329,7 @@ export interface AssistantUpdateParams {
    */
   version_name?: string;
 
-  voice_settings?: VoiceSettings;
+  voice_settings?: InferenceEmbeddingVoiceSettings;
 
   /**
    * Configuration settings for the assistant's web widget.
@@ -4244,6 +4453,7 @@ export declare namespace Assistants {
     type ImportMetadata as ImportMetadata,
     type InferenceEmbedding as InferenceEmbedding,
     type InferenceEmbeddingInterruptionSettings as InferenceEmbeddingInterruptionSettings,
+    type InferenceEmbeddingVoiceSettings as InferenceEmbeddingVoiceSettings,
     type InferenceEmbeddingWebhookToolParams as InferenceEmbeddingWebhookToolParams,
     type InsightSettings as InsightSettings,
     type MessagingSettings as MessagingSettings,

package/src/resources/ai/assistants/index.ts

@@ -29,6 +29,7 @@ export {
   type ImportMetadata,
   type InferenceEmbedding,
   type InferenceEmbeddingInterruptionSettings,
+  type InferenceEmbeddingVoiceSettings,
   type InferenceEmbeddingWebhookToolParams,
   type InsightSettings,
   type MessagingSettings,

package/src/resources/ai/assistants/versions.ts

@@ -290,7 +290,7 @@ export interface UpdateAssistant {
    */
   version_name?: string;
 
-  voice_settings?: AssistantsAPI.VoiceSettings;
+  voice_settings?: AssistantsAPI.InferenceEmbeddingVoiceSettings;
 
   /**
    * Configuration settings for the assistant's web widget.
@@ -534,7 +534,7 @@ export interface VersionUpdateParams {
   /**
    * Body param
    */
-  voice_settings?: AssistantsAPI.VoiceSettings;
+  voice_settings?: AssistantsAPI.InferenceEmbeddingVoiceSettings;
 
   /**
    * Body param: Configuration settings for the assistant's web widget.

package/src/resources/ai/collections/collections.ts

@@ -13,6 +13,7 @@ import {
 } from './settings';
 import * as SourcesAPI from './sources';
 import {
+  CollectionsSource,
   Source,
   SourceCreateParams,
   SourceCreateResponse,
@@ -166,7 +167,7 @@ export interface Collection {
 
   slug?: string;
 
-  sources?: Array<SourcesAPI.Source>;
+  sources?: Array<SourcesAPI.CollectionsSource>;
 
   status?: string;
 
@@ -239,6 +240,7 @@ export declare namespace Collections {
 
   export {
     Sources as Sources,
+    type CollectionsSource as CollectionsSource,
     type Source as Source,
     type SourceRequest as SourceRequest,
     type SourceType as SourceType,

package/src/resources/ai/collections/index.ts

@@ -20,6 +20,7 @@ export {
 } from './settings';
 export {
   Sources,
+  type CollectionsSource,
   type Source,
   type SourceRequest,
   type SourceType,
@@ -29,4 +30,5 @@ export {
   type SourceCreateParams,
   type SourceReplaceParams,
   type SourceDeleteParams,
+  type SourcesDefaultFlatPagination,
 } from './sources';

package/src/resources/ai/collections/sources.ts

@@ -2,6 +2,7 @@
 
 import { APIResource } from '../../../core/resource';
 import { APIPromise } from '../../../core/api-promise';
+import { DefaultFlatPagination } from '../../../core/pagination';
 import { buildHeaders } from '../../../internal/headers';
 import { RequestOptions } from '../../../internal/request-options';
 import { path } from '../../../internal/utils/path';
@@ -81,7 +82,9 @@ export class Sources extends APIResource {
   }
 }
 
-export interface Source {
+export type SourcesDefaultFlatPagination = DefaultFlatPagination<Source>;
+
+export interface CollectionsSource {
   id?: string;
 
   /**
@@ -106,6 +109,36 @@ export interface Source {
   status?: string;
 }
 
+export interface Source {
+  /**
+   * Identifies one source within its profile: an ingested session, or one remembered
+   * fact. Returned by `ingest` and `remember` when the write is accepted.
+   * Re-ingesting a session keeps its source id.
+   */
+  id: string;
+
+  /**
+   * Memories extracted from this source. A memory derived from several sources is
+   * not counted here.
+   */
+  memory_count: number;
+
+  /**
+   * The session this source was ingested as. Null for a remembered fact.
+   */
+  session_id: string | null;
+
+  /**
+   * When the source was first stored.
+   */
+  created_at?: string | null;
+
+  /**
+   * When the source was last written; re-ingesting moves it.
+   */
+  updated_at?: string | null;
+}
+
 export interface SourceRequest {
   /**
    * The type of Telnyx data attached as a source. `bucket` requires an additional
@@ -132,15 +165,15 @@ export type SourceType = 'voice' | 'meeting_bot' | 'message' | 'bucket';
  * Envelope containing a single collection source.
  */
 export interface SourceCreateResponse {
-  data?: Source;
+  data?: CollectionsSource;
 }
 
 export interface SourceListResponse {
-  data?: Array<Source>;
+  data?: Array<CollectionsSource>;
 }
 
 export interface SourceReplaceResponse {
-  data?: Array<Source>;
+  data?: Array<CollectionsSource>;
 
   /**
    * Reports which source IDs were added, retained, and removed by a replace
@@ -191,6 +224,7 @@ export interface SourceDeleteParams {
 
 export declare namespace Sources {
   export {
+    type CollectionsSource as CollectionsSource,
     type Source as Source,
     type SourceRequest as SourceRequest,
     type SourceType as SourceType,

package/src/resources/ai/index.ts

@@ -40,6 +40,7 @@ export {
   type ImportMetadata,
   type InferenceEmbedding,
   type InferenceEmbeddingInterruptionSettings,
+  type InferenceEmbeddingVoiceSettings,
   type InferenceEmbeddingWebhookToolParams,
   type InsightSettings,
   type MessagingSettings,
@@ -140,6 +141,7 @@ export {
   type McpServerUpdateParams,
   type McpServersDefaultFlatPaginationTopLevelArray,
 } from './mcp-servers';
+export { Memory } from './memory/index';
 export {
   Missions,
   type EventsListResponse,

package/src/resources/ai/memory/index.ts

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Memory } from './memory';
+export { Namespaces, type NamespaceRetrieveResponse, type NamespaceRetrieveParams } from './namespaces/index';

package/src/resources/ai/memory/memory.ts

@@ -0,0 +1,19 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as NamespacesAPI from './namespaces/namespaces';
+import { NamespaceRetrieveParams, NamespaceRetrieveResponse, Namespaces } from './namespaces/namespaces';
+
+export class Memory extends APIResource {
+  namespaces: NamespacesAPI.Namespaces = new NamespacesAPI.Namespaces(this._client);
+}
+
+Memory.Namespaces = Namespaces;
+
+export declare namespace Memory {
+  export {
+    Namespaces as Namespaces,
+    type NamespaceRetrieveResponse as NamespaceRetrieveResponse,
+    type NamespaceRetrieveParams as NamespaceRetrieveParams,
+  };
+}

package/src/resources/ai/memory/namespaces/index.ts

@@ -0,0 +1,21 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Namespaces, type NamespaceRetrieveResponse, type NamespaceRetrieveParams } from './namespaces';
+export {
+  Profiles,
+  type PageMeta,
+  type ProfileListResponse,
+  type ProfileDeleteResponse,
+  type ProfileIngestResponse,
+  type ProfileRecallResponse,
+  type ProfileRememberResponse,
+  type ProfileRetrieveSummaryResponse,
+  type ProfileListParams,
+  type ProfileDeleteParams,
+  type ProfileIngestParams,
+  type ProfileRecallParams,
+  type ProfileRememberParams,
+  type ProfileRetrieveSummaryParams,
+  type ProfileListResponsesDefaultFlatPagination,
+} from './profiles/index';
+export { Settings, type NamespaceSettingsResponse, type SettingPatchAllParams } from './settings';

package/src/resources/ai/memory/namespaces/namespaces.ts

@@ -0,0 +1,116 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../../core/resource';
+import * as SettingsAPI from './settings';
+import { NamespaceSettingsResponse, SettingPatchAllParams, Settings } from './settings';
+import * as ProfilesAPI from './profiles/profiles';
+import {
+  PageMeta,
+  ProfileDeleteParams,
+  ProfileDeleteResponse,
+  ProfileIngestParams,
+  ProfileIngestResponse,
+  ProfileListParams,
+  ProfileListResponse,
+  ProfileListResponsesDefaultFlatPagination,
+  ProfileRecallParams,
+  ProfileRecallResponse,
+  ProfileRememberParams,
+  ProfileRememberResponse,
+  ProfileRetrieveSummaryParams,
+  ProfileRetrieveSummaryResponse,
+  Profiles,
+} from './profiles/profiles';
+import { APIPromise } from '../../../../core/api-promise';
+import { RequestOptions } from '../../../../internal/request-options';
+import { path } from '../../../../internal/utils/path';
+
+/**
+ * Whether a write has finished.
+ */
+export class Namespaces extends APIResource {
+  profiles: ProfilesAPI.Profiles = new ProfilesAPI.Profiles(this._client);
+  settings: SettingsAPI.Settings = new SettingsAPI.Settings(this._client);
+
+  /**
+   * Whether a write has finished. Both `ingest` and `remember` return an
+   * `operation_id`, and a memory is not recallable until its operation completes —
+   * extraction, embedding and consolidation all run first.
+   *
+   * @example
+   * ```ts
+   * const namespace =
+   *   await client.ai.memory.namespaces.retrieve(
+   *     'operation_id',
+   *     { namespace: 'namespace' },
+   *   );
+   * ```
+   */
+  retrieve(
+    operationID: string,
+    params: NamespaceRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<NamespaceRetrieveResponse> {
+    const { namespace } = params;
+    return this._client.get(path`/ai/memory/namespaces/${namespace}/operations/${operationID}`, options);
+  }
+}
+
+export interface NamespaceRetrieveResponse {
+  data: NamespaceRetrieveResponse.Data;
+}
+
+export namespace NamespaceRetrieveResponse {
+  export interface Data {
+    operation_id: string;
+
+    /**
+     * Where the write is. `completed`, `failed` and `cancelled` are terminal: stop
+     * polling at any of them, and treat `failed` and `cancelled` as writes that did
+     * not happen.
+     */
+    status: 'pending' | 'processing' | 'completed' | 'failed' | 'cancelled';
+
+    completed_at?: string | null;
+
+    created_at?: string | null;
+  }
+}
+
+export interface NamespaceRetrieveParams {
+  namespace: string;
+}
+
+Namespaces.Profiles = Profiles;
+Namespaces.Settings = Settings;
+
+export declare namespace Namespaces {
+  export {
+    type NamespaceRetrieveResponse as NamespaceRetrieveResponse,
+    type NamespaceRetrieveParams as NamespaceRetrieveParams,
+  };
+
+  export {
+    Profiles as Profiles,
+    type PageMeta as PageMeta,
+    type ProfileListResponse as ProfileListResponse,
+    type ProfileDeleteResponse as ProfileDeleteResponse,
+    type ProfileIngestResponse as ProfileIngestResponse,
+    type ProfileRecallResponse as ProfileRecallResponse,
+    type ProfileRememberResponse as ProfileRememberResponse,
+    type ProfileRetrieveSummaryResponse as ProfileRetrieveSummaryResponse,
+    type ProfileListResponsesDefaultFlatPagination as ProfileListResponsesDefaultFlatPagination,
+    type ProfileListParams as ProfileListParams,
+    type ProfileDeleteParams as ProfileDeleteParams,
+    type ProfileIngestParams as ProfileIngestParams,
+    type ProfileRecallParams as ProfileRecallParams,
+    type ProfileRememberParams as ProfileRememberParams,
+    type ProfileRetrieveSummaryParams as ProfileRetrieveSummaryParams,
+  };
+
+  export {
+    Settings as Settings,
+    type NamespaceSettingsResponse as NamespaceSettingsResponse,
+    type SettingPatchAllParams as SettingPatchAllParams,
+  };
+}

package/src/resources/ai/memory/namespaces/profiles/index.ts

@@ -0,0 +1,35 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Memories,
+  type MemoryRetrieveResponse,
+  type MemoryListResponse,
+  type MemoryListParams,
+  type MemoryRetrieveParams,
+  type MemoryListResponsesDefaultFlatPagination,
+} from './memories';
+export {
+  Profiles,
+  type PageMeta,
+  type ProfileListResponse,
+  type ProfileDeleteResponse,
+  type ProfileIngestResponse,
+  type ProfileRecallResponse,
+  type ProfileRememberResponse,
+  type ProfileRetrieveSummaryResponse,
+  type ProfileListParams,
+  type ProfileDeleteParams,
+  type ProfileIngestParams,
+  type ProfileRecallParams,
+  type ProfileRememberParams,
+  type ProfileRetrieveSummaryParams,
+  type ProfileListResponsesDefaultFlatPagination,
+} from './profiles';
+export {
+  Sources,
+  type SourceRetrieveResponse,
+  type SourceDeleteResponse,
+  type SourceListParams,
+  type SourceDeleteParams,
+  type SourceRetrieveParams,
+} from './sources';