telnyx 5.63.0 → 5.65.0

data/rbi/telnyx/models/ai/inference_embedding_webhook_tool_params.rbi

@@ -221,6 +221,30 @@ module Telnyx
           end
           attr_writer :query_parameters
 
+          # A list of mappings that extract values from the webhook response and store them
+          # as dynamic variables. Each mapping specifies a dynamic variable name and a
+          # dot-notation path to the value in the response body.
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  Telnyx::AI::InferenceEmbeddingWebhookToolParams::Webhook::StoreFieldsAsVariable
+                ]
+              )
+            )
+          end
+          attr_reader :store_fields_as_variables
+
+          sig do
+            params(
+              store_fields_as_variables:
+                T::Array[
+                  Telnyx::AI::InferenceEmbeddingWebhookToolParams::Webhook::StoreFieldsAsVariable::OrHash
+                ]
+            ).void
+          end
+          attr_writer :store_fields_as_variables
+
           # The maximum number of milliseconds to wait for the webhook to respond. Only
           # applicable when async is false.
           sig { returns(T.nilable(Integer)) }
@@ -247,6 +271,10 @@ module Telnyx
                 Telnyx::AI::InferenceEmbeddingWebhookToolParams::Webhook::PathParameters::OrHash,
               query_parameters:
                 Telnyx::AI::InferenceEmbeddingWebhookToolParams::Webhook::QueryParameters::OrHash,
+              store_fields_as_variables:
+                T::Array[
+                  Telnyx::AI::InferenceEmbeddingWebhookToolParams::Webhook::StoreFieldsAsVariable::OrHash
+                ],
               timeout_ms: Integer
             ).returns(T.attached_class)
           end
@@ -284,6 +312,10 @@ module Telnyx
             # [JSON Schema reference](https://json-schema.org/understanding-json-schema) for
             # documentation about the format
             query_parameters: nil,
+            # A list of mappings that extract values from the webhook response and store them
+            # as dynamic variables. Each mapping specifies a dynamic variable name and a
+            # dot-notation path to the value in the response body.
+            store_fields_as_variables: nil,
             # The maximum number of milliseconds to wait for the webhook to respond. Only
             # applicable when async is false.
             timeout_ms: nil
@@ -309,6 +341,10 @@ module Telnyx
                   Telnyx::AI::InferenceEmbeddingWebhookToolParams::Webhook::PathParameters,
                 query_parameters:
                   Telnyx::AI::InferenceEmbeddingWebhookToolParams::Webhook::QueryParameters,
+                store_fields_as_variables:
+                  T::Array[
+                    Telnyx::AI::InferenceEmbeddingWebhookToolParams::Webhook::StoreFieldsAsVariable
+                  ],
                 timeout_ms: Integer
               }
             )
@@ -726,6 +762,41 @@ module Telnyx
               end
             end
           end
+
+          class StoreFieldsAsVariable < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::AI::InferenceEmbeddingWebhookToolParams::Webhook::StoreFieldsAsVariable,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # The name of the dynamic variable to store the extracted value in.
+            sig { returns(String) }
+            attr_accessor :name
+
+            # A dot-notation path to the value in the webhook response body (e.g.
+            # 'customer.name' or 'id').
+            sig { returns(String) }
+            attr_accessor :value_path
+
+            sig do
+              params(name: String, value_path: String).returns(T.attached_class)
+            end
+            def self.new(
+              # The name of the dynamic variable to store the extracted value in.
+              name:,
+              # A dot-notation path to the value in the webhook response body (e.g.
+              # 'customer.name' or 'id').
+              value_path:
+            )
+            end
+
+            sig { override.returns({ name: String, value_path: String }) }
+            def to_hash
+            end
+          end
         end
       end
     end

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

