telnyx 5.156.0 → 5.158.0

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

@@ -0,0 +1,188 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Conversations
+        class ConversationInsightRetrieveAggregatesParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::AI::Conversations::ConversationInsightRetrieveAggregatesParams,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Filter by creation datetime to scope the aggregation window. Supports range
+          # operators (e.g., `created_at=gte.2025-01-01T00:00:00Z` for the start of the
+          # range, `created_at=lt.2025-01-02T00:00:00Z` for the end). To build per-day time
+          # series (as the portal does for the 'Insights Over Time' chart), issue one
+          # request per day bounded by `created_at=gte.<day_start>` and
+          # `created_at=lt.<next_day_start>`.
+          sig { returns(T.nilable(String)) }
+          attr_reader :created_at
+
+          sig { params(created_at: String).void }
+          attr_writer :created_at
+
+          # Fields to group by (can be comma-separated or multiple parameters). Prefix a
+          # field with 'metadata.' (e.g. 'metadata.assistant_id') to group by the
+          # conversation's metadata instead of the insight result.
+          #
+          # Common fields used for over-time charts:
+          #
+          # - `score` — Group by the insight's score value (e.g. for Agent Instruction
+          #   Following, User Satisfaction).
+          # - `metadata.assistant_id` — Group by the assistant that handled the
+          #   conversation.
+          # - `metadata.assistant_version_id` — Group by the assistant version, useful for
+          #   comparing performance across versions in the portal's 'Insights Over Time'
+          #   chart.
+          # - `metadata.telnyx_conversation_channel` — Group by conversation channel
+          #   (phone_call, web_chat, etc.).
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :group_by
+
+          sig { params(group_by: T::Array[String]).void }
+          attr_writer :group_by
+
+          # Optional insight ID to filter conversation insights. Only insights matching this
+          # ID will be included in the aggregation.
+          sig { returns(T.nilable(String)) }
+          attr_reader :insight_id
+
+          sig { params(insight_id: String).void }
+          attr_writer :insight_id
+
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::AI::Conversations::ConversationInsightRetrieveAggregatesParams::Metadata
+              )
+            )
+          end
+          attr_reader :metadata
+
+          sig do
+            params(
+              metadata:
+                Telnyx::AI::Conversations::ConversationInsightRetrieveAggregatesParams::Metadata::OrHash
+            ).void
+          end
+          attr_writer :metadata
+
+          # Fields to include in the result (can be comma-separated or multiple parameters).
+          # Supports the same 'metadata.<key>' prefix as group_by. Each returned row will
+          # contain the grouped field values plus a `record_count` indicating how many
+          # conversation insights match that combination.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :show
+
+          sig { params(show: T::Array[String]).void }
+          attr_writer :show
+
+          sig do
+            params(
+              created_at: String,
+              group_by: T::Array[String],
+              insight_id: String,
+              metadata:
+                Telnyx::AI::Conversations::ConversationInsightRetrieveAggregatesParams::Metadata::OrHash,
+              show: T::Array[String],
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Filter by creation datetime to scope the aggregation window. Supports range
+            # operators (e.g., `created_at=gte.2025-01-01T00:00:00Z` for the start of the
+            # range, `created_at=lt.2025-01-02T00:00:00Z` for the end). To build per-day time
+            # series (as the portal does for the 'Insights Over Time' chart), issue one
+            # request per day bounded by `created_at=gte.<day_start>` and
+            # `created_at=lt.<next_day_start>`.
+            created_at: nil,
+            # Fields to group by (can be comma-separated or multiple parameters). Prefix a
+            # field with 'metadata.' (e.g. 'metadata.assistant_id') to group by the
+            # conversation's metadata instead of the insight result.
+            #
+            # Common fields used for over-time charts:
+            #
+            # - `score` — Group by the insight's score value (e.g. for Agent Instruction
+            #   Following, User Satisfaction).
+            # - `metadata.assistant_id` — Group by the assistant that handled the
+            #   conversation.
+            # - `metadata.assistant_version_id` — Group by the assistant version, useful for
+            #   comparing performance across versions in the portal's 'Insights Over Time'
+            #   chart.
+            # - `metadata.telnyx_conversation_channel` — Group by conversation channel
+            #   (phone_call, web_chat, etc.).
+            group_by: nil,
+            # Optional insight ID to filter conversation insights. Only insights matching this
+            # ID will be included in the aggregation.
+            insight_id: nil,
+            metadata: nil,
+            # Fields to include in the result (can be comma-separated or multiple parameters).
+            # Supports the same 'metadata.<key>' prefix as group_by. Each returned row will
+            # contain the grouped field values plus a `record_count` indicating how many
+            # conversation insights match that combination.
+            show: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                created_at: String,
+                group_by: T::Array[String],
+                insight_id: String,
+                metadata:
+                  Telnyx::AI::Conversations::ConversationInsightRetrieveAggregatesParams::Metadata,
+                show: T::Array[String],
+                request_options: Telnyx::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Metadata < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::AI::Conversations::ConversationInsightRetrieveAggregatesParams::Metadata,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # Filter by assistant ID (e.g., `metadata.assistant_id=eq.<assistant_id>`). When
+            # provided, only conversation insights for the specified assistant are aggregated.
+            # Used by the portal to scope the 'Insights Over Time' chart to a single
+            # assistant.
+            sig { returns(T.nilable(String)) }
+            attr_reader :assistant_id
+
+            sig { params(assistant_id: String).void }
+            attr_writer :assistant_id
+
+            sig { params(assistant_id: String).returns(T.attached_class) }
+            def self.new(
+              # Filter by assistant ID (e.g., `metadata.assistant_id=eq.<assistant_id>`). When
+              # provided, only conversation insights for the specified assistant are aggregated.
+              # Used by the portal to scope the 'Insights Over Time' chart to a single
+              # assistant.
+              assistant_id: nil
+            )
+            end
+
+            sig { override.returns({ assistant_id: String }) }
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

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_answered.rbi

@@ -158,10 +158,17 @@ module Telnyx
         attr_writer :from
 
         # User-to-User and Diversion headers from sip invite.
-        sig { returns(T.nilable(T::Array[Telnyx::SipHeader])) }
+        sig do
+          returns(T.nilable(T::Array[Telnyx::CallAnswered::Payload::SipHeader]))
+        end
         attr_reader :sip_headers
 
-        sig { params(sip_headers: T::Array[Telnyx::SipHeader::OrHash]).void }
+        sig do
+          params(
+            sip_headers:
+              T::Array[Telnyx::CallAnswered::Payload::SipHeader::OrHash]
+          ).void
+        end
         attr_writer :sip_headers
 
         # ISO 8601 datetime of when the call started.
@@ -205,7 +212,8 @@ module Telnyx
             connection_id: String,
             custom_headers: T::Array[Telnyx::CustomSipHeader::OrHash],
             from: String,
-            sip_headers: T::Array[Telnyx::SipHeader::OrHash],
+            sip_headers:
+              T::Array[Telnyx::CallAnswered::Payload::SipHeader::OrHash],
             start_time: Time,
             state: Telnyx::CallAnswered::Payload::State::OrSymbol,
             tags: T::Array[String],
@@ -252,7 +260,7 @@ module Telnyx
               connection_id: String,
               custom_headers: T::Array[Telnyx::CustomSipHeader],
               from: String,
-              sip_headers: T::Array[Telnyx::SipHeader],
+              sip_headers: T::Array[Telnyx::CallAnswered::Payload::SipHeader],
               start_time: Time,
               state: Telnyx::CallAnswered::Payload::State::TaggedSymbol,
               tags: T::Array[String],
@@ -263,6 +271,86 @@ module Telnyx
         def to_hash
         end
 
+        class SipHeader < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::CallAnswered::Payload::SipHeader,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # The name of the header received from the SIP INVITE.
+          sig do
+            returns(
+              Telnyx::CallAnswered::Payload::SipHeader::Name::TaggedSymbol
+            )
+          end
+          attr_accessor :name
+
+          # The value of the header.
+          sig { returns(String) }
+          attr_accessor :value
+
+          sig do
+            params(
+              name: Telnyx::CallAnswered::Payload::SipHeader::Name::OrSymbol,
+              value: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The name of the header received from the SIP INVITE.
+            name:,
+            # The value of the header.
+            value:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                name:
+                  Telnyx::CallAnswered::Payload::SipHeader::Name::TaggedSymbol,
+                value: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The name of the header received from the SIP INVITE.
+          module Name
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(Symbol, Telnyx::CallAnswered::Payload::SipHeader::Name)
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            USER_TO_USER =
+              T.let(
+                :"User-to-User",
+                Telnyx::CallAnswered::Payload::SipHeader::Name::TaggedSymbol
+              )
+            DIVERSION =
+              T.let(
+                :Diversion,
+                Telnyx::CallAnswered::Payload::SipHeader::Name::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::CallAnswered::Payload::SipHeader::Name::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
         # State received from a command.
         module State
           extend Telnyx::Internal::Type::Enum