telnyx 5.0.0 → 5.1.0

data/lib/telnyx/models/ai/inference_embedding_webhook_tool_params.rb

@@ -1,265 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    module AI
-      class InferenceEmbeddingWebhookToolParams < Telnyx::Internal::Type::BaseModel
-        # @!attribute description
-        #   The description of the tool.
-        #
-        #   @return [String]
-        required :description, String
-
-        # @!attribute name
-        #   The name of the tool.
-        #
-        #   @return [String]
-        required :name, String
-
-        # @!attribute url
-        #   The URL of the external tool to be called. This URL is going to be used by the
-        #   assistant. The URL can be templated like: `https://example.com/api/v1/{id}`,
-        #   where `{id}` is a placeholder for a value that will be provided by the assistant
-        #   if `path_parameters` are provided with the `id` attribute.
-        #
-        #   @return [String]
-        required :url, String
-
-        # @!attribute body_parameters
-        #   The body parameters the webhook tool accepts, described as a JSON Schema object.
-        #   These parameters will be passed to the webhook as the body of the request. See
-        #   the [JSON Schema reference](https://json-schema.org/understanding-json-schema)
-        #   for documentation about the format
-        #
-        #   @return [Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::BodyParameters, nil]
-        optional :body_parameters, -> { Telnyx::AI::InferenceEmbeddingWebhookToolParams::BodyParameters }
-
-        # @!attribute headers
-        #   The headers to be sent to the external tool.
-        #
-        #   @return [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::Header>, nil]
-        optional :headers,
-                 -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::InferenceEmbeddingWebhookToolParams::Header] }
-
-        # @!attribute http_method
-        #   The HTTP method to be used when calling the external tool.
-        #
-        #   @return [Symbol, Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::Method, nil]
-        optional :http_method,
-                 enum: -> { Telnyx::AI::InferenceEmbeddingWebhookToolParams::Method },
-                 api_name: :method
-
-        # @!attribute path_parameters
-        #   The path parameters the webhook tool accepts, described as a JSON Schema object.
-        #   These parameters will be passed to the webhook as the path of the request if the
-        #   URL contains a placeholder for a value. See the
-        #   [JSON Schema reference](https://json-schema.org/understanding-json-schema) for
-        #   documentation about the format
-        #
-        #   @return [Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::PathParameters, nil]
-        optional :path_parameters, -> { Telnyx::AI::InferenceEmbeddingWebhookToolParams::PathParameters }
-
-        # @!attribute query_parameters
-        #   The query parameters the webhook tool accepts, described as a JSON Schema
-        #   object. These parameters will be passed to the webhook as the query of the
-        #   request. See the
-        #   [JSON Schema reference](https://json-schema.org/understanding-json-schema) for
-        #   documentation about the format
-        #
-        #   @return [Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::QueryParameters, nil]
-        optional :query_parameters, -> { Telnyx::AI::InferenceEmbeddingWebhookToolParams::QueryParameters }
-
-        # @!method initialize(description:, name:, url:, body_parameters: nil, headers: nil, http_method: nil, path_parameters: nil, query_parameters: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams} for more details.
-        #
-        #   @param description [String] The description of the tool.
-        #
-        #   @param name [String] The name of the tool.
-        #
-        #   @param url [String] The URL of the external tool to be called. This URL is going to be used by the a
-        #
-        #   @param body_parameters [Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::BodyParameters] The body parameters the webhook tool accepts, described as a JSON Schema object.
-        #
-        #   @param headers [Array<Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::Header>] The headers to be sent to the external tool.
-        #
-        #   @param http_method [Symbol, Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::Method] The HTTP method to be used when calling the external tool.
-        #
-        #   @param path_parameters [Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::PathParameters] The path parameters the webhook tool accepts, described as a JSON Schema object.
-        #
-        #   @param query_parameters [Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::QueryParameters] The query parameters the webhook tool accepts, described as a JSON Schema object
-
-        # @see Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams#body_parameters
-        class BodyParameters < Telnyx::Internal::Type::BaseModel
-          # @!attribute properties
-          #   The properties of the body parameters.
-          #
-          #   @return [Hash{Symbol=>Object}, nil]
-          optional :properties, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
-
-          # @!attribute required
-          #   The required properties of the body parameters.
-          #
-          #   @return [Array<String>, nil]
-          optional :required, Telnyx::Internal::Type::ArrayOf[String]
-
-          # @!attribute type
-          #
-          #   @return [Symbol, Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::BodyParameters::Type, nil]
-          optional :type, enum: -> { Telnyx::AI::InferenceEmbeddingWebhookToolParams::BodyParameters::Type }
-
-          # @!method initialize(properties: nil, required: nil, type: nil)
-          #   The body parameters the webhook tool accepts, described as a JSON Schema object.
-          #   These parameters will be passed to the webhook as the body of the request. See
-          #   the [JSON Schema reference](https://json-schema.org/understanding-json-schema)
-          #   for documentation about the format
-          #
-          #   @param properties [Hash{Symbol=>Object}] The properties of the body parameters.
-          #
-          #   @param required [Array<String>] The required properties of the body parameters.
-          #
-          #   @param type [Symbol, Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::BodyParameters::Type]
-
-          # @see Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::BodyParameters#type
-          module Type
-            extend Telnyx::Internal::Type::Enum
-
-            OBJECT = :object
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-        end
-
-        class Header < Telnyx::Internal::Type::BaseModel
-          # @!attribute name
-          #
-          #   @return [String, nil]
-          optional :name, String
-
-          # @!attribute value
-          #   The value of the header. Note that we support mustache templating for the value.
-          #   For example you can use
-          #   `Bearer {{#integration_secret}}test-secret{{/integration_secret}}` to pass the
-          #   value of the integration secret as the bearer token.
-          #   [Telnyx signature headers](https://developers.telnyx.com/docs/voice/programmable-voice/voice-api-webhooks)
-          #   will be automatically added to the request.
-          #
-          #   @return [String, nil]
-          optional :value, String
-
-          # @!method initialize(name: nil, value: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::Header} for more
-          #   details.
-          #
-          #   @param name [String]
-          #
-          #   @param value [String] The value of the header. Note that we support mustache templating for the value.
-        end
-
-        # The HTTP method to be used when calling the external tool.
-        #
-        # @see Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams#http_method
-        module Method
-          extend Telnyx::Internal::Type::Enum
-
-          GET = :GET
-          POST = :POST
-          PUT = :PUT
-          DELETE = :DELETE
-          PATCH = :PATCH
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # @see Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams#path_parameters
-        class PathParameters < Telnyx::Internal::Type::BaseModel
-          # @!attribute properties
-          #   The properties of the path parameters.
-          #
-          #   @return [Hash{Symbol=>Object}, nil]
-          optional :properties, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
-
-          # @!attribute required
-          #   The required properties of the path parameters.
-          #
-          #   @return [Array<String>, nil]
-          optional :required, Telnyx::Internal::Type::ArrayOf[String]
-
-          # @!attribute type
-          #
-          #   @return [Symbol, Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::PathParameters::Type, nil]
-          optional :type, enum: -> { Telnyx::AI::InferenceEmbeddingWebhookToolParams::PathParameters::Type }
-
-          # @!method initialize(properties: nil, required: nil, type: nil)
-          #   The path parameters the webhook tool accepts, described as a JSON Schema object.
-          #   These parameters will be passed to the webhook as the path of the request if the
-          #   URL contains a placeholder for a value. See the
-          #   [JSON Schema reference](https://json-schema.org/understanding-json-schema) for
-          #   documentation about the format
-          #
-          #   @param properties [Hash{Symbol=>Object}] The properties of the path parameters.
-          #
-          #   @param required [Array<String>] The required properties of the path parameters.
-          #
-          #   @param type [Symbol, Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::PathParameters::Type]
-
-          # @see Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::PathParameters#type
-          module Type
-            extend Telnyx::Internal::Type::Enum
-
-            OBJECT = :object
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-        end
-
-        # @see Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams#query_parameters
-        class QueryParameters < Telnyx::Internal::Type::BaseModel
-          # @!attribute properties
-          #   The properties of the query parameters.
-          #
-          #   @return [Hash{Symbol=>Object}, nil]
-          optional :properties, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
-
-          # @!attribute required
-          #   The required properties of the query parameters.
-          #
-          #   @return [Array<String>, nil]
-          optional :required, Telnyx::Internal::Type::ArrayOf[String]
-
-          # @!attribute type
-          #
-          #   @return [Symbol, Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::QueryParameters::Type, nil]
-          optional :type, enum: -> { Telnyx::AI::InferenceEmbeddingWebhookToolParams::QueryParameters::Type }
-
-          # @!method initialize(properties: nil, required: nil, type: nil)
-          #   The query parameters the webhook tool accepts, described as a JSON Schema
-          #   object. These parameters will be passed to the webhook as the query of the
-          #   request. See the
-          #   [JSON Schema reference](https://json-schema.org/understanding-json-schema) for
-          #   documentation about the format
-          #
-          #   @param properties [Hash{Symbol=>Object}] The properties of the query parameters.
-          #
-          #   @param required [Array<String>] The required properties of the query parameters.
-          #
-          #   @param type [Symbol, Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::QueryParameters::Type]
-
-          # @see Telnyx::Models::AI::InferenceEmbeddingWebhookToolParams::QueryParameters#type
-          module Type
-            extend Telnyx::Internal::Type::Enum
-
-            OBJECT = :object
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-        end
-      end
-    end
-  end
-end

