telnyx 5.131.0 → 5.148.0

data/lib/telnyx/models/room_recording_retrieve_response.rb

@@ -6,170 +6,11 @@ module Telnyx
     class RoomRecordingRetrieveResponse < Telnyx::Internal::Type::BaseModel
       # @!attribute data
       #
-      #   @return [Telnyx::Models::RoomRecordingRetrieveResponse::Data, nil]
-      optional :data, -> { Telnyx::Models::RoomRecordingRetrieveResponse::Data }
+      #   @return [Telnyx::Models::RoomRecording, nil]
+      optional :data, -> { Telnyx::RoomRecording }
 
       # @!method initialize(data: nil)
-      #   @param data [Telnyx::Models::RoomRecordingRetrieveResponse::Data]
-
-      # @see Telnyx::Models::RoomRecordingRetrieveResponse#data
-      class Data < Telnyx::Internal::Type::BaseModel
-        # @!attribute id
-        #   A unique identifier for the room recording.
-        #
-        #   @return [String, nil]
-        optional :id, String
-
-        # @!attribute codec
-        #   Shows the codec used for the room recording.
-        #
-        #   @return [String, nil]
-        optional :codec, String
-
-        # @!attribute completed_at
-        #   ISO 8601 timestamp when the room recording has completed.
-        #
-        #   @return [Time, nil]
-        optional :completed_at, Time
-
-        # @!attribute created_at
-        #   ISO 8601 timestamp when the room recording was created.
-        #
-        #   @return [Time, nil]
-        optional :created_at, Time
-
-        # @!attribute download_url
-        #   Url to download the recording.
-        #
-        #   @return [String, nil]
-        optional :download_url, String
-
-        # @!attribute duration_secs
-        #   Shows the room recording duration in seconds.
-        #
-        #   @return [Integer, nil]
-        optional :duration_secs, Integer
-
-        # @!attribute ended_at
-        #   ISO 8601 timestamp when the room recording has ended.
-        #
-        #   @return [Time, nil]
-        optional :ended_at, Time
-
-        # @!attribute participant_id
-        #   Identify the room participant associated with the room recording.
-        #
-        #   @return [String, nil]
-        optional :participant_id, String
-
-        # @!attribute room_id
-        #   Identify the room associated with the room recording.
-        #
-        #   @return [String, nil]
-        optional :room_id, String
-
-        # @!attribute session_id
-        #   Identify the room session associated with the room recording.
-        #
-        #   @return [String, nil]
-        optional :session_id, String
-
-        # @!attribute size_mb
-        #   Shows the room recording size in MB.
-        #
-        #   @return [Float, nil]
-        optional :size_mb, Float
-
-        # @!attribute started_at
-        #   ISO 8601 timestamp when the room recording has stated.
-        #
-        #   @return [Time, nil]
-        optional :started_at, Time
-
-        # @!attribute status
-        #   Shows the room recording status.
-        #
-        #   @return [Symbol, Telnyx::Models::RoomRecordingRetrieveResponse::Data::Status, nil]
-        optional :status, enum: -> { Telnyx::Models::RoomRecordingRetrieveResponse::Data::Status }
-
-        # @!attribute type
-        #   Shows the room recording type.
-        #
-        #   @return [Symbol, Telnyx::Models::RoomRecordingRetrieveResponse::Data::Type, nil]
-        optional :type, enum: -> { Telnyx::Models::RoomRecordingRetrieveResponse::Data::Type }
-
-        # @!attribute updated_at
-        #   ISO 8601 timestamp when the room recording was updated.
-        #
-        #   @return [Time, nil]
-        optional :updated_at, Time
-
-        response_only do
-          # @!attribute record_type
-          #
-          #   @return [String, nil]
-          optional :record_type, String
-        end
-
-        # @!method initialize(id: nil, codec: nil, completed_at: nil, created_at: nil, download_url: nil, duration_secs: nil, ended_at: nil, participant_id: nil, record_type: nil, room_id: nil, session_id: nil, size_mb: nil, started_at: nil, status: nil, type: nil, updated_at: nil)
-        #   @param id [String] A unique identifier for the room recording.
-        #
-        #   @param codec [String] Shows the codec used for the room recording.
-        #
-        #   @param completed_at [Time] ISO 8601 timestamp when the room recording has completed.
-        #
-        #   @param created_at [Time] ISO 8601 timestamp when the room recording was created.
-        #
-        #   @param download_url [String] Url to download the recording.
-        #
-        #   @param duration_secs [Integer] Shows the room recording duration in seconds.
-        #
-        #   @param ended_at [Time] ISO 8601 timestamp when the room recording has ended.
-        #
-        #   @param participant_id [String] Identify the room participant associated with the room recording.
-        #
-        #   @param record_type [String]
-        #
-        #   @param room_id [String] Identify the room associated with the room recording.
-        #
-        #   @param session_id [String] Identify the room session associated with the room recording.
-        #
-        #   @param size_mb [Float] Shows the room recording size in MB.
-        #
-        #   @param started_at [Time] ISO 8601 timestamp when the room recording has stated.
-        #
-        #   @param status [Symbol, Telnyx::Models::RoomRecordingRetrieveResponse::Data::Status] Shows the room recording status.
-        #
-        #   @param type [Symbol, Telnyx::Models::RoomRecordingRetrieveResponse::Data::Type] Shows the room recording type.
-        #
-        #   @param updated_at [Time] ISO 8601 timestamp when the room recording was updated.
-
-        # Shows the room recording status.
-        #
-        # @see Telnyx::Models::RoomRecordingRetrieveResponse::Data#status
-        module Status
-          extend Telnyx::Internal::Type::Enum
-
-          COMPLETED = :completed
-          PROCESSING = :processing
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # Shows the room recording type.
-        #
-        # @see Telnyx::Models::RoomRecordingRetrieveResponse::Data#type
-        module Type
-          extend Telnyx::Internal::Type::Enum
-
-          AUDIO = :audio
-          VIDEO = :video
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
+      #   @param data [Telnyx::Models::RoomRecording]
     end
   end
 end

