telnyx 5.156.0 → 5.158.0

data/lib/telnyx/models/ai/tool_create_params.rb

@@ -38,6 +38,11 @@ module Telnyx
         #   @return [Hash{Symbol=>Object}, nil]
         optional :invite, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
 
+        # @!attribute pay
+        #
+        #   @return [Telnyx::Models::AI::PayToolParams, nil]
+        optional :pay, -> { Telnyx::AI::PayToolParams }
+
         # @!attribute retrieval
         #
         #   @return [Hash{Symbol=>Object}, nil]
@@ -53,13 +58,14 @@ module Telnyx
         #   @return [Hash{Symbol=>Object}, nil]
         optional :webhook, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
 
-        # @!method initialize(display_name:, type:, client_side_tool: nil, function: nil, handoff: nil, invite: nil, retrieval: nil, timeout_ms: nil, webhook: nil, request_options: {})
+        # @!method initialize(display_name:, type:, client_side_tool: nil, function: nil, handoff: nil, invite: nil, pay: nil, retrieval: nil, timeout_ms: nil, webhook: nil, request_options: {})
         #   @param display_name [String]
         #   @param type [String]
         #   @param client_side_tool [Hash{Symbol=>Object}]
         #   @param function [Hash{Symbol=>Object}]
         #   @param handoff [Hash{Symbol=>Object}]
         #   @param invite [Hash{Symbol=>Object}]
+        #   @param pay [Telnyx::Models::AI::PayToolParams]
         #   @param retrieval [Hash{Symbol=>Object}]
         #   @param timeout_ms [Integer]
         #   @param webhook [Hash{Symbol=>Object}]

data/lib/telnyx/models/ai/tool_update_params.rb

@@ -38,6 +38,11 @@ module Telnyx
         #   @return [Hash{Symbol=>Object}, nil]
         optional :invite, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
 
+        # @!attribute pay
+        #
+        #   @return [Telnyx::Models::AI::PayToolParams, nil]
+        optional :pay, -> { Telnyx::AI::PayToolParams }
+
         # @!attribute retrieval
         #
         #   @return [Hash{Symbol=>Object}, nil]
@@ -58,13 +63,14 @@ module Telnyx
         #   @return [Hash{Symbol=>Object}, nil]
         optional :webhook, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
 
-        # @!method initialize(tool_id:, client_side_tool: nil, display_name: nil, function: nil, handoff: nil, invite: nil, retrieval: nil, timeout_ms: nil, type: nil, webhook: nil, request_options: {})
+        # @!method initialize(tool_id:, client_side_tool: nil, display_name: nil, function: nil, handoff: nil, invite: nil, pay: nil, retrieval: nil, timeout_ms: nil, type: nil, webhook: nil, request_options: {})
         #   @param tool_id [String]
         #   @param client_side_tool [Hash{Symbol=>Object}]
         #   @param display_name [String]
         #   @param function [Hash{Symbol=>Object}]
         #   @param handoff [Hash{Symbol=>Object}]
         #   @param invite [Hash{Symbol=>Object}]
+        #   @param pay [Telnyx::Models::AI::PayToolParams]
         #   @param retrieval [Hash{Symbol=>Object}]
         #   @param timeout_ms [Integer]
         #   @param type [String]

data/lib/telnyx/models/ai/transcription_settings.rb

@@ -36,7 +36,7 @@ module Telnyx
         #   - `xai/grok-stt` is a multilingual Grok STT model.
         #   - `soniox/stt-rt-v4` is a multilingual streaming model with automatic language
         #     detection and configurable endpointing.
-        #   - `parakeet/tdt-0.6b-v3` is a multilingual transcription model with automatic
+        #   - `nvidia/parakeet-v3` is a multilingual transcription model with automatic
         #     language detection.
         #
         #   @return [Symbol, Telnyx::Models::AI::TranscriptionSettings::Model, nil]