data/lib/telnyx/models/streaming_failed_webhook_event.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    class StreamingFailedWebhookEvent < Telnyx::Internal::Type::BaseModel
-      # @!attribute data
-      #
-      #   @return [Telnyx::Models::CallStreamingFailed, nil]
-      optional :data, -> { Telnyx::CallStreamingFailed }
-
-      # @!method initialize(data: nil)
-      #   @param data [Telnyx::Models::CallStreamingFailed]
-    end
-  end
-end

data/lib/telnyx/models/streaming_started_webhook_event.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    class StreamingStartedWebhookEvent < Telnyx::Internal::Type::BaseModel
-      # @!attribute data
-      #
-      #   @return [Telnyx::Models::CallStreamingStarted, nil]
-      optional :data, -> { Telnyx::CallStreamingStarted }
-
-      # @!method initialize(data: nil)
-      #   @param data [Telnyx::Models::CallStreamingStarted]
-    end
-  end
-end

data/lib/telnyx/models/streaming_stopped_webhook_event.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Telnyx
-  module Models
-    class StreamingStoppedWebhookEvent < Telnyx::Internal::Type::BaseModel
-      # @!attribute data
-      #
-      #   @return [Telnyx::Models::CallStreamingStopped, nil]
-      optional :data, -> { Telnyx::CallStreamingStopped }
-
-      # @!method initialize(data: nil)
-      #   @param data [Telnyx::Models::CallStreamingStopped]
-    end
-  end
-end

