telnyx 5.159.0 → 5.161.0

data/rbi/telnyx/models/ai/assistant_create_params.rbi

@@ -272,7 +272,8 @@ module Telnyx
                   Telnyx::AI::AssistantTool::SendDtmf,
                   Telnyx::AI::AssistantTool::SendMessage,
                   Telnyx::AI::AssistantTool::SkipTurn,
-                  Telnyx::AI::AssistantTool::Pay
+                  Telnyx::AI::AssistantTool::Pay,
+                  Telnyx::AI::AssistantTool::UpdateDynamicVariables
                 )
               ]
             )
@@ -296,7 +297,8 @@ module Telnyx
                   Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                   Telnyx::AI::AssistantTool::SendMessage::OrHash,
                   Telnyx::AI::AssistantTool::SkipTurn::OrHash,
-                  Telnyx::AI::AssistantTool::Pay::OrHash
+                  Telnyx::AI::AssistantTool::Pay::OrHash,
+                  Telnyx::AI::AssistantTool::UpdateDynamicVariables::OrHash
                 )
               ]
           ).void
@@ -366,7 +368,8 @@ module Telnyx
                   Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                   Telnyx::AI::AssistantTool::SendMessage::OrHash,
                   Telnyx::AI::AssistantTool::SkipTurn::OrHash,
-                  Telnyx::AI::AssistantTool::Pay::OrHash
+                  Telnyx::AI::AssistantTool::Pay::OrHash,
+                  Telnyx::AI::AssistantTool::UpdateDynamicVariables::OrHash
                 )
               ],
             transcription: Telnyx::AI::TranscriptionSettings::OrHash,
@@ -514,7 +517,8 @@ module Telnyx
                     Telnyx::AI::AssistantTool::SendDtmf,
                     Telnyx::AI::AssistantTool::SendMessage,
                     Telnyx::AI::AssistantTool::SkipTurn,
-                    Telnyx::AI::AssistantTool::Pay
+                    Telnyx::AI::AssistantTool::Pay,
+                    Telnyx::AI::AssistantTool::UpdateDynamicVariables
                   )
                 ],
               transcription: Telnyx::AI::TranscriptionSettings,

data/rbi/telnyx/models/ai/assistant_tool.rbi

@@ -23,7 +23,8 @@ module Telnyx
               Telnyx::AI::AssistantTool::SendDtmf,
               Telnyx::AI::AssistantTool::SendMessage,
               Telnyx::AI::AssistantTool::SkipTurn,
-              Telnyx::AI::AssistantTool::Pay
+              Telnyx::AI::AssistantTool::Pay,
+              Telnyx::AI::AssistantTool::UpdateDynamicVariables
             )
           end
 
@@ -2328,6 +2329,62 @@ module Telnyx
           end
         end
 
+        class UpdateDynamicVariables < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::AI::AssistantTool::UpdateDynamicVariables,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          # Configuration for an update_dynamic_variables tool.
+          sig { returns(Telnyx::AI::UpdateDynamicVariablesToolParams) }
+          attr_reader :update_dynamic_variables
+
+          sig do
+            params(
+              update_dynamic_variables:
+                Telnyx::AI::UpdateDynamicVariablesToolParams::OrHash
+            ).void
+          end
+          attr_writer :update_dynamic_variables
+
+          # The update_dynamic_variables tool lets the assistant write values into the
+          # conversation's dynamic-variables context during the call. Updated variables are
+          # available to later `{{variable}}` interpolation (prompts, speak nodes, message
+          # templates) and to flow edge conditions. Declare each variable the assistant is
+          # allowed to set under `updatable_variables`.
+          sig do
+            params(
+              update_dynamic_variables:
+                Telnyx::AI::UpdateDynamicVariablesToolParams::OrHash,
+              type: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Configuration for an update_dynamic_variables tool.
+            update_dynamic_variables:,
+            type: :update_dynamic_variables
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                type: Symbol,
+                update_dynamic_variables:
+                  Telnyx::AI::UpdateDynamicVariablesToolParams
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
         sig { override.returns(T::Array[Telnyx::AI::AssistantTool::Variants]) }
         def self.variants
         end

data/rbi/telnyx/models/ai/assistant_update_params.rbi

@@ -289,7 +289,8 @@ module Telnyx
                   Telnyx::AI::AssistantTool::SendDtmf,
                   Telnyx::AI::AssistantTool::SendMessage,
                   Telnyx::AI::AssistantTool::SkipTurn,
-                  Telnyx::AI::AssistantTool::Pay
+                  Telnyx::AI::AssistantTool::Pay,
+                  Telnyx::AI::AssistantTool::UpdateDynamicVariables
                 )
               ]
             )
@@ -313,7 +314,8 @@ module Telnyx
                   Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                   Telnyx::AI::AssistantTool::SendMessage::OrHash,
                   Telnyx::AI::AssistantTool::SkipTurn::OrHash,
