telnyx 3.3.2 → 3.4.0

package/src/resources/calls/actions.ts

@@ -1,6 +1,7 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
+import * as ActionsAPI from './actions';
 import * as CallsAPI from './calls';
 import * as AssistantsAPI from '../ai/assistants/assistants';
 import { APIPromise } from '../../core/api-promise';
@@ -1261,11 +1262,17 @@ export interface TranscriptionStartRequest {
   command_id?: string;
 
   /**
-   * Engine to use for speech recognition. `A` - `Google`, `B` - `Telnyx`.
+   * Engine to use for speech recognition. Legacy values `A` - `Google`, `B` -
+   * `Telnyx` are supported for backward compatibility.
    */
-  transcription_engine?: 'A' | 'B';
+  transcription_engine?: 'Google' | 'Telnyx' | 'Deepgram' | 'A' | 'B';
 
-  transcription_engine_config?: TranscriptionEngineAConfig | TranscriptionEngineBConfig;
+  transcription_engine_config?:
+    | TranscriptionStartRequest.TranscriptionEngineGoogleConfig
+    | TranscriptionStartRequest.TranscriptionEngineTelnyxConfig
+    | TranscriptionStartRequest.TranscriptionEngineDeepgramConfig
+    | TranscriptionEngineAConfig
+    | TranscriptionEngineBConfig;
 
   /**
    * Indicates which leg of the call will be transcribed. Use `inbound` for the leg
@@ -1275,6 +1282,274 @@ export interface TranscriptionStartRequest {
   transcription_tracks?: string;
 }
 
+export namespace TranscriptionStartRequest {
+  export interface TranscriptionEngineGoogleConfig {
+    /**
+     * Enables speaker diarization.
+     */
+    enable_speaker_diarization?: boolean;
+
+    /**
+     * Hints to improve transcription accuracy.
+     */
+    hints?: Array<string>;
+
+    /**
+     * Whether to send also interim results. If set to false, only final results will
+     * be sent.
+     */
+    interim_results?: boolean;
+
+    /**
+     * Language to use for speech recognition
+     */
+    language?: ActionsAPI.GoogleTranscriptionLanguage;
+
+    /**
+     * Defines maximum number of speakers in the conversation.
+     */
+    max_speaker_count?: number;
+
+    /**
+     * Defines minimum number of speakers in the conversation.
+     */
+    min_speaker_count?: number;
+
+    /**
+     * The model to use for transcription.
+     */
+    model?:
+      | 'latest_long'
+      | 'latest_short'
+      | 'command_and_search'
+      | 'phone_call'
+      | 'video'
+      | 'default'
+      | 'medical_conversation'
+      | 'medical_dictation';
+
+    /**
+     * Enables profanity_filter.
+     */
+    profanity_filter?: boolean;
+
+    /**
+     * Speech context to improve transcription accuracy.
+     */
+    speech_context?: Array<TranscriptionEngineGoogleConfig.SpeechContext>;
+
+    /**
+     * Engine identifier for Google transcription service
+     */
+    transcription_engine?: 'Google';
+
+    /**
+     * Enables enhanced transcription, this works for models `phone_call` and `video`.
+     */
+    use_enhanced?: boolean;
+  }
+
+  export namespace TranscriptionEngineGoogleConfig {
+    export interface SpeechContext {
+      /**
+       * Boost factor for the speech context.
+       */
+      boost?: number;
+
+      phrases?: Array<string>;
+    }
+  }
+
+  export interface TranscriptionEngineTelnyxConfig {
+    /**
+     * Language to use for speech recognition
+     */
+    language?:
+      | 'en'
+      | 'zh'
+      | 'de'
+      | 'es'
+      | 'ru'
+      | 'ko'
+      | 'fr'
+      | 'ja'
+      | 'pt'
+      | 'tr'
+      | 'pl'
+      | 'ca'
+      | 'nl'
+      | 'ar'
+      | 'sv'
+      | 'it'
+      | 'id'
+      | 'hi'
+      | 'fi'
+      | 'vi'
+      | 'he'
+      | 'uk'
+      | 'el'
+      | 'ms'
+      | 'cs'
+      | 'ro'
+      | 'da'
+      | 'hu'
+      | 'ta'
+      | 'no'
+      | 'th'
+      | 'ur'
+      | 'hr'
+      | 'bg'
+      | 'lt'
+      | 'la'
+      | 'mi'
+      | 'ml'
+      | 'cy'
+      | 'sk'
+      | 'te'
+      | 'fa'
+      | 'lv'
+      | 'bn'
+      | 'sr'
+      | 'az'
+      | 'sl'
+      | 'kn'
+      | 'et'
+      | 'mk'
+      | 'br'
+      | 'eu'
+      | 'is'
+      | 'hy'
+      | 'ne'
+      | 'mn'
+      | 'bs'
+      | 'kk'
+      | 'sq'
+      | 'sw'
+      | 'gl'
+      | 'mr'
+      | 'pa'
+      | 'si'
+      | 'km'
+      | 'sn'
+      | 'yo'
+      | 'so'
+      | 'af'
+      | 'oc'
+      | 'ka'
+      | 'be'
+      | 'tg'
+      | 'sd'
+      | 'gu'
+      | 'am'
+      | 'yi'
+      | 'lo'
+      | 'uz'
+      | 'fo'
+      | 'ht'
+      | 'ps'
+      | 'tk'
+      | 'nn'
+      | 'mt'
+      | 'sa'
+      | 'lb'
+      | 'my'
+      | 'bo'
+      | 'tl'
+      | 'mg'
+      | 'as'
+      | 'tt'
+      | 'haw'
+      | 'ln'
+      | 'ha'
+      | 'ba'
+      | 'jw'
+      | 'su'
+      | 'auto_detect';
+
+    /**
+     * Engine identifier for Telnyx transcription service
+     */
+    transcription_engine?: 'Telnyx';
+
+    /**
+     * The model to use for transcription.
+     */
+    transcription_model?: 'openai/whisper-tiny' | 'openai/whisper-large-v3-turbo';
+  }
+
+  export interface TranscriptionEngineDeepgramConfig {
+    /**
+     * Engine identifier for Deepgram transcription service
+     */
+    transcription_engine: 'Deepgram';
+
+    /**
+     * The model to use for transcription.
+     */
+    transcription_model: 'deepgram/nova-2' | 'deepgram/nova-3';
+
+    /**
+     * Language to use for speech recognition. Available languages depend on the
+     * selected model.
+     */
+    language?:
+      | 'bg'
+      | 'ca'
+      | 'zh'
+      | 'zh-CN'
+      | 'zh-Hans'
+      | 'zh-TW'
+      | 'zh-Hant'
+      | 'zh-HK'
+      | 'cs'
+      | 'da'
+      | 'da-DK'
+      | 'nl'
+      | 'en'
+      | 'en-US'
+      | 'en-AU'
+      | 'en-GB'
+      | 'en-NZ'
+      | 'en-IN'
+      | 'et'
+      | 'fi'
+      | 'nl-BE'
+      | 'fr'
+      | 'fr-CA'
+      | 'de'
+      | 'de-CH'
+      | 'el'
+      | 'hi'
+      | 'hu'
+      | 'id'
+      | 'it'
+      | 'ja'
+      | 'ko'
+      | 'ko-KR'
+      | 'lv'
+      | 'lt'
+      | 'ms'
+      | 'no'
+      | 'pl'
+      | 'pt'
+      | 'pt-BR'
+      | 'pt-PT'
+      | 'ro'
+      | 'ru'
+      | 'sk'
+      | 'es'
+      | 'es-419'
+      | 'sv'
+      | 'sv-SE'
+      | 'th'
+      | 'th-TH'
+      | 'tr'
+      | 'uk'
+      | 'vi'
+      | 'auto_detect';
+  }
+}
+
 export interface ActionAnswerResponse {
   data?: ActionAnswerResponse.Data;
 }
