telnyx 5.156.0 → 5.157.0

data/rbi/telnyx/models/ai/conversations/conversation_insight_retrieve_aggregates_response.rbi

@@ -0,0 +1,94 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Conversations
+        class ConversationInsightRetrieveAggregatesResponse < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::AI::Conversations::ConversationInsightRetrieveAggregatesResponse,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Aggregation result rows. Each row contains the grouped field values and a
+          # `record_count`.
+          sig do
+            returns(
+              T::Array[
+                Telnyx::Models::AI::Conversations::ConversationInsightRetrieveAggregatesResponse::Data
+              ]
+            )
+          end
+          attr_accessor :data
+
+          # Aggregated conversation insight counts grouped by the specified fields. Each
+          # item in `data` contains the grouped field values and a `record_count` indicating
+          # how many conversation insights match that combination.
+          sig do
+            params(
+              data:
+                T::Array[
+                  Telnyx::Models::AI::Conversations::ConversationInsightRetrieveAggregatesResponse::Data::OrHash
+                ]
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Aggregation result rows. Each row contains the grouped field values and a
+            # `record_count`.
+            data:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                data:
+                  T::Array[
+                    Telnyx::Models::AI::Conversations::ConversationInsightRetrieveAggregatesResponse::Data
+                  ]
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Data < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::AI::Conversations::ConversationInsightRetrieveAggregatesResponse::Data,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # Number of conversation insights that match this combination of grouped field
+            # values.
+            sig { returns(Integer) }
+            attr_accessor :record_count
+
+            # An aggregation row. Contains the grouped field values (keyed by the group_by
+            # field names) and a `record_count` integer. For example, when grouping by
+            # `score`, each row has a `score` value and a `record_count` of conversations with
+            # that score. When also splitting by `metadata.assistant_version_id`, each row
+            # includes both `score` and `metadata.assistant_version_id` plus their combined
+            # `record_count`.
+            sig { params(record_count: Integer).returns(T.attached_class) }
+            def self.new(
+              # Number of conversation insights that match this combination of grouped field
+              # values.
+              record_count:
+            )
+            end
+
+            sig { override.returns({ record_count: Integer }) }
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/inference_embedding.rbi

@@ -278,7 +278,8 @@ module Telnyx
                   Telnyx::AI::AssistantTool::Refer::OrHash,
                   Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                   Telnyx::AI::AssistantTool::SendMessage::OrHash,
-                  Telnyx::AI::AssistantTool::SkipTurn::OrHash
+                  Telnyx::AI::AssistantTool::SkipTurn::OrHash,
+                  Telnyx::AI::AssistantTool::Pay::OrHash
                 )
               ]
           ).void
@@ -373,7 +374,8 @@ module Telnyx
                   Telnyx::AI::AssistantTool::Refer::OrHash,
                   Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                   Telnyx::AI::AssistantTool::SendMessage::OrHash,
-                  Telnyx::AI::AssistantTool::SkipTurn::OrHash
+                  Telnyx::AI::AssistantTool::SkipTurn::OrHash,
+                  Telnyx::AI::AssistantTool::Pay::OrHash
                 )
               ],
             transcription: Telnyx::AI::TranscriptionSettings::OrHash,
@@ -733,7 +735,8 @@ module Telnyx
                           Telnyx::AI::AssistantTool::Refer::OrHash,
                           Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                           Telnyx::AI::AssistantTool::SendMessage::OrHash,
-                          Telnyx::AI::AssistantTool::SkipTurn::OrHash
+                          Telnyx::AI::AssistantTool::SkipTurn::OrHash,
+                          Telnyx::AI::AssistantTool::Pay::OrHash
                         )
                       ]
                     ]
@@ -826,7 +829,8 @@ module Telnyx
                           Telnyx::AI::AssistantTool::Refer::OrHash,
                           Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                           Telnyx::AI::AssistantTool::SendMessage::OrHash,
-                          Telnyx::AI::AssistantTool::SkipTurn::OrHash
+                          Telnyx::AI::AssistantTool::SkipTurn::OrHash,
+                          Telnyx::AI::AssistantTool::Pay::OrHash
                         )
                       ]
                     ],
@@ -1084,7 +1088,8 @@ module Telnyx
                         Telnyx::AI::AssistantTool::Refer::OrHash,
                         Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                         Telnyx::AI::AssistantTool::SendMessage::OrHash,