-                  Telnyx::AI::AssistantTool::Pay::OrHash
+                  Telnyx::AI::AssistantTool::Pay::OrHash,
+                  Telnyx::AI::AssistantTool::UpdateDynamicVariables::OrHash
                 )
               ]
           ).void
@@ -392,7 +394,8 @@ module Telnyx
                   Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                   Telnyx::AI::AssistantTool::SendMessage::OrHash,
                   Telnyx::AI::AssistantTool::SkipTurn::OrHash,
-                  Telnyx::AI::AssistantTool::Pay::OrHash
+                  Telnyx::AI::AssistantTool::Pay::OrHash,
+                  Telnyx::AI::AssistantTool::UpdateDynamicVariables::OrHash
                 )
               ],
             transcription: Telnyx::AI::TranscriptionSettings::OrHash,
@@ -549,7 +552,8 @@ module Telnyx
                     Telnyx::AI::AssistantTool::SendDtmf,
                     Telnyx::AI::AssistantTool::SendMessage,
                     Telnyx::AI::AssistantTool::SkipTurn,
-                    Telnyx::AI::AssistantTool::Pay
+                    Telnyx::AI::AssistantTool::Pay,
+                    Telnyx::AI::AssistantTool::UpdateDynamicVariables
                   )
                 ],
               transcription: Telnyx::AI::TranscriptionSettings,

data/rbi/telnyx/models/ai/assistants/update_assistant.rbi

@@ -287,7 +287,8 @@ module Telnyx
                     Telnyx::AI::AssistantTool::SendDtmf,
                     Telnyx::AI::AssistantTool::SendMessage,
                     Telnyx::AI::AssistantTool::SkipTurn,
-                    Telnyx::AI::AssistantTool::Pay
+                    Telnyx::AI::AssistantTool::Pay,
+                    Telnyx::AI::AssistantTool::UpdateDynamicVariables
                   )
                 ]
               )
@@ -311,7 +312,8 @@ module Telnyx
                     Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                     Telnyx::AI::AssistantTool::SendMessage::OrHash,
                     Telnyx::AI::AssistantTool::SkipTurn::OrHash,
-                    Telnyx::AI::AssistantTool::Pay::OrHash
+                    Telnyx::AI::AssistantTool::Pay::OrHash,
+                    Telnyx::AI::AssistantTool::UpdateDynamicVariables::OrHash
                   )
                 ]
             ).void
@@ -392,7 +394,8 @@ module Telnyx
                     Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                     Telnyx::AI::AssistantTool::SendMessage::OrHash,
                     Telnyx::AI::AssistantTool::SkipTurn::OrHash,
-                    Telnyx::AI::AssistantTool::Pay::OrHash
+                    Telnyx::AI::AssistantTool::Pay::OrHash,
+                    Telnyx::AI::AssistantTool::UpdateDynamicVariables::OrHash
                   )
                 ],
               transcription: Telnyx::AI::TranscriptionSettings::OrHash,
@@ -542,7 +545,8 @@ module Telnyx
                       Telnyx::AI::AssistantTool::SendDtmf,
                       Telnyx::AI::AssistantTool::SendMessage,
                       Telnyx::AI::AssistantTool::SkipTurn,
-                      Telnyx::AI::AssistantTool::Pay
+                      Telnyx::AI::AssistantTool::Pay,
+                      Telnyx::AI::AssistantTool::UpdateDynamicVariables
                     )
                   ],
                 transcription: Telnyx::AI::TranscriptionSettings,

data/rbi/telnyx/models/ai/collection.rbi