data/lib/telnyx/models/sip_registration_status_retrieve_params.rb

@@ -7,35 +7,46 @@ module Telnyx
       extend Telnyx::Internal::Type::RequestParameters::Converter
       include Telnyx::Internal::Type::RequestParameters
 
-      # @!attribute connection_id
-      #   Identifier of the UAC connection to look up.
-      #
-      #   @return [String]
-      required :connection_id, String
-
       # @!attribute credential_type
-      #   The kind of credential to look up. Only `uac_external_credential` is supported
-      #   today.
+      #   The kind of credential to look up. `uac_external_credential` is keyed by
+      #   `connection_id`; `telephony_credential` is keyed by `username`.
       #
       #   @return [Symbol, Telnyx::Models::SipRegistrationStatusRetrieveParams::CredentialType]
       required :credential_type, enum: -> { Telnyx::SipRegistrationStatusRetrieveParams::CredentialType }
 
-      # @!method initialize(connection_id:, credential_type:, request_options: {})
+      # @!attribute connection_id
+      #   Identifier of the UAC connection to look up. Required when `credential_type` is
+      #   `uac_external_credential`.
+      #
+      #   @return [String, nil]
+      optional :connection_id, String
+
+      # @!attribute username
+      #   SIP username of the telephony credential to look up. Required when
+      #   `credential_type` is `telephony_credential`.
+      #
+      #   @return [String, nil]
+      optional :username, String
+
+      # @!method initialize(credential_type:, connection_id: nil, username: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::SipRegistrationStatusRetrieveParams} for more details.
       #
-      #   @param connection_id [String] Identifier of the UAC connection to look up.
+      #   @param credential_type [Symbol, Telnyx::Models::SipRegistrationStatusRetrieveParams::CredentialType] The kind of credential to look up. `uac_external_credential` is keyed by `connec
+      #
+      #   @param connection_id [String] Identifier of the UAC connection to look up. Required when `credential_type` is
       #
-      #   @param credential_type [Symbol, Telnyx::Models::SipRegistrationStatusRetrieveParams::CredentialType] The kind of credential to look up. Only `uac_external_credential` is supported t
+      #   @param username [String] SIP username of the telephony credential to look up. Required when `credential_t
       #
       #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
 
-      # The kind of credential to look up. Only `uac_external_credential` is supported
-      # today.
+      # The kind of credential to look up. `uac_external_credential` is keyed by
+      # `connection_id`; `telephony_credential` is keyed by `username`.
       module CredentialType
         extend Telnyx::Internal::Type::Enum
 
         UAC_EXTERNAL_CREDENTIAL = :uac_external_credential