@@ -0,0 +1,103 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class ToolCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::AI::ToolCreateParams, Telnyx::Internal::AnyHash)
+          end
+
+        sig { returns(String) }
+        attr_accessor :display_name
+
+        sig { returns(String) }
+        attr_accessor :type
+
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :function
+
+        sig { params(function: T::Hash[Symbol, T.anything]).void }
+        attr_writer :function
+
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :handoff
+
+        sig { params(handoff: T::Hash[Symbol, T.anything]).void }
+        attr_writer :handoff
+
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :invite
+
+        sig { params(invite: T::Hash[Symbol, T.anything]).void }
+        attr_writer :invite
+
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :retrieval
+
+        sig { params(retrieval: T::Hash[Symbol, T.anything]).void }
+        attr_writer :retrieval
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :timeout_ms
+
+        sig { params(timeout_ms: Integer).void }
+        attr_writer :timeout_ms
+
+        sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+        attr_reader :webhook
+
+        sig { params(webhook: T::Hash[Symbol, T.anything]).void }
+        attr_writer :webhook
+
+        sig do
+          params(
+            display_name: String,
+            type: String,
+            function: T::Hash[Symbol, T.anything],
+            handoff: T::Hash[Symbol, T.anything],
+            invite: T::Hash[Symbol, T.anything],
+            retrieval: T::Hash[Symbol, T.anything],
+            timeout_ms: Integer,
+            webhook: T::Hash[Symbol, T.anything],
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          display_name:,
+          type:,
+          function: nil,
+          handoff: nil,
+          invite: nil,
+          retrieval: nil,
+          timeout_ms: nil,
+          webhook: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              display_name: String,
+              type: String,
+              function: T::Hash[Symbol, T.anything],
+              handoff: T::Hash[Symbol, T.anything],
+              invite: T::Hash[Symbol, T.anything],
+              retrieval: T::Hash[Symbol, T.anything],
+              timeout_ms: Integer,
+              webhook: T::Hash[Symbol, T.anything],
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/tool_create_response.rbi

@@ -0,0 +1,79 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class ToolCreateResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::AI::ToolCreateResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(T::Hash[Symbol, T.anything]) }
+        attr_accessor :tool_definition
+
+        sig { returns(String) }
+        attr_accessor :type
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :created_at
+
+        sig { params(created_at: String).void }
+        attr_writer :created_at
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :display_name
+
+        sig { params(display_name: String).void }
+        attr_writer :display_name
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :timeout_ms
+
+        sig { params(timeout_ms: Integer).void }
+        attr_writer :timeout_ms
+
+        sig do
+          params(
+            id: String,
+            tool_definition: T::Hash[Symbol, T.anything],
+            type: String,
+            created_at: String,
+            display_name: String,
+            timeout_ms: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          tool_definition:,
+          type:,
+          created_at: nil,
+          display_name: nil,
+          timeout_ms: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              tool_definition: T::Hash[Symbol, T.anything],
+              type: String,
+              created_at: String,
+              display_name: String,
+              timeout_ms: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/tool_delete_params.rbi

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

data/rbi/telnyx/models/ai/tool_delete_response.rbi

@@ -0,0 +1,9 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      ToolDeleteResponse = T.let(T.anything, Telnyx::Internal::Type::Converter)
+    end
+  end
+end

data/rbi/telnyx/models/ai/tool_list_params.rbi

@@ -0,0 +1,73 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class ToolListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::AI::ToolListParams, Telnyx::Internal::AnyHash)
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :filter_name
+
+        sig { params(filter_name: String).void }
+        attr_writer :filter_name
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :filter_type
+
+        sig { params(filter_type: String).void }
+        attr_writer :filter_type
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_number
+
+        sig { params(page_number: Integer).void }
+        attr_writer :page_number
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_size
+
+        sig { params(page_size: Integer).void }
+        attr_writer :page_size
+
+        sig do
+          params(
+            filter_name: String,
+            filter_type: String,
+            page_number: Integer,
+            page_size: Integer,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          filter_name: nil,
+          filter_type: nil,
+          page_number: nil,
+          page_size: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              filter_name: String,
+              filter_type: String,
+              page_number: Integer,
+              page_size: Integer,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/tool_list_response.rbi

@@ -0,0 +1,79 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class ToolListResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::AI::ToolListResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(T::Hash[Symbol, T.anything]) }
+        attr_accessor :tool_definition
+
+        sig { returns(String) }
+        attr_accessor :type
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :created_at
+
+        sig { params(created_at: String).void }
+        attr_writer :created_at
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :display_name
+
+        sig { params(display_name: String).void }
+        attr_writer :display_name
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :timeout_ms
+
+        sig { params(timeout_ms: Integer).void }
+        attr_writer :timeout_ms
+
+        sig do
+          params(
+            id: String,
+            tool_definition: T::Hash[Symbol, T.anything],
+            type: String,
+            created_at: String,
+            display_name: String,
+            timeout_ms: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          tool_definition:,
+          type:,
+          created_at: nil,
+          display_name: nil,
+          timeout_ms: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              tool_definition: T::Hash[Symbol, T.anything],
+              type: String,
+              created_at: String,
+              display_name: String,
+              timeout_ms: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/tool_retrieve_params.rbi

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

data/rbi/telnyx/models/ai/tool_retrieve_response.rbi

@@ -0,0 +1,79 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class ToolRetrieveResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::AI::ToolRetrieveResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(T::Hash[Symbol, T.anything]) }
+        attr_accessor :tool_definition
+
+        sig { returns(String) }
+        attr_accessor :type
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :created_at
+
+        sig { params(created_at: String).void }
+        attr_writer :created_at
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :display_name
+
+        sig { params(display_name: String).void }
+        attr_writer :display_name
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :timeout_ms
+
+        sig { params(timeout_ms: Integer).void }
+        attr_writer :timeout_ms
+
+        sig do
+          params(
+            id: String,
+            tool_definition: T::Hash[Symbol, T.anything],
+            type: String,
+            created_at: String,
+            display_name: String,
+            timeout_ms: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          tool_definition:,
+          type:,
+          created_at: nil,
+          display_name: nil,
+          timeout_ms: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              tool_definition: T::Hash[Symbol, T.anything],
+              type: String,
+              created_at: String,
+              display_name: String,
+              timeout_ms: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end