-                        Telnyx::AI::AssistantTool::SkipTurn::OrHash
+                        Telnyx::AI::AssistantTool::SkipTurn::OrHash,
+                        Telnyx::AI::AssistantTool::Pay::OrHash
                       )
                     ]
                 ).void
@@ -1129,7 +1134,8 @@ module Telnyx
                         Telnyx::AI::AssistantTool::Refer::OrHash,
                         Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                         Telnyx::AI::AssistantTool::SendMessage::OrHash,
-                        Telnyx::AI::AssistantTool::SkipTurn::OrHash
+                        Telnyx::AI::AssistantTool::SkipTurn::OrHash,
+                        Telnyx::AI::AssistantTool::Pay::OrHash
                       )
                     ],
                   type:

data/rbi/telnyx/models/ai/pay_tool_params.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class PayToolParams < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::AI::PayToolParams, Telnyx::Internal::AnyHash)
+          end
+
+        # The name of the pay connector configured in the Telnyx API. Must reference an
+        # existing pay connector for this organization.
+        sig { returns(String) }
+        attr_accessor :connector_name
+
+        # Default currency for payments processed by this tool.
+        sig { returns(T.nilable(String)) }
+        attr_reader :currency
+
+        sig { params(currency: String).void }
+        attr_writer :currency
+
+        # Optional description of the pay tool that will be passed to the assistant.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
+        # Default payment method for payments processed by this tool.
+        sig { returns(T.nilable(String)) }
+        attr_reader :payment_method
+
+        sig { params(payment_method: String).void }
+        attr_writer :payment_method
+
+        sig do
+          params(
+            connector_name: String,
+            currency: String,
+            description: T.nilable(String),
+            payment_method: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The name of the pay connector configured in the Telnyx API. Must reference an
+          # existing pay connector for this organization.
+          connector_name:,
+          # Default currency for payments processed by this tool.
+          currency: nil,
+          # Optional description of the pay tool that will be passed to the assistant.
+          description: nil,
+          # Default payment method for payments processed by this tool.
+          payment_method: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              connector_name: String,
+              currency: String,
+              description: T.nilable(String),
+              payment_method: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/tool_create_params.rbi

@@ -42,6 +42,12 @@ module Telnyx
         sig { params(invite: T::Hash[Symbol, T.anything]).void }
         attr_writer :invite
 
+        sig { returns(T.nilable(Telnyx::AI::PayToolParams)) }
+        attr_reader :pay
+
+        sig { params(pay: Telnyx::AI::PayToolParams::OrHash).void }
+        attr_writer :pay
+
         sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
         attr_reader :retrieval
 
@@ -68,6 +74,7 @@ module Telnyx
             function: T::Hash[Symbol, T.anything],
             handoff: T::Hash[Symbol, T.anything],
             invite: T::Hash[Symbol, T.anything],
+            pay: Telnyx::AI::PayToolParams::OrHash,
             retrieval: T::Hash[Symbol, T.anything],
             timeout_ms: Integer,
             webhook: T::Hash[Symbol, T.anything],
@@ -81,6 +88,7 @@ module Telnyx
           function: nil,
           handoff: nil,
           invite: nil,
+          pay: nil,
           retrieval: nil,
           timeout_ms: nil,
           webhook: nil,
@@ -97,6 +105,7 @@ module Telnyx
               function: T::Hash[Symbol, T.anything],
               handoff: T::Hash[Symbol, T.anything],
               invite: T::Hash[Symbol, T.anything],
+              pay: Telnyx::AI::PayToolParams,
               retrieval: T::Hash[Symbol, T.anything],
               timeout_ms: Integer,
               webhook: T::Hash[Symbol, T.anything],

data/rbi/telnyx/models/ai/tool_update_params.rbi

@@ -45,6 +45,12 @@ module Telnyx
         sig { params(invite: T::Hash[Symbol, T.anything]).void }
         attr_writer :invite
 
+        sig { returns(T.nilable(Telnyx::AI::PayToolParams)) }
+        attr_reader :pay
+
+        sig { params(pay: Telnyx::AI::PayToolParams::OrHash).void }
+        attr_writer :pay
+
         sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
         attr_reader :retrieval
 
@@ -77,6 +83,7 @@ module Telnyx
             function: T::Hash[Symbol, T.anything],
             handoff: T::Hash[Symbol, T.anything],
             invite: T::Hash[Symbol, T.anything],
+            pay: Telnyx::AI::PayToolParams::OrHash,
             retrieval: T::Hash[Symbol, T.anything],
             timeout_ms: Integer,
             type: String,
@@ -91,6 +98,7 @@ module Telnyx
           function: nil,
           handoff: nil,
           invite: nil,
+          pay: nil,
           retrieval: nil,
           timeout_ms: nil,
           type: nil,
@@ -108,6 +116,7 @@ module Telnyx
               function: T::Hash[Symbol, T.anything],
               handoff: T::Hash[Symbol, T.anything],
               invite: T::Hash[Symbol, T.anything],
+              pay: Telnyx::AI::PayToolParams,
               retrieval: T::Hash[Symbol, T.anything],
               timeout_ms: Integer,
               type: String,

data/rbi/telnyx/models/ai/transcription_settings.rbi

@@ -42,7 +42,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.
         sig do
           returns(T.nilable(Telnyx::AI::TranscriptionSettings::Model::OrSymbol))
@@ -103,7 +103,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.
           model: nil,
           # Region on third party cloud providers (currently Azure) if using one of their
@@ -139,7 +139,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.
         module Model
           extend Telnyx::Internal::Type::Enum
@@ -185,9 +185,9 @@ module Telnyx
               :"soniox/stt-rt-v4",
               Telnyx::AI::TranscriptionSettings::Model::TaggedSymbol
             )