@@ -0,0 +1,133 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class Collection < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::AI::Collection, Telnyx::Internal::AnyHash)
+          end
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :created_at
+
+        sig { params(created_at: Time).void }
+        attr_writer :created_at
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :description
+
+        sig { params(description: String).void }
+        attr_writer :description
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        # Identifies the record type. Always `ai_collection`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :record_type
+
+        sig { params(record_type: String).void }
+        attr_writer :record_type
+
+        sig do
+          returns(T.nilable(Telnyx::AI::Collections::RetrievalSettingsWrapper))
+        end
+        attr_reader :settings
+
+        sig do
+          params(
+            settings: Telnyx::AI::Collections::RetrievalSettingsWrapper::OrHash
+          ).void
+        end
+        attr_writer :settings
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :slug
+
+        sig { params(slug: String).void }
+        attr_writer :slug
+
+        sig { returns(T.nilable(T::Array[Telnyx::AI::Collections::Source])) }
+        attr_reader :sources
+
+        sig do
+          params(
+            sources: T::Array[Telnyx::AI::Collections::Source::OrHash]
+          ).void
+        end
+        attr_writer :sources
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :status
+
+        sig { params(status: String).void }
+        attr_writer :status
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :updated_at
+
+        sig { params(updated_at: Time).void }
+        attr_writer :updated_at
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :uuid
+
+        sig { params(uuid: String).void }
+        attr_writer :uuid
+
+        sig do
+          params(
+            created_at: Time,
+            description: String,
+            name: String,
+            record_type: String,
+            settings: Telnyx::AI::Collections::RetrievalSettingsWrapper::OrHash,
+            slug: String,
+            sources: T::Array[Telnyx::AI::Collections::Source::OrHash],
+            status: String,
+            updated_at: Time,
+            uuid: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          created_at: nil,
+          description: nil,
+          name: nil,
+          # Identifies the record type. Always `ai_collection`.
+          record_type: nil,
+          settings: nil,
+          slug: nil,
+          sources: nil,
+          status: nil,
+          updated_at: nil,
+          uuid: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              created_at: Time,
+              description: String,
+              name: String,
+              record_type: String,
+              settings: Telnyx::AI::Collections::RetrievalSettingsWrapper,
+              slug: String,
+              sources: T::Array[Telnyx::AI::Collections::Source],
+              status: String,
+              updated_at: Time,
+              uuid: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/collection_create_params.rbi

@@ -0,0 +1,101 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class CollectionCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::AI::CollectionCreateParams, Telnyx::Internal::AnyHash)
+          end
+
+        # Human-readable collection name.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # Optional description.
+        sig { returns(T.nilable(String)) }
+        attr_reader :description
+
+        sig { params(description: String).void }
+        attr_writer :description
+
+        # Optional retrieval settings.
+        sig do
+          returns(T.nilable(Telnyx::AI::Collections::RetrievalSettingsWrapper))
+        end
+        attr_reader :settings
+
+        sig do
+          params(
+            settings: Telnyx::AI::Collections::RetrievalSettingsWrapper::OrHash
+          ).void
+        end
+        attr_writer :settings
+
+        # Optional slug (unique per organization). Derived from `name` when omitted.
+        sig { returns(T.nilable(String)) }
+        attr_reader :slug
+
+        sig { params(slug: String).void }
+        attr_writer :slug
+
+        # Optional sources to attach at creation time.
+        sig do
+          returns(T.nilable(T::Array[Telnyx::AI::Collections::SourceRequest]))
+        end
+        attr_reader :sources
+
+        sig do
+          params(
+            sources: T::Array[Telnyx::AI::Collections::SourceRequest::OrHash]
+          ).void
+        end
+        attr_writer :sources
+
+        sig do
+          params(
+            name: String,
+            description: String,
+            settings: Telnyx::AI::Collections::RetrievalSettingsWrapper::OrHash,
+            slug: String,
+            sources: T::Array[Telnyx::AI::Collections::SourceRequest::OrHash],
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Human-readable collection name.
+          name:,
+          # Optional description.
+          description: nil,
+          # Optional retrieval settings.
+          settings: nil,
+          # Optional slug (unique per organization). Derived from `name` when omitted.
+          slug: nil,
+          # Optional sources to attach at creation time.
+          sources: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              name: String,
+              description: String,
+              settings: Telnyx::AI::Collections::RetrievalSettingsWrapper,
+              slug: String,
+              sources: T::Array[Telnyx::AI::Collections::SourceRequest],
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/collection_delete_params.rbi

@@ -0,0 +1,37 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class CollectionDeleteParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::AI::CollectionDeleteParams, Telnyx::Internal::AnyHash)
+          end
+
+        sig { returns(String) }
+        attr_accessor :uuid
+
+        sig do
+          params(
+            uuid: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(uuid:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            { uuid: String, request_options: Telnyx::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/collection_envelope.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class CollectionEnvelope < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::AI::CollectionEnvelope, Telnyx::Internal::AnyHash)
+          end
+
+        sig { returns(T.nilable(Telnyx::AI::Collection)) }
+        attr_reader :data
+
+        sig { params(data: Telnyx::AI::Collection::OrHash).void }
+        attr_writer :data
+
+        sig do
+          params(data: Telnyx::AI::Collection::OrHash).returns(T.attached_class)
+        end
+        def self.new(data: nil)
+        end
+
+        sig { override.returns({ data: Telnyx::AI::Collection }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/collection_list_params.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class CollectionListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::AI::CollectionListParams, Telnyx::Internal::AnyHash)
+          end
+
+        # Page number to return (1-based). Defaults to 1.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_number
+
+        sig { params(page_number: Integer).void }
+        attr_writer :page_number
+
+        # Number of results per page. Defaults to 20.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_size
+
+        sig { params(page_size: Integer).void }
+        attr_writer :page_size
+
+        sig do
+          params(
+            page_number: Integer,
+            page_size: Integer,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Page number to return (1-based). Defaults to 1.
+          page_number: nil,
+          # Number of results per page. Defaults to 20.
+          page_size: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              page_number: Integer,
+              page_size: Integer,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/collection_retrieve_by_id_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class CollectionRetrieveByIDParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::AI::CollectionRetrieveByIDParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :uuid
+
+        sig do
+          params(
+            uuid: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(uuid:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            { uuid: String, request_options: Telnyx::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end