data/rbi/telnyx/models/ai/inference_embedding_bucket_ids.rbi

@@ -1,54 +0,0 @@
-# typed: strong
-
-module Telnyx
-  module Models
-    module AI
-      class InferenceEmbeddingBucketIDs < Telnyx::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Telnyx::AI::InferenceEmbeddingBucketIDs,
-              Telnyx::Internal::AnyHash
-            )
-          end
-
-        # List of
-        # [embedded storage buckets](https://developers.telnyx.com/api/inference/inference-embedding/post-embedding)
-        # to use for retrieval-augmented generation.
-        sig { returns(T::Array[String]) }
-        attr_accessor :bucket_ids
-
-        # The maximum number of results to retrieve as context for the language model.
-        sig { returns(T.nilable(Integer)) }
-        attr_reader :max_num_results
-
-        sig { params(max_num_results: Integer).void }
-        attr_writer :max_num_results
-
-        sig do
-          params(
-            bucket_ids: T::Array[String],
-            max_num_results: Integer
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # List of
-          # [embedded storage buckets](https://developers.telnyx.com/api/inference/inference-embedding/post-embedding)
-          # to use for retrieval-augmented generation.
-          bucket_ids:,
-          # The maximum number of results to retrieve as context for the language model.
-          max_num_results: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            { bucket_ids: T::Array[String], max_num_results: Integer }
-          )
-        end
-        def to_hash
-        end
-      end
-    end
-  end
-end

data/rbi/telnyx/models/ai/inference_embedding_transfer_tool_params.rbi