@@ -80,7 +80,7 @@ module Telnyx
         # - `xai/grok-stt` is a multilingual Grok STT model.
         # - `soniox/stt-rt-v4` is a multilingual streaming model with automatic language
         #   detection and configurable endpointing.
-        # - `parakeet/tdt-0.6b-v3` is a multilingual transcription model with automatic
+        # - `nvidia/parakeet-v3` is a multilingual transcription model with automatic
         #   language detection.
         #
         # @see Telnyx::Models::AI::TranscriptionSettings#model
@@ -94,7 +94,7 @@ module Telnyx
           ASSEMBLYAI_UNIVERSAL_STREAMING = :"assemblyai/universal-streaming"
           XAI_GROK_STT = :"xai/grok-stt"
           SONIOX_STT_RT_V4 = :"soniox/stt-rt-v4"
-          PARAKEET_TDT_0_6B_V3 = :"parakeet/tdt-0.6b-v3"
+          NVIDIA_PARAKEET_V3 = :"nvidia/parakeet-v3"
           DISTIL_WHISPER_DISTIL_LARGE_V2 = :"distil-whisper/distil-large-v2"
           OPENAI_WHISPER_LARGE_V3_TURBO = :"openai/whisper-large-v3-turbo"
 

data/lib/telnyx/models/call_answered.rb

@@ -104,8 +104,8 @@ module Telnyx
         # @!attribute sip_headers
         #   User-to-User and Diversion headers from sip invite.
         #
-        #   @return [Array<Telnyx::Models::SipHeader>, nil]
-        optional :sip_headers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::SipHeader] }
+        #   @return [Array<Telnyx::Models::CallAnswered::Payload::SipHeader>, nil]
+        optional :sip_headers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::CallAnswered::Payload::SipHeader] }
 
         # @!attribute start_time
         #   ISO 8601 datetime of when the call started.
@@ -149,7 +149,7 @@ module Telnyx
         #
         #   @param from [String] Number or SIP URI placing the call.
         #
-        #   @param sip_headers [Array<Telnyx::Models::SipHeader>] User-to-User and Diversion headers from sip invite.
+        #   @param sip_headers [Array<Telnyx::Models::CallAnswered::Payload::SipHeader>] User-to-User and Diversion headers from sip invite.
         #
         #   @param start_time [Time] ISO 8601 datetime of when the call started.
         #
@@ -159,6 +159,38 @@ module Telnyx
         #
         #   @param to [String] Destination number or SIP URI of the call.
 
+        class SipHeader < Telnyx::Internal::Type::BaseModel
+          # @!attribute name
+          #   The name of the header received from the SIP INVITE.
+          #
+          #   @return [Symbol, Telnyx::Models::CallAnswered::Payload::SipHeader::Name]
+          required :name, enum: -> { Telnyx::CallAnswered::Payload::SipHeader::Name }
+
+          # @!attribute value
+          #   The value of the header.
+          #
+          #   @return [String]
+          required :value, String
+
+          # @!method initialize(name:, value:)
+          #   @param name [Symbol, Telnyx::Models::CallAnswered::Payload::SipHeader::Name] The name of the header received from the SIP INVITE.
+          #
+          #   @param value [String] The value of the header.
+
+          # The name of the header received from the SIP INVITE.
+          #
+          # @see Telnyx::Models::CallAnswered::Payload::SipHeader#name
+          module Name
+            extend Telnyx::Internal::Type::Enum
+
+            USER_TO_USER = :"User-to-User"
+            DIVERSION = :Diversion
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
         # State received from a command.
         #
         # @see Telnyx::Models::CallAnswered::Payload#state

data/lib/telnyx/models/call_dial_params.rb

@@ -288,6 +288,16 @@ module Telnyx
       #   @return [Symbol, Telnyx::Models::CallDialParams::RecordTrim, nil]
       optional :record_trim, enum: -> { Telnyx::CallDialParams::RecordTrim }
 