+        TELEPHONY_CREDENTIAL = :telephony_credential
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/telnyx/models/sip_registration_status_retrieve_response.rb

@@ -5,7 +5,7 @@ module Telnyx
     # @see Telnyx::Resources::SipRegistrationStatus#retrieve
     class SipRegistrationStatusRetrieveResponse < Telnyx::Internal::Type::BaseModel
       # @!attribute connection_id
-      #   Identifier of the UAC connection.
+      #   Identifier of the connection associated with the credential.
       #
       #   @return [String, nil]
       optional :connection_id, String
@@ -42,7 +42,8 @@ module Telnyx
       optional :registered, Telnyx::Internal::Type::Boolean
 
       # @!attribute sip_registration_details
-      #   Detailed registration information reported by the registrar.
+      #   Detailed registration information reported by the registrar. The populated
+      #   fields depend on `credential_type`.
       #
       #   @return [Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationDetails, nil]
       optional :sip_registration_details,
@@ -56,7 +57,10 @@ module Telnyx
                enum: -> { Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus }
 
       # @!method initialize(connection_id: nil, connection_name: nil, credential_type: nil, credential_username: nil, last_registration_response: nil, registered: nil, sip_registration_details: nil, sip_registration_status: nil)
-      #   @param connection_id [String] Identifier of the UAC connection.
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::SipRegistrationStatusRetrieveResponse} for more details.
+      #
+      #   @param connection_id [String] Identifier of the connection associated with the credential.
       #
       #   @param connection_name [String] Human-readable connection name.
       #
@@ -68,7 +72,7 @@ module Telnyx
       #
       #   @param registered [Boolean] True if the endpoint is currently registered.
       #
-      #   @param sip_registration_details [Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationDetails] Detailed registration information reported by the registrar.
+      #   @param sip_registration_details [Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationDetails] Detailed registration information reported by the registrar. The populated field
       #
       #   @param sip_registration_status [Symbol, Telnyx::Models::SipRegistrationStatusRetrieveResponse::SipRegistrationStatus] Human-readable registration status derived from the registrar state.
 
@@ -79,6 +83,7 @@ module Telnyx
         extend Telnyx::Internal::Type::Enum
 
         UAC_EXTERNAL_CREDENTIAL = :uac_external_credential
+        TELEPHONY_CREDENTIAL = :telephony_credential
 
         # @!method self.values
         #   @return [Array<Symbol>]
@@ -104,26 +109,57 @@ module Telnyx
         #   @return [Integer, nil]
         optional :failures, Integer
 
+        # @!attribute last_modified
+        #   Timestamp when the registration row was last modified (telephony_credential).
+        #
+        #   @return [String, nil]
+        optional :last_modified, String
+
         # @!attribute next_action_at
         #   Unix timestamp of the next scheduled registration action.
         #
         #   @return [Integer, nil]
         optional :next_action_at, Integer
 
+        # @!attribute node
+        #   Registrar node handling the registration (telephony_credential).
+        #
+        #   @return [String, nil]
+        optional :node, String
+
         # @!attribute sip_uri_user_host
         #   SIP URI user@host of the registered contact.
         #
         #   @return [String, nil]
         optional :sip_uri_user_host, String
 
+        # @!attribute transport
+        #   Transport used for the registration, e.g. UDP/TCP/TLS (telephony_credential).
+        #
+        #   @return [String, nil]
+        optional :transport, String
+
+        # @!attribute ua_ip
+        #   IP address of the registered user agent (telephony_credential).
+        #
+        #   @return [String, nil]
+        optional :ua_ip, String
+
+        # @!attribute ua_port
+        #   Port of the registered user agent (telephony_credential).
+        #
+        #   @return [Integer, nil]
+        optional :ua_port, Integer
+
         # @!attribute uptime
         #   Registration uptime reported by the registrar.
         #
         #   @return [Integer, nil]
         optional :uptime, Integer
 
-        # @!method initialize(auth_retries: nil, expires: nil, failures: nil, next_action_at: nil, sip_uri_user_host: nil, uptime: nil)
-        #   Detailed registration information reported by the registrar.
+        # @!method initialize(auth_retries: nil, expires: nil, failures: nil, last_modified: nil, next_action_at: nil, node: nil, sip_uri_user_host: nil, transport: nil, ua_ip: nil, ua_port: nil, uptime: nil)
+        #   Detailed registration information reported by the registrar. The populated
+        #   fields depend on `credential_type`.
         #
         #   @param auth_retries [Integer] Number of authentication retries on the last attempt.
         #
