telnyx 5.99.0 → 5.101.0

data/lib/telnyx/models/uac_connections/action_check_registration_status_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module UacConnections
+      # @see Telnyx::Resources::UacConnections::Actions#check_registration_status
+      class ActionCheckRegistrationStatusParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:, request_options: {})
+        #   @param id [String]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/uac_connections/action_check_registration_status_response.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module UacConnections
+      # @see Telnyx::Resources::UacConnections::Actions#check_registration_status
+      class ActionCheckRegistrationStatusResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data, nil]
+        optional :data, -> { Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data }
+
+        # @!method initialize(data: nil)
+        #   @param data [Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data]
+
+        # @see Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse#data
+        class Data < Telnyx::Internal::Type::BaseModel
+          # @!attribute ip_address
+          #   The ip used during the SIP connection
+          #
+          #   @return [String, nil]
+          optional :ip_address, String
+
+          # @!attribute last_registration
+          #   ISO 8601 formatted date indicating when the resource was last updated.
+          #
+          #   @return [String, nil]
+          optional :last_registration, String
+
+          # @!attribute port
+          #   The port of the SIP connection
+          #
+          #   @return [Integer, nil]
+          optional :port, Integer
+
+          # @!attribute record_type
+          #   Identifies the type of the resource.
+          #
+          #   @return [String, nil]
+          optional :record_type, String
+
+          # @!attribute sip_username
+          #   The user name of the SIP connection
+          #
+          #   @return [String, nil]
+          optional :sip_username, String
+
+          # @!attribute status
+          #   The current registration status of your SIP connection
+          #
+          #   @return [Symbol, Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status, nil]
+          optional :status,
+                   enum: -> { Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status }
+
+          # @!attribute transport
+          #   The protocol of the SIP connection
+          #
+          #   @return [String, nil]
+          optional :transport, String
+
+          # @!attribute user_agent
+          #   The user agent of the SIP connection
+          #
+          #   @return [String, nil]
+          optional :user_agent, String
+
+          # @!method initialize(ip_address: nil, last_registration: nil, port: nil, record_type: nil, sip_username: nil, status: nil, transport: nil, user_agent: nil)
+          #   @param ip_address [String] The ip used during the SIP connection
+          #
+          #   @param last_registration [String] ISO 8601 formatted date indicating when the resource was last updated.
+          #
+          #   @param port [Integer] The port of the SIP connection
+          #
+          #   @param record_type [String] Identifies the type of the resource.
+          #
+          #   @param sip_username [String] The user name of the SIP connection
+          #
+          #   @param status [Symbol, Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status] The current registration status of your SIP connection
+          #
+          #   @param transport [String] The protocol of the SIP connection
+          #
+          #   @param user_agent [String] The user agent of the SIP connection
+
+          # The current registration status of your SIP connection
+          #
+          # @see Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data#status
+          module Status
+            extend Telnyx::Internal::Type::Enum
+
+            NOT_APPLICABLE = :"Not Applicable"
+            NOT_REGISTERED = :"Not Registered"
+            FAILED = :Failed
+            EXPIRED = :Expired
+            REGISTERED = :Registered
+            UNREGISTERED = :Unregistered
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models.rb

@@ -1626,6 +1626,18 @@ module Telnyx
 
   TransportProtocol = Telnyx::Models::TransportProtocol
 
+  UacConnectionCreateParams = Telnyx::Models::UacConnectionCreateParams
+
+  UacConnectionDeleteParams = Telnyx::Models::UacConnectionDeleteParams
+
+  UacConnectionListParams = Telnyx::Models::UacConnectionListParams
+
+  UacConnectionRetrieveParams = Telnyx::Models::UacConnectionRetrieveParams
+
+  UacConnections = Telnyx::Models::UacConnections
+
+  UacConnectionUpdateParams = Telnyx::Models::UacConnectionUpdateParams
+
   UnsafeUnwrapWebhookEvent = Telnyx::Models::UnsafeUnwrapWebhookEvent
 
   UnwrapWebhookEvent = Telnyx::Models::UnwrapWebhookEvent