+      # @!attribute retry_on_timeout
+      #   Whether to keep trying the remaining routing paths (e.g. alternate
+      #   providers/gateways) for the same destination after `timeout_secs` is reached for
+      #   the current attempt. When set to `false`, reaching `timeout_secs` aborts the
+      #   entire dial attempt and the `call.hangup` webhook reports a `hangup_cause` of
+      #   `no_answer` instead of `timeout`.
+      #
+      #   @return [Boolean, nil]
+      optional :retry_on_timeout, Telnyx::Internal::Type::Boolean
+
       # @!attribute send_digits_on_answer
       #   DTMF digits to send automatically after the called party answers. Useful for
       #   reaching an extension behind an IVR (e.g. `"200"` to dial extension 200 once the
@@ -486,7 +496,7 @@ module Telnyx
       #   @return [Symbol, Telnyx::Models::CallDialParams::WebhookURLsMethod, nil]
       optional :webhook_urls_method, enum: -> { Telnyx::CallDialParams::WebhookURLsMethod }
 
-      # @!method initialize(connection_id:, from:, to:, answering_machine_detection: nil, answering_machine_detection_config: nil, assistant: nil, audio_url: nil, billing_group_id: nil, bridge_intent: nil, bridge_on_answer: nil, client_state: nil, command_id: nil, conference_config: nil, conversation_relay_config: nil, custom_headers: nil, deepfake_detection: nil, dialogflow_config: nil, enable_dialogflow: nil, from_display_name: nil, link_to: nil, media_encryption: nil, media_name: nil, park_after_unbridge: nil, preferred_codecs: nil, prevent_double_bridge: nil, privacy: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, send_digits_on_answer: nil, send_silence_when_idle: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, sip_region: nil, sip_transport_protocol: nil, sound_modifications: nil, stream_auth_token: nil, stream_bidirectional_codec: nil, stream_bidirectional_mode: nil, stream_bidirectional_sampling_rate: nil, stream_bidirectional_target_legs: nil, stream_codec: nil, stream_establish_before_call_originate: nil, stream_track: nil, stream_url: nil, supervise_call_control_id: nil, supervisor_role: nil, time_limit_secs: nil, timeout_secs: nil, transcription: nil, transcription_config: nil, webhook_retries_policies: nil, webhook_url: nil, webhook_url_method: nil, webhook_urls: nil, webhook_urls_method: nil, request_options: {})
+      # @!method initialize(connection_id:, from:, to:, answering_machine_detection: nil, answering_machine_detection_config: nil, assistant: nil, audio_url: nil, billing_group_id: nil, bridge_intent: nil, bridge_on_answer: nil, client_state: nil, command_id: nil, conference_config: nil, conversation_relay_config: nil, custom_headers: nil, deepfake_detection: nil, dialogflow_config: nil, enable_dialogflow: nil, from_display_name: nil, link_to: nil, media_encryption: nil, media_name: nil, park_after_unbridge: nil, preferred_codecs: nil, prevent_double_bridge: nil, privacy: nil, record: nil, record_channels: nil, record_custom_file_name: nil, record_format: nil, record_max_length: nil, record_timeout_secs: nil, record_track: nil, record_trim: nil, retry_on_timeout: nil, send_digits_on_answer: nil, send_silence_when_idle: nil, sip_auth_password: nil, sip_auth_username: nil, sip_headers: nil, sip_region: nil, sip_transport_protocol: nil, sound_modifications: nil, stream_auth_token: nil, stream_bidirectional_codec: nil, stream_bidirectional_mode: nil, stream_bidirectional_sampling_rate: nil, stream_bidirectional_target_legs: nil, stream_codec: nil, stream_establish_before_call_originate: nil, stream_track: nil, stream_url: nil, supervise_call_control_id: nil, supervisor_role: nil, time_limit_secs: nil, timeout_secs: nil, transcription: nil, transcription_config: nil, webhook_retries_policies: nil, webhook_url: nil, webhook_url_method: nil, webhook_urls: nil, webhook_urls_method: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::CallDialParams} for more details.
       #