@@ -1,185 +0,0 @@
-# typed: strong
-
-module Telnyx
-  module Models
-    module AI
-      class InferenceEmbeddingTransferToolParams < Telnyx::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Telnyx::AI::InferenceEmbeddingTransferToolParams,
-              Telnyx::Internal::AnyHash
-            )
-          end
-
-        # Number or SIP URI placing the call.
-        sig { returns(String) }
-        attr_accessor :from
-
-        # The different possible targets of the transfer. The assistant will be able to
-        # choose one of the targets to transfer the call to.
-        sig do
-          returns(
-            T::Array[Telnyx::AI::InferenceEmbeddingTransferToolParams::Target]
-          )
-        end
-        attr_accessor :targets
-
-        # Custom headers to be added to the SIP INVITE for the transfer command.
-        sig do
-          returns(
-            T.nilable(
-              T::Array[
-                Telnyx::AI::InferenceEmbeddingTransferToolParams::CustomHeader
-              ]
-            )
-          )
-        end
-        attr_reader :custom_headers
-
-        sig do
-          params(
-            custom_headers:
-              T::Array[
-                Telnyx::AI::InferenceEmbeddingTransferToolParams::CustomHeader::OrHash
-              ]
-          ).void
-        end
-        attr_writer :custom_headers
-
-        # Natural language instructions for your agent for how to provide context for the
-        # transfer recipient.
-        sig { returns(T.nilable(String)) }
-        attr_reader :warm_transfer_instructions
-
-        sig { params(warm_transfer_instructions: String).void }
-        attr_writer :warm_transfer_instructions
-
-        sig do
-          params(
-            from: String,
-            targets:
-              T::Array[
-                Telnyx::AI::InferenceEmbeddingTransferToolParams::Target::OrHash
-              ],
-            custom_headers:
-              T::Array[
-                Telnyx::AI::InferenceEmbeddingTransferToolParams::CustomHeader::OrHash
-              ],
-            warm_transfer_instructions: String
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # Number or SIP URI placing the call.
-          from:,
-          # The different possible targets of the transfer. The assistant will be able to
-          # choose one of the targets to transfer the call to.
-          targets:,
-          # Custom headers to be added to the SIP INVITE for the transfer command.
-          custom_headers: nil,
-          # Natural language instructions for your agent for how to provide context for the
-          # transfer recipient.
-          warm_transfer_instructions: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              from: String,
-              targets:
-                T::Array[
-                  Telnyx::AI::InferenceEmbeddingTransferToolParams::Target
-                ],
-              custom_headers:
-                T::Array[
-                  Telnyx::AI::InferenceEmbeddingTransferToolParams::CustomHeader
-                ],
-              warm_transfer_instructions: String
-            }
-          )
-        end
-        def to_hash
-        end
-
-        class Target < Telnyx::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Telnyx::AI::InferenceEmbeddingTransferToolParams::Target,
-                Telnyx::Internal::AnyHash
-              )
-            end
-
-          # The name of the target.
-          sig { returns(T.nilable(String)) }
-          attr_reader :name
-
-          sig { params(name: String).void }
-          attr_writer :name
-
-          # The destination number or SIP URI of the call.
-          sig { returns(T.nilable(String)) }
-          attr_reader :to
-
-          sig { params(to: String).void }
-          attr_writer :to
-
-          sig { params(name: String, to: String).returns(T.attached_class) }
-          def self.new(
-            # The name of the target.
-            name: nil,
-            # The destination number or SIP URI of the call.
-            to: nil
-          )
-          end
-
-          sig { override.returns({ name: String, to: String }) }
-          def to_hash
-          end
-        end
-
-        class CustomHeader < Telnyx::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Telnyx::AI::InferenceEmbeddingTransferToolParams::CustomHeader,
-                Telnyx::Internal::AnyHash
-              )
-            end
-
-          sig { returns(T.nilable(String)) }
-          attr_reader :name
-
-          sig { params(name: String).void }
-          attr_writer :name
-
-          # The value of the header. Note that we support mustache templating for the value.
-          # For example you can use
-          # `{{#integration_secret}}test-secret{{/integration_secret}}` to pass the value of
-          # the integration secret.
-          sig { returns(T.nilable(String)) }
-          attr_reader :value
-
-          sig { params(value: String).void }
-          attr_writer :value
-
-          sig { params(name: String, value: String).returns(T.attached_class) }
-          def self.new(
-            name: nil,
-            # The value of the header. Note that we support mustache templating for the value.
-            # For example you can use
-            # `{{#integration_secret}}test-secret{{/integration_secret}}` to pass the value of
-            # the integration secret.
-            value: nil
-          )
-          end
-
-          sig { override.returns({ name: String, value: String }) }
-          def to_hash
-          end
-        end
-      end
-    end
-  end
-end