@@ -131,10 +167,20 @@ module Telnyx
         #
         #   @param failures [Integer] Count of consecutive registration failures.
         #
+        #   @param last_modified [String] Timestamp when the registration row was last modified (telephony_credential).
+        #
         #   @param next_action_at [Integer] Unix timestamp of the next scheduled registration action.
         #
+        #   @param node [String] Registrar node handling the registration (telephony_credential).
+        #
         #   @param sip_uri_user_host [String] SIP URI user@host of the registered contact.
         #
+        #   @param transport [String] Transport used for the registration, e.g. UDP/TCP/TLS (telephony_credential).
+        #
+        #   @param ua_ip [String] IP address of the registered user agent (telephony_credential).
+        #
+        #   @param ua_port [Integer] Port of the registered user agent (telephony_credential).
+        #
         #   @param uptime [Integer] Registration uptime reported by the registrar.
       end
 

data/lib/telnyx/models/siprec_connector_response.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::SiprecConnectors#create
+    class SiprecConnectorResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Telnyx::Models::SiprecConnectorResponse::Data]
+      required :data, -> { Telnyx::SiprecConnectorResponse::Data }
+
+      # @!method initialize(data:)
+      #   @param data [Telnyx::Models::SiprecConnectorResponse::Data]
+
+      # @see Telnyx::Models::SiprecConnectorResponse#data
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute app_subdomain
+        #   Subdomain to route calls when using Telnyx SRS (optional).
+        #
+        #   @return [String, nil]
+        optional :app_subdomain, String
+
+        # @!attribute created_at
+        #   ISO 8601 formatted date/time of creation.
+        #
+        #   @return [String, nil]
+        optional :created_at, String
+
+        # @!attribute host
+        #   Hostname/IPv4 address of the SIPREC SRS.
+        #
+        #   @return [String, nil]
+        optional :host, String
+
+        # @!attribute name
+        #   Name for the SIPREC connector resource.
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute port
+        #   Port for the SIPREC SRS.
+        #
+        #   @return [Integer, nil]
+        optional :port, Integer
+
+        # @!attribute record_type
+        #
+        #   @return [String, nil]
+        optional :record_type, String
+
+        # @!attribute updated_at
+        #   ISO 8601 formatted date/time of last update.
+        #
+        #   @return [String, nil]
+        optional :updated_at, String
+
+        # @!method initialize(app_subdomain: nil, created_at: nil, host: nil, name: nil, port: nil, record_type: nil, updated_at: nil)
+        #   @param app_subdomain [String] Subdomain to route calls when using Telnyx SRS (optional).
+        #
+        #   @param created_at [String] ISO 8601 formatted date/time of creation.
+        #
+        #   @param host [String] Hostname/IPv4 address of the SIPREC SRS.
+        #
+        #   @param name [String] Name for the SIPREC connector resource.
+        #
+        #   @param port [Integer] Port for the SIPREC SRS.
+        #
+        #   @param record_type [String]
+        #
+        #   @param updated_at [String] ISO 8601 formatted date/time of last update.
+      end
+    end
+  end
+end

data/lib/telnyx/models/speech_to_text_list_providers_params.rb

@@ -25,8 +25,8 @@ module Telnyx
       #   `file_based`, `in_call`, and `ai_assistant` respectively. The response always
       #   emits the canonical (post-rename) values.
       #
-      #   @return [Symbol, Telnyx::Models::SpeechToTextListProvidersParams::ServiceType, nil]
-      optional :service_type, enum: -> { Telnyx::SpeechToTextListProvidersParams::ServiceType }
+      #   @return [Symbol, Telnyx::Models::SttServiceType, nil]
+      optional :service_type, enum: -> { Telnyx::SttServiceType }
 
       # @!method initialize(provider: nil, service_type: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
@@ -34,7 +34,7 @@ module Telnyx
       #
       #   @param provider [Symbol, Telnyx::Models::SpeechToTextListProvidersParams::Provider] Filter to entries for a specific STT provider. The enum mirrors the providers ad
       #