@@ -558,6 +568,8 @@ module Telnyx
       #
       #   @param record_trim [Symbol, Telnyx::Models::CallDialParams::RecordTrim] When set to `trim-silence`, silence will be removed from the beginning and end o
       #
+      #   @param retry_on_timeout [Boolean] Whether to keep trying the remaining routing paths (e.g. alternate providers/gat
+      #
       #   @param send_digits_on_answer [String] DTMF digits to send automatically after the called party answers. Useful for rea
       #
       #   @param send_silence_when_idle [Boolean] Generate silence RTP packets when no transmission available.

data/lib/telnyx/models/call_hangup.rb

@@ -133,8 +133,8 @@ module Telnyx
         # @!attribute sip_headers
         #   User-to-User and Diversion headers from sip invite.
         #
-        #   @return [Array<Telnyx::Models::SipHeader>, nil]
-        optional :sip_headers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::SipHeader] }
+        #   @return [Array<Telnyx::Models::CallHangup::Payload::SipHeader>, nil]
+        optional :sip_headers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::CallHangup::Payload::SipHeader] }
 
         # @!attribute start_time
         #   ISO 8601 datetime of when the call started.
@@ -186,7 +186,7 @@ module Telnyx
         #
         #   @param sip_hangup_cause [String] The reason the call was ended (SIP response code). If the SIP response is unavai
         #
-        #   @param sip_headers [Array<Telnyx::Models::SipHeader>] User-to-User and Diversion headers from sip invite.
+        #   @param sip_headers [Array<Telnyx::Models::CallHangup::Payload::SipHeader>] User-to-User and Diversion headers from sip invite.
         #
         #   @param start_time [Time] ISO 8601 datetime of when the call started.
         #
@@ -324,6 +324,38 @@ module Telnyx
           #   @return [Array<Symbol>]
         end
 
+        class SipHeader < Telnyx::Internal::Type::BaseModel
+          # @!attribute name
+          #   The name of the header received from the SIP INVITE.
+          #
+          #   @return [Symbol, Telnyx::Models::CallHangup::Payload::SipHeader::Name]
+          required :name, enum: -> { Telnyx::CallHangup::Payload::SipHeader::Name }
+
+          # @!attribute value
+          #   The value of the header.
+          #
+          #   @return [String]
+          required :value, String
+
+          # @!method initialize(name:, value:)
+          #   @param name [Symbol, Telnyx::Models::CallHangup::Payload::SipHeader::Name] The name of the header received from the SIP INVITE.
+          #
+          #   @param value [String] The value of the header.
+
+          # The name of the header received from the SIP INVITE.
+          #
+          # @see Telnyx::Models::CallHangup::Payload::SipHeader#name
+          module Name
+            extend Telnyx::Internal::Type::Enum
+
+            USER_TO_USER = :"User-to-User"
+            DIVERSION = :Diversion
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
         # State received from a command.
         #
         # @see Telnyx::Models::CallHangup::Payload#state

data/lib/telnyx/models/call_initiated.rb

@@ -146,8 +146,8 @@ module Telnyx
         # @!attribute sip_headers
         #   User-to-User and Diversion headers from sip invite.
         #
-        #   @return [Array<Telnyx::Models::SipHeader>, nil]
-        optional :sip_headers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::SipHeader] }
+        #   @return [Array<Telnyx::Models::CallInitiated::Payload::SipHeader>, nil]
+        optional :sip_headers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::CallInitiated::Payload::SipHeader] }
 
         # @!attribute start_time
         #   ISO 8601 datetime of when the call started.
@@ -205,7 +205,7 @@ module Telnyx
         #
         #   @param shaken_stir_validated [Boolean] Whether attestation was successfully validated or not.
         #
-        #   @param sip_headers [Array<Telnyx::Models::SipHeader>] User-to-User and Diversion headers from sip invite.
+        #   @param sip_headers [Array<Telnyx::Models::CallInitiated::Payload::SipHeader>] User-to-User and Diversion headers from sip invite.
         #
         #   @param start_time [Time] ISO 8601 datetime of when the call started.
         #