-          PARAKEET_TDT_0_6B_V3 =
+          NVIDIA_PARAKEET_V3 =
             T.let(
-              :"parakeet/tdt-0.6b-v3",
+              :"nvidia/parakeet-v3",
               Telnyx::AI::TranscriptionSettings::Model::TaggedSymbol
             )
           DISTIL_WHISPER_DISTIL_LARGE_V2 =

data/rbi/telnyx/models/call_dial_params.rbi

@@ -369,6 +369,17 @@ module Telnyx
       end
       attr_writer :record_trim
 
+      # 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`.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :retry_on_timeout
+
+      sig { params(retry_on_timeout: T::Boolean).void }
+      attr_writer :retry_on_timeout
+
       # 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
       # called party picks up). Allowed characters: `0-9`, `A-D`, `w` (0.5s pause), `W`
@@ -707,6 +718,7 @@ module Telnyx
           record_timeout_secs: Integer,
           record_track: Telnyx::CallDialParams::RecordTrack::OrSymbol,
           record_trim: Telnyx::CallDialParams::RecordTrim::OrSymbol,
+          retry_on_timeout: T::Boolean,
           send_digits_on_answer: String,
           send_silence_when_idle: T::Boolean,
           sip_auth_password: String,
@@ -894,6 +906,12 @@ module Telnyx
         # When set to `trim-silence`, silence will be removed from the beginning and end
         # of the recording.
         record_trim: nil,
+        # 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`.
+        retry_on_timeout: nil,
         # 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
         # called party picks up). Allowed characters: `0-9`, `A-D`, `w` (0.5s pause), `W`
@@ -1022,6 +1040,7 @@ module Telnyx
             record_timeout_secs: Integer,
             record_track: Telnyx::CallDialParams::RecordTrack::OrSymbol,
             record_trim: Telnyx::CallDialParams::RecordTrim::OrSymbol,
+            retry_on_timeout: T::Boolean,
             send_digits_on_answer: String,
             send_silence_when_idle: T::Boolean,
             sip_auth_password: String,

data/rbi/telnyx/models/calls/transcription_config.rbi

@@ -16,7 +16,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.
         sig { returns(T.nilable(String)) }
         attr_reader :language
 