-      #   @param service_type [Symbol, Telnyx::Models::SpeechToTextListProvidersParams::ServiceType] Filter to entries that support the given service type. For backward compatibilit
+      #   @param service_type [Symbol, Telnyx::Models::SttServiceType] Filter to entries that support the given service type. For backward compatibilit
       #
       #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
 
@@ -59,24 +59,6 @@ module Telnyx
         # @!method self.values
         #   @return [Array<Symbol>]
       end
-
-      # Filter to entries that support the given service type. For backward
-      # compatibility with the values that briefly shipped before the product-aligned
-      # rename, the legacy aliases `file_transcription`, `in_call_transcription`, and
-      # `ai_assistant_transcription` are silently accepted and normalized to
-      # `file_based`, `in_call`, and `ai_assistant` respectively. The response always
-      # emits the canonical (post-rename) values.
-      module ServiceType
-        extend Telnyx::Internal::Type::Enum
-
-        STREAMING = :streaming
-        FILE_BASED = :file_based
-        IN_CALL = :in_call
-        AI_ASSISTANT = :ai_assistant
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
     end
   end
 end

data/lib/telnyx/models/speech_to_text_list_providers_response.rb

@@ -70,8 +70,8 @@ module Telnyx
           #   live-streaming and non-streaming/batch models (matching the
           #   `TranscriptionConfig.model` enum on `call-control` voice assistants).
           #
-          #   @return [Symbol, Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType::Type]
-          required :type, enum: -> { Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType::Type }
+          #   @return [Symbol, Telnyx::Models::SttServiceType]
+          required :type, enum: -> { Telnyx::SttServiceType }
 
           # @!method initialize(languages:, type:)
           #   Some parameter documentations has been truncated, see
@@ -85,25 +85,7 @@ module Telnyx
           #
           #   @param languages [Array<String>] Languages accepted on this service surface, in the provider's native code format
           #
-          #   @param type [Symbol, Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType::Type] Service surface a model is available on. `ai_assistant` is the STT surface confi
-
-          # Service surface a model is available on. `ai_assistant` is the STT surface
-          # configured via Call Control voice-assistant transcription; it covers both
-          # live-streaming and non-streaming/batch models (matching the
-          # `TranscriptionConfig.model` enum on `call-control` voice assistants).
-          #
-          # @see Telnyx::Models::SpeechToTextListProvidersResponse::Data::ServiceType#type
-          module Type
-            extend Telnyx::Internal::Type::Enum
-
-            STREAMING = :streaming
-            FILE_BASED = :file_based
-            IN_CALL = :in_call
-            AI_ASSISTANT = :ai_assistant
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
+          #   @param type [Symbol, Telnyx::Models::SttServiceType] Service surface a model is available on. `ai_assistant` is the STT surface confi
         end
       end
 