@@ -3081,11 +3356,17 @@ export interface ActionStartTranscriptionParams {
   command_id?: string;
 
   /**
-   * Engine to use for speech recognition. `A` - `Google`, `B` - `Telnyx`.
+   * Engine to use for speech recognition. Legacy values `A` - `Google`, `B` -
+   * `Telnyx` are supported for backward compatibility.
    */
-  transcription_engine?: 'A' | 'B';
+  transcription_engine?: 'Google' | 'Telnyx' | 'Deepgram' | 'A' | 'B';
 
-  transcription_engine_config?: TranscriptionEngineAConfig | TranscriptionEngineBConfig;
+  transcription_engine_config?:
+    | ActionStartTranscriptionParams.TranscriptionEngineGoogleConfig
+    | ActionStartTranscriptionParams.TranscriptionEngineTelnyxConfig
+    | ActionStartTranscriptionParams.TranscriptionEngineDeepgramConfig
+    | TranscriptionEngineAConfig
+    | TranscriptionEngineBConfig;
 
   /**
    * Indicates which leg of the call will be transcribed. Use `inbound` for the leg
@@ -3095,6 +3376,274 @@ export interface ActionStartTranscriptionParams {
   transcription_tracks?: string;
 }
 
+export namespace ActionStartTranscriptionParams {
+  export interface TranscriptionEngineGoogleConfig {
+    /**
+     * Enables speaker diarization.
+     */
+    enable_speaker_diarization?: boolean;
+
+    /**
+     * Hints to improve transcription accuracy.
+     */
+    hints?: Array<string>;
+
+    /**
+     * Whether to send also interim results. If set to false, only final results will
+     * be sent.
+     */
+    interim_results?: boolean;
+
+    /**
+     * Language to use for speech recognition
+     */
+    language?: ActionsAPI.GoogleTranscriptionLanguage;
+
+    /**
+     * Defines maximum number of speakers in the conversation.
+     */
+    max_speaker_count?: number;
+
+    /**
+     * Defines minimum number of speakers in the conversation.
+     */
+    min_speaker_count?: number;
+
+    /**
+     * The model to use for transcription.
+     */
+    model?:
+      | 'latest_long'
+      | 'latest_short'
+      | 'command_and_search'
+      | 'phone_call'
+      | 'video'
+      | 'default'
+      | 'medical_conversation'
+      | 'medical_dictation';
+
+    /**
+     * Enables profanity_filter.
+     */
+    profanity_filter?: boolean;
+
+    /**
+     * Speech context to improve transcription accuracy.
+     */
+    speech_context?: Array<TranscriptionEngineGoogleConfig.SpeechContext>;
+
+    /**
+     * Engine identifier for Google transcription service
+     */
+    transcription_engine?: 'Google';
+
+    /**
+     * Enables enhanced transcription, this works for models `phone_call` and `video`.
+     */
+    use_enhanced?: boolean;
+  }
+
+  export namespace TranscriptionEngineGoogleConfig {
+    export interface SpeechContext {
+      /**
+       * Boost factor for the speech context.
+       */
+      boost?: number;
+
+      phrases?: Array<string>;
+    }
+  }
+
+  export interface TranscriptionEngineTelnyxConfig {
+    /**
+     * Language to use for speech recognition
+     */
+    language?:
+      | 'en'
+      | 'zh'
+      | 'de'
+      | 'es'
+      | 'ru'
+      | 'ko'
+      | 'fr'
+      | 'ja'
+      | 'pt'
+      | 'tr'
+      | 'pl'
+      | 'ca'
+      | 'nl'
+      | 'ar'
+      | 'sv'
+      | 'it'
+      | 'id'
+      | 'hi'
+      | 'fi'
+      | 'vi'
+      | 'he'
+      | 'uk'
+      | 'el'
+      | 'ms'
+      | 'cs'
+      | 'ro'
+      | 'da'
+      | 'hu'
+      | 'ta'
+      | 'no'
+      | 'th'
+      | 'ur'
+      | 'hr'
+      | 'bg'
+      | 'lt'
+      | 'la'
+      | 'mi'
+      | 'ml'
+      | 'cy'
+      | 'sk'
+      | 'te'
+      | 'fa'
+      | 'lv'
+      | 'bn'
+      | 'sr'
+      | 'az'
+      | 'sl'
+      | 'kn'
+      | 'et'
+      | 'mk'
+      | 'br'
+      | 'eu'
+      | 'is'
+      | 'hy'
+      | 'ne'
+      | 'mn'
+      | 'bs'
+      | 'kk'
+      | 'sq'
+      | 'sw'
+      | 'gl'
+      | 'mr'
+      | 'pa'
+      | 'si'
+      | 'km'
+      | 'sn'
+      | 'yo'
+      | 'so'
+      | 'af'
+      | 'oc'
+      | 'ka'
+      | 'be'
+      | 'tg'
+      | 'sd'
+      | 'gu'
+      | 'am'
+      | 'yi'
+      | 'lo'
+      | 'uz'
+      | 'fo'
+      | 'ht'
+      | 'ps'
+      | 'tk'
+      | 'nn'
+      | 'mt'
+      | 'sa'
+      | 'lb'
+      | 'my'
+      | 'bo'
+      | 'tl'
+      | 'mg'
+      | 'as'
+      | 'tt'
+      | 'haw'
+      | 'ln'
+      | 'ha'
+      | 'ba'
+      | 'jw'
+      | 'su'
+      | 'auto_detect';
+
+    /**
+     * Engine identifier for Telnyx transcription service
+     */
+    transcription_engine?: 'Telnyx';
+
+    /**
+     * The model to use for transcription.
+     */
+    transcription_model?: 'openai/whisper-tiny' | 'openai/whisper-large-v3-turbo';
+  }
+
+  export interface TranscriptionEngineDeepgramConfig {
+    /**
+     * Engine identifier for Deepgram transcription service
+     */
+    transcription_engine: 'Deepgram';
+
+    /**
+     * The model to use for transcription.
+     */
+    transcription_model: 'deepgram/nova-2' | 'deepgram/nova-3';
+
+    /**
+     * Language to use for speech recognition. Available languages depend on the
+     * selected model.
+     */
+    language?:
+      | 'bg'
+      | 'ca'
+      | 'zh'
+      | 'zh-CN'
+      | 'zh-Hans'
+      | 'zh-TW'
+      | 'zh-Hant'
+      | 'zh-HK'
+      | 'cs'
+      | 'da'
+      | 'da-DK'
+      | 'nl'
+      | 'en'
+      | 'en-US'
+      | 'en-AU'
+      | 'en-GB'
+      | 'en-NZ'
+      | 'en-IN'
+      | 'et'
+      | 'fi'
+      | 'nl-BE'
+      | 'fr'
+      | 'fr-CA'
+      | 'de'
+      | 'de-CH'
+      | 'el'
+      | 'hi'
+      | 'hu'
+      | 'id'
+      | 'it'
+      | 'ja'
+      | 'ko'
+      | 'ko-KR'
+      | 'lv'
+      | 'lt'
+      | 'ms'
+      | 'no'
+      | 'pl'
+      | 'pt'
+      | 'pt-BR'
+      | 'pt-PT'
+      | 'ro'
+      | 'ru'
+      | 'sk'
+      | 'es'
+      | 'es-419'
+      | 'sv'
+      | 'sv-SE'
+      | 'th'
+      | 'th-TH'
+      | 'tr'
+      | 'uk'
+      | 'vi'
+      | 'auto_detect';
+  }
+}
+
 export interface ActionStopAIAssistantParams {
   /**
    * Use this field to add state to every subsequent webhook. It must be a valid

package/src/resources/index.ts

@@ -719,6 +719,7 @@ export {
 } from './oauth';
 export {
   OAuthClients,
+  type OAuthClient,
   type OAuthClientCreateResponse,
   type OAuthClientRetrieveResponse,
   type OAuthClientUpdateResponse,
@@ -729,6 +730,7 @@ export {
 } from './oauth-clients';
 export {
   OAuthGrants,
+  type OAuthGrant,
   type OAuthGrantRetrieveResponse,
   type OAuthGrantListResponse,
   type OAuthGrantDeleteResponse,
@@ -1137,6 +1139,7 @@ export {
   VerifyProfiles,
   type VerifyProfile,
   type VerifyProfileData,
+  type VerifyProfileMessageTemplateResponse,
   type VerifyProfileListResponse,
   type VerifyProfileCreateTemplateResponse,
   type VerifyProfileRetrieveTemplatesResponse,

package/src/resources/legacy/reporting/batch-detail-records/batch-detail-records.ts

@@ -3,6 +3,7 @@
 import { APIResource } from '../../../../core/resource';
 import * as MessagingAPI from './messaging';
 import {
+  MdrDetailReportResponse,
   Messaging,
   MessagingCreateParams,
   MessagingCreateResponse,
@@ -18,9 +19,11 @@ import {
   SpeechToTextDeleteResponse,
   SpeechToTextListResponse,
   SpeechToTextRetrieveResponse,
+  SttDetailReportResponse,
 } from './speech-to-text';
 import * as VoiceAPI from './voice';
 import {
+  CdrDetailedReqResponse,
   Voice,
   VoiceCreateParams,
   VoiceCreateResponse,
@@ -36,13 +39,57 @@ export class BatchDetailRecords extends APIResource {
   voice: VoiceAPI.Voice = new VoiceAPI.Voice(this._client);
 }
 
+/**
+ * Query filter criteria. Note: The first filter object must specify filter_type as
+ * 'and'. You cannot follow an 'or' with another 'and'.
+ */
+export interface Filter {
+  /**
+   * Billing group UUID to filter by
+   */
+  billing_group?: string;
+
+  /**
+   * Called line identification (destination number)
+   */
+  cld?: string;
+
+  /**
+   * Filter type for CLD matching
+   */
+  cld_filter?: 'contains' | 'starts_with' | 'ends_with';
+
+  /**
+   * Calling line identification (caller ID)
+   */
+  cli?: string;
+
+  /**
+   * Filter type for CLI matching
+   */
+  cli_filter?: 'contains' | 'starts_with' | 'ends_with';
+
+  /**
+   * Logical operator for combining filters
+   */
+  filter_type?: 'and' | 'or';
+
+  /**
+   * Tag name to filter by
+   */
+  tags_list?: string;
+}
+
 BatchDetailRecords.Messaging = Messaging;
 BatchDetailRecords.SpeechToText = SpeechToText;
 BatchDetailRecords.Voice = Voice;
 
 export declare namespace BatchDetailRecords {
+  export { type Filter as Filter };
+
   export {
     Messaging as Messaging,
+    type MdrDetailReportResponse as MdrDetailReportResponse,
     type MessagingCreateResponse as MessagingCreateResponse,
     type MessagingRetrieveResponse as MessagingRetrieveResponse,
     type MessagingListResponse as MessagingListResponse,
@@ -52,6 +99,7 @@ export declare namespace BatchDetailRecords {
 
   export {
     SpeechToText as SpeechToText,
+    type SttDetailReportResponse as SttDetailReportResponse,
     type SpeechToTextCreateResponse as SpeechToTextCreateResponse,
     type SpeechToTextRetrieveResponse as SpeechToTextRetrieveResponse,
     type SpeechToTextListResponse as SpeechToTextListResponse,
@@ -61,6 +109,7 @@ export declare namespace BatchDetailRecords {
 
   export {
     Voice as Voice,
+    type CdrDetailedReqResponse as CdrDetailedReqResponse,
     type VoiceCreateResponse as VoiceCreateResponse,
     type VoiceRetrieveResponse as VoiceRetrieveResponse,
     type VoiceListResponse as VoiceListResponse,