@@ -228,6 +228,38 @@ module Telnyx
           #   @return [Array<Symbol>]
         end
 
+        class SipHeader < Telnyx::Internal::Type::BaseModel
+          # @!attribute name
+          #   The name of the header received from the SIP INVITE.
+          #
+          #   @return [Symbol, Telnyx::Models::CallInitiated::Payload::SipHeader::Name]
+          required :name, enum: -> { Telnyx::CallInitiated::Payload::SipHeader::Name }
+
+          # @!attribute value
+          #   The value of the header.
+          #
+          #   @return [String]
+          required :value, String
+
+          # @!method initialize(name:, value:)
+          #   @param name [Symbol, Telnyx::Models::CallInitiated::Payload::SipHeader::Name] The name of the header received from the SIP INVITE.
+          #
+          #   @param value [String] The value of the header.
+
+          # The name of the header received from the SIP INVITE.
+          #
+          # @see Telnyx::Models::CallInitiated::Payload::SipHeader#name
+          module Name
+            extend Telnyx::Internal::Type::Enum
+
+            USER_TO_USER = :"User-to-User"
+            DIVERSION = :Diversion
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
         # State received from a command.
         #
         # @see Telnyx::Models::CallInitiated::Payload#state

data/lib/telnyx/models/calls/transcription_config.rb

@@ -12,7 +12,11 @@ module Telnyx
         #   controls the language hint), `multi` (no language hint), and language-specific
         #   hints `en`, `es`, `fr`, `de`, `hi`, `ru`, `pt`, `ja`, `it`, and `nl`. For
         #   `soniox/stt-rt-v4`, `auto` omits the language hint and lets Soniox auto-detect;
-        #   ISO 639-1 codes (e.g. `en`, `es`) bias detection toward that language.
+        #   ISO 639-1 codes (e.g. `en`, `es`) bias detection toward that language. For
+        #   `assemblyai/universal-streaming`, `auto` (or unset) enables native multilingual
+        #   code-switching; ISO 639-1 codes (`en`, `es`, `de`, `fr`, `pt`, `it`, `tr`, `nl`,
+        #   `sv`, `no`, `da`, `fi`, `hi`, `vi`, `ar`, `he`, `ja`, `zh`) bias the session to
+        #   that language.
         #
         #   @return [String, nil]
         optional :language, String
@@ -29,7 +33,7 @@ module Telnyx
         #   - `xai/grok-stt` for live streaming transcription.
         #   - `soniox/stt-rt-v4` for live streaming multilingual transcription with
         #     automatic language detection.
-        #   - `parakeet/tdt-0.6b-v3` for multilingual transcription with automatic language
+        #   - `nvidia/parakeet-v3` for multilingual transcription with automatic language
         #     detection.
         #   - `azure/fast` and `azure/realtime`; Azure models require `region`, and
         #     unsupported regions require `api_key_ref`.
@@ -66,7 +70,7 @@ module Telnyx
         # - `xai/grok-stt` for live streaming transcription.
         # - `soniox/stt-rt-v4` for live streaming multilingual transcription with
         #   automatic language detection.
-        # - `parakeet/tdt-0.6b-v3` for multilingual transcription with automatic language
+        # - `nvidia/parakeet-v3` for multilingual transcription with automatic language
         #   detection.
         # - `azure/fast` and `azure/realtime`; Azure models require `region`, and
         #   unsupported regions require `api_key_ref`.
@@ -89,7 +93,7 @@ module Telnyx
           ASSEMBLYAI_UNIVERSAL_STREAMING = :"assemblyai/universal-streaming"
           XAI_GROK_STT = :"xai/grok-stt"
           SONIOX_STT_RT_V4 = :"soniox/stt-rt-v4"