data/lib/telnyx/models/speech_to_text_retrieve_transcription_params.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::SpeechToText#retrieve_transcription
+    class SpeechToTextRetrieveTranscriptionParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute input_format
+      #   The format of input audio stream.
+      #
+      #   @return [Symbol, Telnyx::Models::SpeechToTextRetrieveTranscriptionParams::InputFormat]
+      required :input_format, enum: -> { Telnyx::SpeechToTextRetrieveTranscriptionParams::InputFormat }
+
+      # @!attribute transcription_engine
+      #   The transcription engine to use for processing the audio stream.
+      #
+      #   @return [Symbol, Telnyx::Models::SpeechToTextRetrieveTranscriptionParams::TranscriptionEngine]
+      required :transcription_engine,
+               enum: -> { Telnyx::SpeechToTextRetrieveTranscriptionParams::TranscriptionEngine }
+
+      # @!attribute endpointing
+      #   Silence duration (in milliseconds) that triggers end-of-speech detection. When
+      #   set, the engine uses this value to determine when a speaker has stopped talking.
+      #   Supported by `xAI`, `Deepgram`, `Google`, `Speechmatics`, and `Soniox`. `Soniox`
+      #   accepts values between 500 and 3000. Other engines may not support this
+      #   parameter.
+      #
+      #   @return [Integer, nil]
+      optional :endpointing, Integer
+
+      # @!attribute interim_results
+      #   Whether to receive interim transcription results.
+      #
+      #   @return [Boolean, nil]
+      optional :interim_results, Telnyx::Internal::Type::Boolean
+
+      # @!attribute keyterm
+      #   A key term to boost in the transcription. The engine will be more likely to
+      #   recognize this term. Can be specified multiple times for multiple terms.
+      #
+      #   @return [String, nil]
+      optional :keyterm, String
+
+      # @!attribute keywords
+      #   Comma-separated list of keywords to boost in the transcription. The engine will
+      #   prioritize recognition of these words.
+      #
+      #   @return [String, nil]
+      optional :keywords, String
+
+      # @!attribute language
+      #   The language spoken in the audio stream.
+      #
+      #   @return [String, nil]
+      optional :language, String
+
+      # @!attribute model
+      #   The specific model to use within the selected transcription engine.
+      #
+      #   @return [Symbol, Telnyx::Models::SpeechToTextRetrieveTranscriptionParams::Model, nil]
+      optional :model, enum: -> { Telnyx::SpeechToTextRetrieveTranscriptionParams::Model }
+
+      # @!attribute redact
+      #   Enable redaction of sensitive information (e.g., PCI data, SSN) from
+      #   transcription results. Supported values depend on the transcription engine.
+      #
+      #   @return [String, nil]
+      optional :redact, String
+
+      # @!method initialize(input_format:, transcription_engine:, endpointing: nil, interim_results: nil, keyterm: nil, keywords: nil, language: nil, model: nil, redact: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::SpeechToTextRetrieveTranscriptionParams} for more details.
+      #
+      #   @param input_format [Symbol, Telnyx::Models::SpeechToTextRetrieveTranscriptionParams::InputFormat] The format of input audio stream.
+      #
+      #   @param transcription_engine [Symbol, Telnyx::Models::SpeechToTextRetrieveTranscriptionParams::TranscriptionEngine] The transcription engine to use for processing the audio stream.
+      #
+      #   @param endpointing [Integer] Silence duration (in milliseconds) that triggers end-of-speech detection. When s
+      #
+      #   @param interim_results [Boolean] Whether to receive interim transcription results.
+      #
+      #   @param keyterm [String] A key term to boost in the transcription. The engine will be more likely to reco
+      #
+      #   @param keywords [String] Comma-separated list of keywords to boost in the transcription. The engine will
+      #
+      #   @param language [String] The language spoken in the audio stream.
+      #
+      #   @param model [Symbol, Telnyx::Models::SpeechToTextRetrieveTranscriptionParams::Model] The specific model to use within the selected transcription engine.
+      #
+      #   @param redact [String] Enable redaction of sensitive information (e.g., PCI data, SSN) from transcripti
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+      # The format of input audio stream.
+      module InputFormat
+        extend Telnyx::Internal::Type::Enum
+
+        MP3 = :mp3
+        WAV = :wav
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The transcription engine to use for processing the audio stream.
+      module TranscriptionEngine
+        extend Telnyx::Internal::Type::Enum
+
+        AZURE = :Azure
+        DEEPGRAM = :Deepgram
+        GOOGLE = :Google
+        TELNYX = :Telnyx
+        X_AI = :xAI
+        SPEECHMATICS = :Speechmatics
+        SONIOX = :Soniox
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The specific model to use within the selected transcription engine.
+      module Model
+        extend Telnyx::Internal::Type::Enum
+
+        FAST = :fast
+        DEEPGRAM_NOVA_2 = :"deepgram/nova-2"
+        DEEPGRAM_NOVA_3 = :"deepgram/nova-3"
+        LATEST_LONG = :latest_long
+        LATEST_SHORT = :latest_short
+        COMMAND_AND_SEARCH = :command_and_search
+        PHONE_CALL = :phone_call
+        VIDEO = :video
+        DEFAULT = :default
+        MEDICAL_CONVERSATION = :medical_conversation
+        MEDICAL_DICTATION = :medical_dictation
+        OPENAI_WHISPER_TINY = :"openai/whisper-tiny"
+        OPENAI_WHISPER_LARGE_V3_TURBO = :"openai/whisper-large-v3-turbo"
+        XAI_GROK_STT = :"xai/grok-stt"
+        SPEECHMATICS_STANDARD = :"speechmatics/standard"
+        SONIOX_STT_RT_V4 = :"soniox/stt-rt-v4"
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/speech_to_text_transcribe_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::SpeechToText#transcribe
+    class SpeechToTextTranscribeParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end