telnyx 5.170.0 → 5.171.0

data/rbi/telnyx/models/ai/memory/namespace_list_response.rbi

@@ -0,0 +1,36 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        class NamespaceListResponse < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::AI::Memory::NamespaceListResponse,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T::Array[Telnyx::AI::Memory::Namespace]) }
+          attr_accessor :data
+
+          sig do
+            params(
+              data: T::Array[Telnyx::AI::Memory::Namespace::OrHash]
+            ).returns(T.attached_class)
+          end
+          def self.new(data:)
+          end
+
+          sig do
+            override.returns({ data: T::Array[Telnyx::AI::Memory::Namespace] })
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/memory/namespaces/profile_preview_params.rbi

@@ -0,0 +1,72 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          class ProfilePreviewParams < Telnyx::Internal::Type::BaseModel
+            extend Telnyx::Internal::Type::RequestParameters::Converter
+            include Telnyx::Internal::Type::RequestParameters
+
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::AI::Memory::Namespaces::ProfilePreviewParams,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # The namespace. `default` exists for every organization.
+            sig { returns(String) }
+            attr_accessor :namespace
+
+            sig { returns(String) }
+            attr_accessor :profile_id
+
+            # The candidate note to try. `null`, empty, or whitespace-only previews the
+            # neutral default -- the summary a profile returns to when instructions are
+            # cleared. Capped at 2000 characters, the same cap `PATCH /settings` applies on
+            # save; a longer note is refused with `422` before anything is generated.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :instructions
+
+            sig do
+              params(
+                namespace: String,
+                profile_id: String,
+                instructions: T.nilable(String),
+                request_options: Telnyx::RequestOptions::OrHash
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The namespace. `default` exists for every organization.
+              namespace:,
+              profile_id:,
+              # The candidate note to try. `null`, empty, or whitespace-only previews the
+              # neutral default -- the summary a profile returns to when instructions are
+              # cleared. Capped at 2000 characters, the same cap `PATCH /settings` applies on
+              # save; a longer note is refused with `422` before anything is generated.
+              instructions: nil,
+              request_options: {}
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  namespace: String,
+                  profile_id: String,
+                  instructions: T.nilable(String),
+                  request_options: Telnyx::RequestOptions
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/memory/namespaces/profile_preview_response.rbi

@@ -0,0 +1,97 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          class ProfilePreviewResponse < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::AI::Memory::Namespaces::ProfilePreviewResponse,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            sig do
+              returns(
+                Telnyx::Models::AI::Memory::Namespaces::ProfilePreviewResponse::Data
+              )
+            end
+            attr_reader :data
+
+            sig do
+              params(
+                data:
+                  Telnyx::Models::AI::Memory::Namespaces::ProfilePreviewResponse::Data::OrHash
+              ).void
+            end
+            attr_writer :data
+
+            sig do
+              params(
+                data:
+                  Telnyx::Models::AI::Memory::Namespaces::ProfilePreviewResponse::Data::OrHash
+              ).returns(T.attached_class)
+            end
+            def self.new(data:)
+            end
+
+            sig do
+              override.returns(
+                {
+                  data:
+                    Telnyx::Models::AI::Memory::Namespaces::ProfilePreviewResponse::Data
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class Data < Telnyx::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::Models::AI::Memory::Namespaces::ProfilePreviewResponse::Data,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              sig { returns(String) }
+              attr_accessor :profile_id
+
+              # The summary this profile would carry under the candidate note. Null when nothing
+              # was generated -- the same signal `GET /summary` uses for a profile with no card
+              # yet.
+              sig { returns(T.nilable(String)) }
+              attr_accessor :text
+
+              sig do
+                params(profile_id: String, text: T.nilable(String)).returns(
+                  T.attached_class
+                )
+              end
+              def self.new(
+                profile_id:,
+                # The summary this profile would carry under the candidate note. Null when nothing
+                # was generated -- the same signal `GET /summary` uses for a profile with no card
+                # yet.
+                text:
+              )
+              end
+
+              sig do
+                override.returns(
+                  { profile_id: String, text: T.nilable(String) }
+                )
+              end
+              def to_hash
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -14,6 +14,15 @@ module Telnyx
         sig { returns(String) }
         attr_accessor :connector_name
 
+        # Custom key/value parameters forwarded to the pay connector as `parameters` in
+        # the processor request. String values may use `{{dynamic_variable}}` templating,
+        # resolved per call.
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :connector_parameters
+
+        sig { params(connector_parameters: T::Hash[Symbol, T.anything]).void }
+        attr_writer :connector_parameters
+
         # Default currency for payments processed by this tool.
         sig { returns(T.nilable(String)) }
         attr_reader :currency
@@ -21,7 +30,9 @@ module Telnyx
         sig { params(currency: String).void }
         attr_writer :currency
 
-        # Optional description of the pay tool that will be passed to the assistant.
+        # Description of the pay tool shown to the assistant so it knows when to call the
+        # tool. Not sent to the payment connector — the per-call `description` argument
+        # the assistant passes is what reaches the processor.
         sig { returns(T.nilable(String)) }
         attr_accessor :description
 
@@ -32,24 +43,57 @@ module Telnyx
         sig { params(payment_method: String).void }
         attr_writer :payment_method
 
+        # Restricts accepted card numbers to the listed card types. When the caller enters
+        # a card number that does not match one of the listed types, Pay treats the input
+        # as invalid and re-prompts for the card number.
+        sig do
+          returns(
+            T.nilable(
+              T::Array[Telnyx::AI::PayToolParams::ValidCardType::OrSymbol]
+            )
+          )
+        end
+        attr_reader :valid_card_types
+
+        sig do
+          params(
+            valid_card_types:
+              T::Array[Telnyx::AI::PayToolParams::ValidCardType::OrSymbol]
+          ).void
+        end
+        attr_writer :valid_card_types
+
         sig do
           params(
             connector_name: String,
+            connector_parameters: T::Hash[Symbol, T.anything],
             currency: String,
             description: T.nilable(String),
-            payment_method: String
+            payment_method: String,
+            valid_card_types:
+              T::Array[Telnyx::AI::PayToolParams::ValidCardType::OrSymbol]
           ).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:,
+          # Custom key/value parameters forwarded to the pay connector as `parameters` in
+          # the processor request. String values may use `{{dynamic_variable}}` templating,
+          # resolved per call.
+          connector_parameters: nil,
           # Default currency for payments processed by this tool.
           currency: nil,
-          # Optional description of the pay tool that will be passed to the assistant.
+          # Description of the pay tool shown to the assistant so it knows when to call the
+          # tool. Not sent to the payment connector — the per-call `description` argument
+          # the assistant passes is what reaches the processor.
           description: nil,
           # Default payment method for payments processed by this tool.
-          payment_method: nil
+          payment_method: nil,
+          # Restricts accepted card numbers to the listed card types. When the caller enters
+          # a card number that does not match one of the listed types, Pay treats the input
+          # as invalid and re-prompts for the card number.
+          valid_card_types: nil
         )
         end
 
@@ -57,14 +101,72 @@ module Telnyx
           override.returns(
             {
               connector_name: String,
+              connector_parameters: T::Hash[Symbol, T.anything],
               currency: String,
               description: T.nilable(String),
-              payment_method: String
+              payment_method: String,
+              valid_card_types:
+                T::Array[Telnyx::AI::PayToolParams::ValidCardType::OrSymbol]
             }
           )
         end
         def to_hash
         end
+
+        module ValidCardType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::AI::PayToolParams::ValidCardType)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          VISA =
+            T.let(:visa, Telnyx::AI::PayToolParams::ValidCardType::TaggedSymbol)
+          MASTERCARD =
+            T.let(
+              :mastercard,
+              Telnyx::AI::PayToolParams::ValidCardType::TaggedSymbol
+            )
+          AMEX =
+            T.let(:amex, Telnyx::AI::PayToolParams::ValidCardType::TaggedSymbol)
+          MAESTRO =
+            T.let(
+              :maestro,
+              Telnyx::AI::PayToolParams::ValidCardType::TaggedSymbol
+            )
+          DISCOVER =
+            T.let(
+              :discover,
+              Telnyx::AI::PayToolParams::ValidCardType::TaggedSymbol
+            )
+          OPTIMA =
+            T.let(
+              :optima,
+              Telnyx::AI::PayToolParams::ValidCardType::TaggedSymbol
+            )
+          JCB =
+            T.let(:jcb, Telnyx::AI::PayToolParams::ValidCardType::TaggedSymbol)
+          DINERS_CLUB =
+            T.let(
+              :"diners-club",
+              Telnyx::AI::PayToolParams::ValidCardType::TaggedSymbol
+            )
+          ENROUTE =
+            T.let(
+              :enroute,
+              Telnyx::AI::PayToolParams::ValidCardType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[Telnyx::AI::PayToolParams::ValidCardType::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
       end
     end
   end

data/rbi/telnyx/models/ai/telephony_settings.rbi

@@ -9,6 +9,18 @@ module Telnyx
             T.any(Telnyx::AI::TelephonySettings, Telnyx::Internal::AnyHash)
           end
 
+        # When enabled, the `messages` array of the `call.conversation.ended` webhook
+        # contains the full conversation history in order: user and assistant turns,
+        # assistant tool calls (`tool_calls`), tool results (`role: tool` with
+        # `tool_call_id`), and informational `system` and `developer` entries. The
+        # assistant's instructions are never included. When disabled, `messages` contains
+        # only user and assistant text turns.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :conversation_ended_full_history
+
+        sig { params(conversation_ended_full_history: T::Boolean).void }
+        attr_writer :conversation_ended_full_history
+
         # Default Texml App used for voice calls with your assistant. This will be created
         # automatically on assistant creation.
         sig { returns(T.nilable(String)) }
@@ -163,6 +175,7 @@ module Telnyx
 
         sig do
           params(
+            conversation_ended_full_history: T::Boolean,
             default_texml_app_id: String,
             disable_dtmf: T::Boolean,
             fallback_destination: String,
@@ -182,6 +195,13 @@ module Telnyx
           ).returns(T.attached_class)
         end
         def self.new(
+          # When enabled, the `messages` array of the `call.conversation.ended` webhook
+          # contains the full conversation history in order: user and assistant turns,
+          # assistant tool calls (`tool_calls`), tool results (`role: tool` with
+          # `tool_call_id`), and informational `system` and `developer` entries. The
+          # assistant's instructions are never included. When disabled, `messages` contains
+          # only user and assistant text turns.
+          conversation_ended_full_history: nil,
           # Default Texml App used for voice calls with your assistant. This will be created
           # automatically on assistant creation.
           default_texml_app_id: nil,
@@ -248,6 +268,7 @@ module Telnyx
         sig do
           override.returns(
             {
+              conversation_ended_full_history: T::Boolean,
               default_texml_app_id: String,
               disable_dtmf: T::Boolean,
               fallback_destination: String,

data/rbi/telnyx/models/ai/telnyx_avatar_settings.rbi

@@ -0,0 +1,187 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class TelnyxAvatarSettings < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::AI::TelnyxAvatarSettings, Telnyx::Internal::AnyHash)
+          end
+
+        # The Telnyx avatar to render.
+        sig do
+          returns(Telnyx::AI::TelnyxAvatarSettings::AvatarID::TaggedSymbol)
+        end
+        attr_accessor :avatar_id
+
+        # The background to render.
+        sig do
+          returns(Telnyx::AI::TelnyxAvatarSettings::BackgroundID::TaggedSymbol)
+        end
+        attr_accessor :background_id
+
+        # Required avatar model identifier, separate from `avatar_id`. The supported value
+        # is `foxtrot-1`. Omission, null, and unsupported model identifiers are rejected.
+        sig { returns(Telnyx::AI::TelnyxAvatarSettings::Model::TaggedSymbol) }
+        attr_accessor :model
+
+        # Selects the Telnyx open-source avatar provider.
+        sig { returns(Symbol) }
+        attr_accessor :provider
+
+        # **Beta:** Configuration for the Telnyx open-source avatar provider. The launch
+        # catalog supports six avatars and office, studio, or reception backgrounds.
+        sig do
+          params(
+            avatar_id: Telnyx::AI::TelnyxAvatarSettings::AvatarID::OrSymbol,
+            background_id:
+              Telnyx::AI::TelnyxAvatarSettings::BackgroundID::OrSymbol,
+            model: Telnyx::AI::TelnyxAvatarSettings::Model::OrSymbol,
+            provider: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The Telnyx avatar to render.
+          avatar_id:,
+          # The background to render.
+          background_id:,
+          # Required avatar model identifier, separate from `avatar_id`. The supported value
+          # is `foxtrot-1`. Omission, null, and unsupported model identifiers are rejected.
+          model:,
+          # Selects the Telnyx open-source avatar provider.
+          provider: :telnyx
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              avatar_id:
+                Telnyx::AI::TelnyxAvatarSettings::AvatarID::TaggedSymbol,
+              background_id:
+                Telnyx::AI::TelnyxAvatarSettings::BackgroundID::TaggedSymbol,
+              model: Telnyx::AI::TelnyxAvatarSettings::Model::TaggedSymbol,
+              provider: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The Telnyx avatar to render.
+        module AvatarID
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::AI::TelnyxAvatarSettings::AvatarID)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ELENA =
+            T.let(
+              :elena,
+              Telnyx::AI::TelnyxAvatarSettings::AvatarID::TaggedSymbol
+            )
+          BEN =
+            T.let(
+              :ben,
+              Telnyx::AI::TelnyxAvatarSettings::AvatarID::TaggedSymbol
+            )
+          JORDAN =
+            T.let(
+              :jordan,
+              Telnyx::AI::TelnyxAvatarSettings::AvatarID::TaggedSymbol
+            )
+          LIN =
+            T.let(
+              :lin,
+              Telnyx::AI::TelnyxAvatarSettings::AvatarID::TaggedSymbol
+            )
+          AVERY =
+            T.let(
+              :avery,
+              Telnyx::AI::TelnyxAvatarSettings::AvatarID::TaggedSymbol
+            )
+          RAPHAEL =
+            T.let(
+              :raphael,
+              Telnyx::AI::TelnyxAvatarSettings::AvatarID::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[Telnyx::AI::TelnyxAvatarSettings::AvatarID::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # The background to render.
+        module BackgroundID
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::AI::TelnyxAvatarSettings::BackgroundID)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          OFFICE =
+            T.let(
+              :office,
+              Telnyx::AI::TelnyxAvatarSettings::BackgroundID::TaggedSymbol
+            )
+          STUDIO =
+            T.let(
+              :studio,
+              Telnyx::AI::TelnyxAvatarSettings::BackgroundID::TaggedSymbol
+            )
+          RECEPTION =
+            T.let(
+              :reception,
+              Telnyx::AI::TelnyxAvatarSettings::BackgroundID::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::AI::TelnyxAvatarSettings::BackgroundID::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Required avatar model identifier, separate from `avatar_id`. The supported value
+        # is `foxtrot-1`. Omission, null, and unsupported model identifiers are rejected.
+        module Model
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::AI::TelnyxAvatarSettings::Model)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          FOXTROT_1 =
+            T.let(
+              :"foxtrot-1",
+              Telnyx::AI::TelnyxAvatarSettings::Model::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[Telnyx::AI::TelnyxAvatarSettings::Model::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/tool_node.rbi

@@ -15,13 +15,26 @@ module Telnyx
 
         # ID of the single shared (org-level) tool this node executes. When the flow
         # reaches this node the tool runs as a deliberate step (no LLM turn); its outgoing
-        # `tool_result` edges then route on the outcome. Arguments are filled from the
-        # conversation's dynamic variables by name — a dynamic variable whose name matches
-        # one of the tool's parameters supplies that argument. Cross-validated against the
-        # org's shared tools on write.
+        # `llm` / `expression` edges route the flow on the tool's outcome. Arguments are
+        # filled from the conversation's dynamic variables by name — a dynamic variable
+        # whose name matches one of the tool's parameters supplies that argument.
+        # Cross-validated against the org's shared tools on write.
         sig { returns(String) }
         attr_accessor :shared_tool_id
 
+        # Optional message delivered to the user verbatim immediately before the tool
+        # executes — an announcement such as 'One moment while I look that up.' No LLM
+        # turn and no customer turn: the message is spoken/sent, then the tool runs, in
+        # the same deterministic step. `{{variable}}` placeholders are interpolated from
+        # the conversation's dynamic variables (unresolved → empty string); the tool's own
+        # result is not yet available when the message is rendered. Omit for a silent tool
+        # step.
+        sig { returns(T.nilable(String)) }
+        attr_reader :message
+
+        sig { params(message: String).void }
+        attr_writer :message
+
         # Optional human-readable label, displayed in authoring UIs.
         sig { returns(T.nilable(String)) }
         attr_reader :name
@@ -83,6 +96,7 @@ module Telnyx
           params(
             id: String,
             shared_tool_id: String,
+            message: String,
             name: String,
             position: Telnyx::AI::NodePosition::OrHash,
             tool:
@@ -112,11 +126,19 @@ module Telnyx
           id:,
           # ID of the single shared (org-level) tool this node executes. When the flow
           # reaches this node the tool runs as a deliberate step (no LLM turn); its outgoing
-          # `tool_result` edges then route on the outcome. Arguments are filled from the
-          # conversation's dynamic variables by name — a dynamic variable whose name matches
-          # one of the tool's parameters supplies that argument. Cross-validated against the
-          # org's shared tools on write.
+          # `llm` / `expression` edges route the flow on the tool's outcome. Arguments are
+          # filled from the conversation's dynamic variables by name — a dynamic variable
+          # whose name matches one of the tool's parameters supplies that argument.
+          # Cross-validated against the org's shared tools on write.
           shared_tool_id:,
+          # Optional message delivered to the user verbatim immediately before the tool
+          # executes — an announcement such as 'One moment while I look that up.' No LLM
+          # turn and no customer turn: the message is spoken/sent, then the tool runs, in
+          # the same deterministic step. `{{variable}}` placeholders are interpolated from
+          # the conversation's dynamic variables (unresolved → empty string); the tool's own
+          # result is not yet available when the message is rendered. Omit for a silent tool
+          # step.
+          message: nil,
           # Optional human-readable label, displayed in authoring UIs.
           name: nil,
           # Optional canvas coordinates used by authoring UIs to lay out the graph. Ignored
@@ -137,6 +159,7 @@ module Telnyx
             {
               id: String,
               shared_tool_id: String,
+              message: String,
               name: String,
               position: Telnyx::AI::NodePosition,
               tool: T::Array[Telnyx::AI::AssistantTool::Variants],