-          PARAKEET_TDT_0_6B_V3 = :"parakeet/tdt-0.6b-v3"
+          NVIDIA_PARAKEET_V3 = :"nvidia/parakeet-v3"
           AZURE_FAST = :"azure/fast"
           AZURE_REALTIME = :"azure/realtime"
           GOOGLE_LATEST_LONG = :"google/latest_long"

data/lib/telnyx/models/calls/transcription_engine_parakeet_config.rb

@@ -53,7 +53,7 @@ module Telnyx
         module TranscriptionModel
           extend Telnyx::Internal::Type::Enum
 
-          PARAKEET_TDT_0_6B_V3 = :"parakeet/tdt-0.6b-v3"
+          NVIDIA_PARAKEET_V3 = :"nvidia/parakeet-v3"
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/telnyx/models/doc_reqs_requirement.rb

@@ -43,26 +43,45 @@ module Telnyx
         #   @return [String, nil]
         optional :created_at, String
 
+        # @!attribute effective_end_at
+        #   When this version was superseded. NULL means this is the active or pending
+        #   version.
+        #
+        #   @return [Time, nil]
+        optional :effective_end_at, Time, nil?: true
+
+        # @!attribute effective_start_at
+        #   When this version became (or will become) active.
+        #
+        #   @return [Time, nil]
+        optional :effective_start_at, Time, nil?: true
+
         # @!attribute record_type
         #   Identifies the type of the resource.
         #
         #   @return [String, nil]
         optional :record_type, String
 
-        # @!attribute requirements_types
+        # @!attribute requirement_types
         #   Lists the requirement types necessary to fulfill this requirement
         #
         #   @return [Array<Telnyx::Models::DocReqsRequirementType>, nil]
-        optional :requirements_types, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::DocReqsRequirementType] }
+        optional :requirement_types, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::DocReqsRequirementType] }
 
         # @!attribute updated_at
         #   ISO 8601 formatted date-time indicating when the resource was last updated.
         #
         #   @return [String, nil]
         optional :updated_at, String
+
+        # @!attribute version
+        #   Version number. Increments with each new version. Defaults to 1.
+        #
+        #   @return [Integer, nil]
+        optional :version, Integer
       end
 
-      # @!method initialize(id: nil, action: nil, country_code: nil, created_at: nil, locality: nil, phone_number_type: nil, record_type: nil, requirements_types: nil, updated_at: nil)
+      # @!method initialize(id: nil, action: nil, country_code: nil, created_at: nil, effective_end_at: nil, effective_start_at: nil, locality: nil, phone_number_type: nil, record_type: nil, requirement_types: nil, updated_at: nil, version: nil)
       #   Some parameter documentations has been truncated, see
       #   {Telnyx::Models::DocReqsRequirement} for more details.
       #
@@ -74,15 +93,21 @@ module Telnyx
       #
       #   @param created_at [String] ISO 8601 formatted date-time indicating when the resource was created.
       #
+      #   @param effective_end_at [Time, nil] When this version was superseded. NULL means this is the active or pending versi
+      #
+      #   @param effective_start_at [Time, nil] When this version became (or will become) active.
+      #
       #   @param locality [String] The locality where this requirement applies
       #
       #   @param phone_number_type [Symbol, Telnyx::Models::DocReqsRequirement::PhoneNumberType] Indicates the phone_number_type this requirement applies to. Leave blank if this
       #
       #   @param record_type [String] Identifies the type of the resource.
       #
-      #   @param requirements_types [Array<Telnyx::Models::DocReqsRequirementType>] Lists the requirement types necessary to fulfill this requirement
+      #   @param requirement_types [Array<Telnyx::Models::DocReqsRequirementType>] Lists the requirement types necessary to fulfill this requirement
       #
       #   @param updated_at [String] ISO 8601 formatted date-time indicating when the resource was last updated.
+      #
+      #   @param version [Integer] Version number. Increments with each new version. Defaults to 1.
 
       # Indicates whether this requirement applies to branded_calling, ordering,
       # porting, or both ordering and porting