data/lib/telnyx/resources/ai/assistants/canary_deploys.rb

@@ -11,18 +11,16 @@ module Telnyx
           # Creates a new canary deploy configuration with multiple version IDs and their
           # traffic percentages for A/B testing or gradual rollouts of assistant versions.
           #
-          # @overload create(assistant_id, versions:, request_options: {})
+          # @overload create(assistant_id, rules: nil, request_options: {})
           #
           # @param assistant_id [String]
-          #
-          # @param versions [Array<Telnyx::Models::AI::Assistants::VersionConfig>] List of version configurations
-          #
+          # @param rules [Array<Telnyx::Models::AI::Assistants::CanaryDeploy::Rule>]
           # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
           #
           # @return [Telnyx::Models::AI::Assistants::CanaryDeployResponse]
           #
           # @see Telnyx::Models::AI::Assistants::CanaryDeployCreateParams
-          def create(assistant_id, params)
+          def create(assistant_id, params = {})
             parsed, options = Telnyx::AI::Assistants::CanaryDeployCreateParams.dump_request(params)
             @client.request(
               method: :post,
@@ -61,18 +59,16 @@ module Telnyx
           # percentages. All old versions and percentages are replaces by new ones from this
           # request.
           #
-          # @overload update(assistant_id, versions:, request_options: {})
+          # @overload update(assistant_id, rules: nil, request_options: {})
           #
           # @param assistant_id [String]
-          #
-          # @param versions [Array<Telnyx::Models::AI::Assistants::VersionConfig>] List of version configurations
-          #
+          # @param rules [Array<Telnyx::Models::AI::Assistants::CanaryDeploy::Rule>]
           # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
           #
           # @return [Telnyx::Models::AI::Assistants::CanaryDeployResponse]
           #
           # @see Telnyx::Models::AI::Assistants::CanaryDeployUpdateParams
-          def update(assistant_id, params)
+          def update(assistant_id, params = {})
             parsed, options = Telnyx::AI::Assistants::CanaryDeployUpdateParams.dump_request(params)
             @client.request(
               method: :put,

data/lib/telnyx/resources/ai/chat.rb

@@ -5,14 +5,17 @@ module Telnyx
     class AI
       # Generate text with LLMs
       class Chat
+        # @deprecated
+        #
         # Some parameter documentations has been truncated, see
         # {Telnyx::Models::AI::ChatCreateCompletionParams} for more details.
         #
-        # Chat with a language model. This endpoint is consistent with the
+        # **Deprecated**: Use `POST /v2/ai/openai/chat/completions` instead. Chat with a
+        # language model. This endpoint is consistent with the
         # [OpenAI Chat Completions API](https://platform.openai.com/docs/api-reference/chat)
         # and may be used with the OpenAI JS or Python SDK.
         #
-        # @overload create_completion(messages:, api_key_ref: nil, best_of: nil, early_stopping: nil, enable_thinking: nil, frequency_penalty: nil, guided_choice: nil, guided_json: nil, guided_regex: nil, length_penalty: nil, logprobs: nil, max_tokens: nil, min_p: nil, model: nil, n: nil, presence_penalty: nil, response_format: nil, stream: nil, temperature: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, use_beam_search: nil, request_options: {})
+        # @overload create_completion(messages:, api_key_ref: nil, best_of: nil, early_stopping: nil, enable_thinking: nil, frequency_penalty: nil, guided_choice: nil, guided_json: nil, guided_regex: nil, length_penalty: nil, logprobs: nil, max_tokens: nil, min_p: nil, model: nil, n: nil, presence_penalty: nil, response_format: nil, seed: nil, stop: nil, stream: nil, temperature: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, use_beam_search: nil, request_options: {})
         #
         # @param messages [Array<Telnyx::Models::AI::ChatCreateCompletionParams::Message>] A list of the previous chat messages for context.
         #
@@ -48,6 +51,10 @@ module Telnyx
         #
         # @param response_format [Telnyx::Models::AI::ChatCreateCompletionParams::ResponseFormat] Use this is you want to guarantee a JSON output without defining a schema. For c
         #
+        # @param seed [Integer] If specified, the system will make a best effort to sample deterministically, su
+        #
+        # @param stop [String, Array<String>] Up to 4 sequences where the API will stop generating further tokens. The returne
+        #
         # @param stream [Boolean] Whether or not to stream data-only server-sent events as they become available.
         #
         # @param temperature [Float] Adjusts the "creativity" of the model. Lower values make the model more determin

data/lib/telnyx/resources/ai/openai/chat.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class AI
+      class OpenAI
+        class Chat
+          # Some parameter documentations has been truncated, see
+          # {Telnyx::Models::AI::OpenAI::ChatCreateCompletionParams} for more details.
+          #
+          # Chat with a language model. This endpoint is consistent with the
+          # [OpenAI Chat Completions API](https://platform.openai.com/docs/api-reference/chat)
+          # and may be used with the OpenAI JS or Python SDK by setting the base URL to
+          # `https://api.telnyx.com/v2/ai/openai`.
+          #
+          # @overload create_completion(messages:, api_key_ref: nil, best_of: nil, early_stopping: nil, enable_thinking: nil, frequency_penalty: nil, guided_choice: nil, guided_json: nil, guided_regex: nil, length_penalty: nil, logprobs: nil, max_tokens: nil, min_p: nil, model: nil, n: nil, presence_penalty: nil, response_format: nil, seed: nil, stop: nil, stream: nil, temperature: nil, tool_choice: nil, tools: nil, top_logprobs: nil, top_p: nil, use_beam_search: nil, request_options: {})
+          #
+          # @param messages [Array<Telnyx::Models::AI::OpenAI::ChatCreateCompletionParams::Message>] A list of the previous chat messages for context.
+          #
+          # @param api_key_ref [String] If you are using an external inference provider like xAI or OpenAI, this field a
+          #
+          # @param best_of [Integer] This is used with `use_beam_search` to determine how many candidate beams to exp
+          #
+          # @param early_stopping [Boolean] This is used with `use_beam_search`. If `true`, generation stops as soon as ther
+          #
+          # @param enable_thinking [Boolean] Whether to enable the thinking/reasoning phase for models that support it (e.g.,
+          #
+          # @param frequency_penalty [Float] Higher values will penalize the model from repeating the same output tokens.
+          #
+          # @param guided_choice [Array<String>] If specified, the output will be exactly one of the choices.
+          #
+          # @param guided_json [Hash{Symbol=>Object}] Must be a valid JSON schema. If specified, the output will follow the JSON schem
+          #
+          # @param guided_regex [String] If specified, the output will follow the regex pattern.
+          #
+          # @param length_penalty [Float] This is used with `use_beam_search` to prefer shorter or longer completions.
+          #
+          # @param logprobs [Boolean] Whether to return log probabilities of the output tokens or not. If true, return
+          #
+          # @param max_tokens [Integer] Maximum number of completion tokens the model should generate.
+          #
+          # @param min_p [Float] This is an alternative to `top_p` that [many prefer](https://github.com/huggingf
+          #
+          # @param model [String] The language model to chat with.
+          #
+          # @param n [Float] This will return multiple choices for you instead of a single chat completion.
+          #
+          # @param presence_penalty [Float] Higher values will penalize the model from repeating the same output tokens.
+          #
+          # @param response_format [Telnyx::Models::AI::OpenAI::ChatCreateCompletionParams::ResponseFormat] Use this is you want to guarantee a JSON output without defining a schema. For c
+          #
+          # @param seed [Integer] If specified, the system will make a best effort to sample deterministically, su
+          #
+          # @param stop [String, Array<String>] Up to 4 sequences where the API will stop generating further tokens. The returne
+          #
+          # @param stream [Boolean] Whether or not to stream data-only server-sent events as they become available.
+          #
+          # @param temperature [Float] Adjusts the "creativity" of the model. Lower values make the model more determin
+          #
+          # @param tool_choice [Symbol, Telnyx::Models::AI::OpenAI::ChatCreateCompletionParams::ToolChoice]
+          #
+          # @param tools [Array<Telnyx::Models::AI::OpenAI::ChatCreateCompletionParams::Tool::Function, Telnyx::Models::AI::OpenAI::ChatCreateCompletionParams::Tool::Retrieval>] The `function` tool type follows the same schema as the [OpenAI Chat Completions
+          #
+          # @param top_logprobs [Integer] This is used with `logprobs`. An integer between 0 and 20 specifying the number
+          #
+          # @param top_p [Float] An alternative or complement to `temperature`. This adjusts how many of the top
+          #
+          # @param use_beam_search [Boolean] Setting this to `true` will allow the model to [explore more completion options]
+          #
+          # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Hash{Symbol=>Object}]
+          #
+          # @see Telnyx::Models::AI::OpenAI::ChatCreateCompletionParams
+          def create_completion(params)
+            parsed, options = Telnyx::AI::OpenAI::ChatCreateCompletionParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "ai/openai/chat/completions",
+              body: parsed,
+              model: Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown],
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [Telnyx::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/resources/ai/openai.rb

@@ -9,12 +9,38 @@ module Telnyx
         # @return [Telnyx::Resources::AI::OpenAI::Embeddings]
         attr_reader :embeddings
 
+        # @return [Telnyx::Resources::AI::OpenAI::Chat]
+        attr_reader :chat
+
+        # This endpoint returns a list of Open Source and OpenAI models that are available
+        # for use. <br /><br /> **Note**: Model `id`'s will be in the form
+        # `{source}/{model_name}`. For example `openai/gpt-4` or
+        # `mistralai/Mistral-7B-Instruct-v0.1` consistent with HuggingFace naming
+        # conventions.
+        #
+        # @overload list_models(request_options: {})
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::AI::OpenAIListModelsResponse]
+        #
+        # @see Telnyx::Models::AI::OpenAIListModelsParams
+        def list_models(params = {})
+          @client.request(
+            method: :get,
+            path: "ai/openai/models",
+            model: Telnyx::Models::AI::OpenAIListModelsResponse,
+            options: params[:request_options]
+          )
+        end
+
         # @api private
         #
         # @param client [Telnyx::Client]
         def initialize(client:)
           @client = client
           @embeddings = Telnyx::Resources::AI::OpenAI::Embeddings.new(client: client)
+          @chat = Telnyx::Resources::AI::OpenAI::Chat.new(client: client)
         end
       end
     end

data/lib/telnyx/resources/ai.rb

@@ -46,11 +46,13 @@ module Telnyx
       # @return [Telnyx::Resources::AI::Tools]
       attr_reader :tools
 
-      # This endpoint returns a list of Open Source and OpenAI models that are available
-      # for use. <br /><br /> **Note**: Model `id`'s will be in the form
-      # `{source}/{model_name}`. For example `openai/gpt-4` or
-      # `mistralai/Mistral-7B-Instruct-v0.1` consistent with HuggingFace naming
-      # conventions.
+      # @deprecated
+      #
+      # **Deprecated**: Use `GET /v2/ai/openai/models` instead. This endpoint returns a
+      # list of Open Source and OpenAI models that are available for use. <br /><br />
+      # **Note**: Model `id`'s will be in the form `{source}/{model_name}`. For example
+      # `openai/gpt-4` or `mistralai/Mistral-7B-Instruct-v0.1` consistent with
+      # HuggingFace naming conventions.
       #
       # @overload retrieve_models(request_options: {})
       #

data/lib/telnyx/resources/uac_connections/actions.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Resources
+    class UacConnections
+      # UAC connection operations
+      class Actions
+        # Checks the registration status for a UAC connection (`registration_status`) as
+        # well as the timestamp for the last SIP registration event
+        # (`registration_status_updated_at`).
+        #
+        # @overload check_registration_status(id, request_options: {})
+        #
+        # @param id [String] Identifies the resource.
+        #
+        # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse]
+        #
+        # @see Telnyx::Models::UacConnections::ActionCheckRegistrationStatusParams
+        def check_registration_status(id, params = {})
+          @client.request(
+            method: :post,
+            path: ["uac_connections/%1$s/actions/check_registration_status", id],
+            model: Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Telnyx::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end