@@ -34,7 +38,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`.
@@ -75,7 +79,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.
           language: nil,
           # The speech to text model to be used by the voice assistant. Supported models
           # include:
@@ -88,7 +96,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`.
@@ -123,7 +131,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`.
@@ -186,9 +194,9 @@ module Telnyx
               :"soniox/stt-rt-v4",
               Telnyx::Calls::TranscriptionConfig::Model::TaggedSymbol
             )
-          PARAKEET_TDT_0_6B_V3 =
+          NVIDIA_PARAKEET_V3 =
             T.let(
-              :"parakeet/tdt-0.6b-v3",
+              :"nvidia/parakeet-v3",
               Telnyx::Calls::TranscriptionConfig::Model::TaggedSymbol
             )
           AZURE_FAST =

data/rbi/telnyx/models/calls/transcription_engine_parakeet_config.rbi

@@ -133,9 +133,9 @@ module Telnyx
             end
           OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-          PARAKEET_TDT_0_6B_V3 =
+          NVIDIA_PARAKEET_V3 =
             T.let(
-              :"parakeet/tdt-0.6b-v3",
+              :"nvidia/parakeet-v3",
               Telnyx::Calls::TranscriptionEngineParakeetConfig::TranscriptionModel::TaggedSymbol
             )
 

data/rbi/telnyx/models/doc_reqs_requirement.rbi

@@ -63,6 +63,15 @@ module Telnyx
       sig { params(created_at: String).void }
       attr_writer :created_at
 
+      # When this version was superseded. NULL means this is the active or pending
+      # version.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :effective_end_at
+
+      # When this version became (or will become) active.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :effective_start_at
+
       # Identifies the type of the resource.
       sig { returns(T.nilable(String)) }
       attr_reader :record_type
@@ -72,14 +81,14 @@ module Telnyx
 
       # Lists the requirement types necessary to fulfill this requirement
       sig { returns(T.nilable(T::Array[Telnyx::DocReqsRequirementType])) }
-      attr_reader :requirements_types
+      attr_reader :requirement_types
 
       sig do
         params(
-          requirements_types: T::Array[Telnyx::DocReqsRequirementType::OrHash]
+          requirement_types: T::Array[Telnyx::DocReqsRequirementType::OrHash]
         ).void
       end
-      attr_writer :requirements_types
+      attr_writer :requirement_types
 
       # ISO 8601 formatted date-time indicating when the resource was last updated.
       sig { returns(T.nilable(String)) }
@@ -88,18 +97,28 @@ module Telnyx
       sig { params(updated_at: String).void }
       attr_writer :updated_at
 
+      # Version number. Increments with each new version. Defaults to 1.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :version
+
+      sig { params(version: Integer).void }
+      attr_writer :version
+
       sig do
         params(
           id: String,
           action: Telnyx::DocReqsRequirement::Action::OrSymbol,
           country_code: String,
           created_at: String,
+          effective_end_at: T.nilable(Time),
+          effective_start_at: T.nilable(Time),
           locality: String,
           phone_number_type:
             Telnyx::DocReqsRequirement::PhoneNumberType::OrSymbol,
           record_type: String,
-          requirements_types: T::Array[Telnyx::DocReqsRequirementType::OrHash],
-          updated_at: String
+          requirement_types: T::Array[Telnyx::DocReqsRequirementType::OrHash],
+          updated_at: String,
+          version: Integer
         ).returns(T.attached_class)
       end
       def self.new(
@@ -112,6 +131,11 @@ module Telnyx
         country_code: nil,
         # ISO 8601 formatted date-time indicating when the resource was created.
         created_at: nil,
+        # When this version was superseded. NULL means this is the active or pending
+        # version.
+        effective_end_at: nil,
+        # When this version became (or will become) active.
+        effective_start_at: nil,
         # The locality where this requirement applies
         locality: nil,
         # Indicates the phone_number_type this requirement applies to. Leave blank if this
@@ -120,9 +144,11 @@ module Telnyx
         # Identifies the type of the resource.
         record_type: nil,
         # Lists the requirement types necessary to fulfill this requirement
-        requirements_types: nil,
+        requirement_types: nil,
         # ISO 8601 formatted date-time indicating when the resource was last updated.
-        updated_at: nil
+        updated_at: nil,
+        # Version number. Increments with each new version. Defaults to 1.
+        version: nil
       )
       end
 
@@ -133,12 +159,15 @@ module Telnyx
             action: Telnyx::DocReqsRequirement::Action::TaggedSymbol,
             country_code: String,
             created_at: String,
+            effective_end_at: T.nilable(Time),
+            effective_start_at: T.nilable(Time),
             locality: String,
             phone_number_type:
               Telnyx::DocReqsRequirement::PhoneNumberType::TaggedSymbol,
             record_type: String,
-            requirements_types: T::Array[Telnyx::DocReqsRequirementType],
-            updated_at: String
+            requirement_types: T::Array[Telnyx::DocReqsRequirementType],
+            updated_at: String,
+            version: Integer
           }
         )
       end