telnyx 5.7.0 → 5.7.1

data/rbi/telnyx/models/texml/accounts/conference_retrieve_recordings_response.rbi

@@ -48,6 +48,13 @@ module Telnyx
           sig { params(page_size: Integer).void }
           attr_writer :page_size
 
+          # List of participant resources.
+          sig { returns(T.nilable(T::Array[T.anything])) }
+          attr_reader :participants
+
+          sig { params(participants: T::Array[T.anything]).void }
+          attr_writer :participants
+
           sig do
             returns(
               T.nilable(
@@ -90,6 +97,7 @@ module Telnyx
               next_page_uri: String,
               page: Integer,
               page_size: Integer,
+              participants: T::Array[T.anything],
               recordings:
                 T::Array[
                   Telnyx::Models::Texml::Accounts::ConferenceRetrieveRecordingsResponse::Recording::OrHash
@@ -109,6 +117,8 @@ module Telnyx
             page: nil,
             # The number of items on the page
             page_size: nil,
+            # List of participant resources.
+            participants: nil,
             recordings: nil,
             # The number of the first element on the page, zero-indexed.
             start: nil,
@@ -125,6 +135,7 @@ module Telnyx
                 next_page_uri: String,
                 page: Integer,
                 page_size: Integer,
+                participants: T::Array[T.anything],
                 recordings:
                   T::Array[
                     Telnyx::Models::Texml::Accounts::ConferenceRetrieveRecordingsResponse::Recording

data/rbi/telnyx/models/texml/accounts/conferences/participant_participants_response.rbi

@@ -42,6 +42,13 @@ module Telnyx
             sig { params(coaching_call_sid: String).void }
             attr_writer :coaching_call_sid
 
+            # The unique identifier for the conference.
+            sig { returns(T.nilable(String)) }
+            attr_reader :conference_sid
+
+            sig { params(conference_sid: String).void }
+            attr_writer :conference_sid
+
             # Whether the conference ends when the participant leaves.
             sig { returns(T.nilable(T::Boolean)) }
             attr_reader :end_conference_on_exit
@@ -94,6 +101,7 @@ module Telnyx
                 call_sid: String,
                 coaching: T::Boolean,
                 coaching_call_sid: String,
+                conference_sid: String,
                 end_conference_on_exit: T::Boolean,
                 hold: T::Boolean,
                 muted: T::Boolean,
@@ -111,6 +119,8 @@ module Telnyx
               coaching: nil,
               # The identifier of the coached participant's call.
               coaching_call_sid: nil,
+              # The unique identifier for the conference.
+              conference_sid: nil,
               # Whether the conference ends when the participant leaves.
               end_conference_on_exit: nil,
               # Whether the participant is on hold.
@@ -131,6 +141,7 @@ module Telnyx
                   call_sid: String,
                   coaching: T::Boolean,
                   coaching_call_sid: String,
+                  conference_sid: String,
                   end_conference_on_exit: T::Boolean,
                   hold: T::Boolean,
                   muted: T::Boolean,

data/rbi/telnyx/models/texml/accounts/conferences/participant_retrieve_participants_response.rbi

@@ -196,6 +196,13 @@ module Telnyx
               sig { params(coaching_call_sid_legacy: String).void }
               attr_writer :coaching_call_sid_legacy
 
+              # The unique identifier for the conference.
+              sig { returns(T.nilable(String)) }
+              attr_reader :conference_sid
+
+              sig { params(conference_sid: String).void }
+              attr_writer :conference_sid
+
               # The timestamp of when the resource was created.
               sig { returns(T.nilable(String)) }
               attr_reader :date_created
@@ -265,6 +272,7 @@ module Telnyx
                   coaching: T::Boolean,
                   coaching_call_sid: String,
                   coaching_call_sid_legacy: String,
+                  conference_sid: String,
                   date_created: String,
                   date_updated: String,
                   end_conference_on_exit: T::Boolean,
@@ -290,6 +298,8 @@ module Telnyx
                 coaching_call_sid: nil,
                 # The identifier of the coached participant's call.
                 coaching_call_sid_legacy: nil,
+                # The unique identifier for the conference.
+                conference_sid: nil,
                 # The timestamp of when the resource was created.
                 date_created: nil,
                 # The timestamp of when the resource was last updated.
@@ -317,6 +327,7 @@ module Telnyx
                     coaching: T::Boolean,
                     coaching_call_sid: String,
                     coaching_call_sid_legacy: String,
+                    conference_sid: String,
                     date_created: String,
                     date_updated: String,
                     end_conference_on_exit: T::Boolean,

data/rbi/telnyx/models/texml/accounts/conferences/participant_retrieve_response.rbi

@@ -63,6 +63,13 @@ module Telnyx
             sig { params(coaching_call_sid_legacy: String).void }
             attr_writer :coaching_call_sid_legacy
 
+            # The unique identifier for the conference.
+            sig { returns(T.nilable(String)) }
+            attr_reader :conference_sid
+
+            sig { params(conference_sid: String).void }
+            attr_writer :conference_sid
+
             # The timestamp of when the resource was created.
             sig { returns(T.nilable(String)) }
             attr_reader :date_created
@@ -132,6 +139,7 @@ module Telnyx
                 coaching: T::Boolean,
                 coaching_call_sid: String,
                 coaching_call_sid_legacy: String,
+                conference_sid: String,
                 date_created: String,
                 date_updated: String,
                 end_conference_on_exit: T::Boolean,
@@ -157,6 +165,8 @@ module Telnyx
               coaching_call_sid: nil,
               # The identifier of the coached participant's call.
               coaching_call_sid_legacy: nil,
+              # The unique identifier for the conference.
+              conference_sid: nil,
               # The timestamp of when the resource was created.
               date_created: nil,
               # The timestamp of when the resource was last updated.
@@ -184,6 +194,7 @@ module Telnyx
                   coaching: T::Boolean,
                   coaching_call_sid: String,
                   coaching_call_sid_legacy: String,
+                  conference_sid: String,
                   date_created: String,
                   date_updated: String,
                   end_conference_on_exit: T::Boolean,

data/rbi/telnyx/models/texml/accounts/conferences/participant_update_response.rbi

@@ -63,6 +63,13 @@ module Telnyx
             sig { params(coaching_call_sid_legacy: String).void }
             attr_writer :coaching_call_sid_legacy
 
+            # The unique identifier for the conference.
+            sig { returns(T.nilable(String)) }
+            attr_reader :conference_sid
+
+            sig { params(conference_sid: String).void }
+            attr_writer :conference_sid
+
             # The timestamp of when the resource was created.
             sig { returns(T.nilable(String)) }
             attr_reader :date_created
@@ -132,6 +139,7 @@ module Telnyx
                 coaching: T::Boolean,
                 coaching_call_sid: String,
                 coaching_call_sid_legacy: String,
+                conference_sid: String,
                 date_created: String,
                 date_updated: String,
                 end_conference_on_exit: T::Boolean,
@@ -157,6 +165,8 @@ module Telnyx
               coaching_call_sid: nil,
               # The identifier of the coached participant's call.
               coaching_call_sid_legacy: nil,
+              # The unique identifier for the conference.
+              conference_sid: nil,
               # The timestamp of when the resource was created.
               date_created: nil,
               # The timestamp of when the resource was last updated.
@@ -184,6 +194,7 @@ module Telnyx
                   coaching: T::Boolean,
                   coaching_call_sid: String,
                   coaching_call_sid_legacy: String,
+                  conference_sid: String,
                   date_created: String,
                   date_updated: String,
                   end_conference_on_exit: T::Boolean,

data/rbi/telnyx/resources/ai/audio.rbi

@@ -12,6 +12,8 @@ module Telnyx
             model: Telnyx::AI::AudioTranscribeParams::Model::OrSymbol,
             file: Telnyx::Internal::FileInput,
             file_url: String,
+            language: String,
+            model_config: T::Hash[Symbol, T.anything],
             response_format:
               Telnyx::AI::AudioTranscribeParams::ResponseFormat::OrSymbol,
             timestamp_granularities:
@@ -22,16 +24,29 @@ module Telnyx
         def transcribe(
           # ID of the model to use. `distil-whisper/distil-large-v2` is lower latency but
           # English-only. `openai/whisper-large-v3-turbo` is multi-lingual but slightly
-          # higher latency.
+          # higher latency. `deepgram/nova-3` supports English variants (en, en-US, en-GB,
+          # en-AU, en-NZ, en-IN) and only accepts mp3/wav files.
           model:,
           # The audio file object to transcribe, in one of these formats: flac, mp3, mp4,
           # mpeg, mpga, m4a, ogg, wav, or webm. File uploads are limited to 100 MB. Cannot
-          # be used together with `file_url`
+          # be used together with `file_url`. Note: `deepgram/nova-3` only supports mp3 and
+          # wav formats.
           file: nil,
           # Link to audio file in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a,
           # ogg, wav, or webm. Support for hosted files is limited to 100MB. Cannot be used
-          # together with `file`
+          # together with `file`. Note: `deepgram/nova-3` only supports mp3 and wav formats.
           file_url: nil,
+          # The language of the audio to be transcribed. For `deepgram/nova-3`, only English
+          # variants are supported: `en`, `en-US`, `en-GB`, `en-AU`, `en-NZ`, `en-IN`. For
+          # `openai/whisper-large-v3-turbo`, supports multiple languages.
+          # `distil-whisper/distil-large-v2` does not support language parameter.
+          language: nil,
+          # Additional model-specific configuration parameters. Only allowed with
+          # `deepgram/nova-3` model. Can include Deepgram-specific options such as
+          # `smart_format`, `punctuate`, `diarize`, `utterance`, `numerals`, and `language`.
+          # If `language` is provided both as a top-level parameter and in `model_config`,
+          # the top-level parameter takes precedence.
+          model_config: nil,
           # The format of the transcript output. Use `verbose_json` to take advantage of
           # timestamps.
           response_format: nil,

data/rbi/telnyx/resources/calls/actions.rbi

@@ -1283,7 +1283,8 @@ module Telnyx
               Telnyx::Calls::ActionStartRecordingParams::RecordingTrack::OrSymbol,
             timeout_secs: Integer,
             transcription: T::Boolean,
-            transcription_engine: String,
+            transcription_engine:
+              Telnyx::Calls::ActionStartRecordingParams::TranscriptionEngine::OrSymbol,
             transcription_language:
               Telnyx::Calls::ActionStartRecordingParams::TranscriptionLanguage::OrSymbol,
             transcription_max_speaker_count: Integer,
@@ -1328,9 +1329,10 @@ module Telnyx
           timeout_secs: nil,
           # Enable post recording transcription. The default value is false.
           transcription: nil,
-          # Engine to use for speech recognition. `A` - `Google`
+          # Engine to use for speech recognition. `A` - `Google`, `B` - `Telnyx`,
+          # `deepgram/nova-3` - `Deepgram Nova-3`. Note: `deepgram/nova-3` supports only
+          # `en` and `en-{Region}` languages.
           transcription_engine: nil,
-          # Language to use for speech recognition
           transcription_language: nil,
           # Defines maximum number of speakers in the conversation. Applies to `google`
           # engine only.

data/rbi/telnyx/resources/sim_cards.rbi

@@ -73,7 +73,7 @@ module Telnyx
       end
       def list(
         # Consolidated filter parameter for SIM cards (deepObject style). Originally:
-        # filter[tags], filter[iccid], filter[status]
+        # filter[iccid], filter[msisdn], filter[status], filter[tags]
         filter: nil,
         # A valid SIM card group ID.
         filter_sim_card_group_id: nil,

data/rbi/telnyx/resources/texml/calls.rbi

@@ -4,186 +4,6 @@ module Telnyx
   module Resources
     class Texml
       class Calls
-        # Update TeXML call. Please note that the keys present in the payload MUST BE
-        # formatted in CamelCase as specified in the example.
-        sig do
-          params(
-            call_sid: String,
-            fallback_method:
-              Telnyx::Texml::Accounts::UpdateCall::FallbackMethod::OrSymbol,
-            fallback_url: String,
-            method_: Telnyx::Texml::Accounts::UpdateCall::Method::OrSymbol,
-            status: String,
-            status_callback: String,
-            status_callback_method:
-              Telnyx::Texml::Accounts::UpdateCall::StatusCallbackMethod::OrSymbol,
-            texml: String,
-            url: String,
-            request_options: Telnyx::RequestOptions::OrHash
-          ).returns(Telnyx::Models::Texml::CallUpdateResponse)
-        end
-        def update(
-          # The CallSid that identifies the call to update.
-          call_sid,
-          # HTTP request type used for `FallbackUrl`.
-          fallback_method: nil,
-          # A failover URL for which Telnyx will retrieve the TeXML call instructions if the
-          # Url is not responding.
-          fallback_url: nil,
-          # HTTP request type used for `Url`.
-          method_: nil,
-          # The value to set the call status to. Setting the status to completed ends the
-          # call.
-          status: nil,
-          # URL destination for Telnyx to send status callback events to for the call.
-          status_callback: nil,
-          # HTTP request type used for `StatusCallback`.
-          status_callback_method: nil,
-          # TeXML to replace the current one with.
-          texml: nil,
-          # The URL where TeXML will make a request to retrieve a new set of TeXML
-          # instructions to continue the call flow.
-          url: nil,
-          request_options: {}
-        )
-        end
-
-        # Initiate an outbound TeXML call. Telnyx will request TeXML from the XML Request
-        # URL configured for the connection in the Mission Control Portal.
-        sig do
-          params(
-            application_id: String,
-            from: String,
-            to: String,
-            async_amd: T::Boolean,
-            async_amd_status_callback: String,
-            async_amd_status_callback_method:
-              Telnyx::Texml::CallInitiateParams::AsyncAmdStatusCallbackMethod::OrSymbol,
-            caller_id: String,
-            cancel_playback_on_detect_message_end: T::Boolean,
-            cancel_playback_on_machine_detection: T::Boolean,
-            detection_mode:
-              Telnyx::Texml::CallInitiateParams::DetectionMode::OrSymbol,
-            fallback_url: String,
-            machine_detection:
-              Telnyx::Texml::CallInitiateParams::MachineDetection::OrSymbol,
-            machine_detection_silence_timeout: Integer,
-            machine_detection_speech_end_threshold: Integer,
-            machine_detection_speech_threshold: Integer,
-            machine_detection_timeout: Integer,
-            preferred_codecs: String,
-            record: T::Boolean,
-            recording_channels:
-              Telnyx::Texml::CallInitiateParams::RecordingChannels::OrSymbol,
-            recording_status_callback: String,
-            recording_status_callback_event: String,
-            recording_status_callback_method:
-              Telnyx::Texml::CallInitiateParams::RecordingStatusCallbackMethod::OrSymbol,
-            recording_timeout: Integer,
-            recording_track:
-              Telnyx::Texml::CallInitiateParams::RecordingTrack::OrSymbol,
-            sip_auth_password: String,
-            sip_auth_username: String,
-            status_callback: String,
-            status_callback_event:
-              Telnyx::Texml::CallInitiateParams::StatusCallbackEvent::OrSymbol,
-            status_callback_method:
-              Telnyx::Texml::CallInitiateParams::StatusCallbackMethod::OrSymbol,
-            trim: Telnyx::Texml::CallInitiateParams::Trim::OrSymbol,
-            url: String,
-            url_method: Telnyx::Texml::CallInitiateParams::URLMethod::OrSymbol,
-            request_options: Telnyx::RequestOptions::OrHash
-          ).returns(Telnyx::Models::Texml::CallInitiateResponse)
-        end
-        def initiate(
-          # The ID of the TeXML application used for the call.
-          application_id,
-          # The phone number of the party that initiated the call. Phone numbers are
-          # formatted with a `+` and country code.
-          from:,
-          # The phone number of the called party. Phone numbers are formatted with a `+` and
-          # country code.
-          to:,
-          # Select whether to perform answering machine detection in the background. By
-          # default execution is blocked until Answering Machine Detection is completed.
-          async_amd: nil,
-          # URL destination for Telnyx to send AMD callback events to for the call.
-          async_amd_status_callback: nil,
-          # HTTP request type used for `AsyncAmdStatusCallback`. The default value is
-          # inherited from TeXML Application setting.
-          async_amd_status_callback_method: nil,
-          # To be used as the caller id name (SIP From Display Name) presented to the
-          # destination (`To` number). The string should have a maximum of 128 characters,
-          # containing only letters, numbers, spaces, and `-_~!.+` special characters. If
-          # ommited, the display name will be the same as the number in the `From` field.
-          caller_id: nil,
-          # Whether to cancel ongoing playback on `greeting ended` detection. Defaults to
-          # `true`.
-          cancel_playback_on_detect_message_end: nil,
-          # Whether to cancel ongoing playback on `machine` detection. Defaults to `true`.
-          cancel_playback_on_machine_detection: nil,
-          # Allows you to chose between Premium and Standard detections.
-          detection_mode: nil,
-          # A failover URL for which Telnyx will retrieve the TeXML call instructions if the
-          # `Url` is not responding.
-          fallback_url: nil,
-          # Enables Answering Machine Detection.
-          machine_detection: nil,
-          # If initial silence duration is greater than this value, consider it a machine.
-          # Ignored when `premium` detection is used.
-          machine_detection_silence_timeout: nil,
-          # Silence duration threshold after a greeting message or voice for it be
-          # considered human. Ignored when `premium` detection is used.
-          machine_detection_speech_end_threshold: nil,
-          # Maximum threshold of a human greeting. If greeting longer than this value,
-          # considered machine. Ignored when `premium` detection is used.
-          machine_detection_speech_threshold: nil,
-          # Maximum timeout threshold in milliseconds for overall detection.
-          machine_detection_timeout: nil,
-          # The list of comma-separated codecs to be offered on a call.
-          preferred_codecs: nil,
-          # Whether to record the entire participant's call leg. Defaults to `false`.
-          record: nil,
-          # The number of channels in the final recording. Defaults to `mono`.
-          recording_channels: nil,
-          # The URL the recording callbacks will be sent to.
-          recording_status_callback: nil,
-          # The changes to the recording's state that should generate a call to
-          # `RecoridngStatusCallback`. Can be: `in-progress`, `completed` and `absent`.
-          # Separate multiple values with a space. Defaults to `completed`.
-          recording_status_callback_event: nil,
-          # HTTP request type used for `RecordingStatusCallback`. Defaults to `POST`.
-          recording_status_callback_method: nil,
-          # The number of seconds that Telnyx will wait for the recording to be stopped if
-          # silence is detected. The timer only starts when the speech is detected. Please
-          # note that the transcription is used to detect silence and the related charge
-          # will be applied. The minimum value is 0. The default value is 0 (infinite)
-          recording_timeout: nil,
-          # The audio track to record for the call. The default is `both`.
-          recording_track: nil,
-          # The password to use for SIP authentication.
-          sip_auth_password: nil,
-          # The username to use for SIP authentication.
-          sip_auth_username: nil,
-          # URL destination for Telnyx to send status callback events to for the call.
-          status_callback: nil,
-          # The call events for which Telnyx should send a webhook. Multiple events can be
-          # defined when separated by a space.
-          status_callback_event: nil,
-          # HTTP request type used for `StatusCallback`.
-          status_callback_method: nil,
-          # Whether to trim any leading and trailing silence from the recording. Defaults to
-          # `trim-silence`.
-          trim: nil,
-          # The URL from which Telnyx will retrieve the TeXML call instructions.
-          url: nil,
-          # HTTP request type used for `Url`. The default value is inherited from TeXML
-          # Application setting.
-          url_method: nil,
-          request_options: {}
-        )
-        end
-
         # @api private
         sig { params(client: Telnyx::Client).returns(T.attached_class) }
         def self.new(client:)

data/sig/telnyx/models/ai/audio_transcribe_params.rbs

@@ -6,6 +6,8 @@ module Telnyx
           model: Telnyx::Models::AI::AudioTranscribeParams::model,
           file: Telnyx::Internal::file_input,
           file_url: String,
+          language: String,
+          model_config: ::Hash[Symbol, top],
           response_format: Telnyx::Models::AI::AudioTranscribeParams::response_format,
           timestamp_granularities: Telnyx::Models::AI::AudioTranscribeParams::timestamp_granularities
         }
@@ -27,6 +29,14 @@ module Telnyx
 
         def file_url=: (String) -> String
 
+        attr_reader language: String?
+
+        def language=: (String) -> String
+
+        attr_reader model_config: ::Hash[Symbol, top]?
+
+        def model_config=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
         attr_reader response_format: Telnyx::Models::AI::AudioTranscribeParams::response_format?
 
         def response_format=: (
@@ -43,6 +53,8 @@ module Telnyx
           model: Telnyx::Models::AI::AudioTranscribeParams::model,
           ?file: Telnyx::Internal::file_input,
           ?file_url: String,
+          ?language: String,
+          ?model_config: ::Hash[Symbol, top],
           ?response_format: Telnyx::Models::AI::AudioTranscribeParams::response_format,
           ?timestamp_granularities: Telnyx::Models::AI::AudioTranscribeParams::timestamp_granularities,
           ?request_options: Telnyx::request_opts
@@ -52,19 +64,24 @@ module Telnyx
           model: Telnyx::Models::AI::AudioTranscribeParams::model,
           file: Telnyx::Internal::file_input,
           file_url: String,
+          language: String,
+          model_config: ::Hash[Symbol, top],
           response_format: Telnyx::Models::AI::AudioTranscribeParams::response_format,
           timestamp_granularities: Telnyx::Models::AI::AudioTranscribeParams::timestamp_granularities,
           request_options: Telnyx::RequestOptions
         }
 
         type model =
-          :"distil-whisper/distil-large-v2" | :"openai/whisper-large-v3-turbo"
+          :"distil-whisper/distil-large-v2"
+          | :"openai/whisper-large-v3-turbo"
+          | :"deepgram/nova-3"
 
         module Model
           extend Telnyx::Internal::Type::Enum
 
           DISTIL_WHISPER_DISTIL_LARGE_V2: :"distil-whisper/distil-large-v2"
           OPENAI_WHISPER_LARGE_V3_TURBO: :"openai/whisper-large-v3-turbo"
+          DEEPGRAM_NOVA_3: :"deepgram/nova-3"
 
           def self?.values: -> ::Array[Telnyx::Models::AI::AudioTranscribeParams::model]
         end