telnyx 5.99.0 → 5.101.0

data/rbi/telnyx/models/uac_connections/action_check_registration_status_params.rbi

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

data/rbi/telnyx/models/uac_connections/action_check_registration_status_response.rbi

@@ -0,0 +1,237 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module UacConnections
+      class ActionCheckRegistrationStatusResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data
+            )
+          )
+        end
+        attr_reader :data
+
+        sig do
+          params(
+            data:
+              Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::OrHash
+          ).void
+        end
+        attr_writer :data
+
+        sig do
+          params(
+            data:
+              Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(data: nil)
+        end
+
+        sig do
+          override.returns(
+            {
+              data:
+                Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # The ip used during the SIP connection
+          sig { returns(T.nilable(String)) }
+          attr_reader :ip_address
+
+          sig { params(ip_address: String).void }
+          attr_writer :ip_address
+
+          # ISO 8601 formatted date indicating when the resource was last updated.
+          sig { returns(T.nilable(String)) }
+          attr_reader :last_registration
+
+          sig { params(last_registration: String).void }
+          attr_writer :last_registration
+
+          # The port of the SIP connection
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :port
+
+          sig { params(port: Integer).void }
+          attr_writer :port
+
+          # Identifies the type of the resource.
+          sig { returns(T.nilable(String)) }
+          attr_reader :record_type
+
+          sig { params(record_type: String).void }
+          attr_writer :record_type
+
+          # The user name of the SIP connection
+          sig { returns(T.nilable(String)) }
+          attr_reader :sip_username
+
+          sig { params(sip_username: String).void }
+          attr_writer :sip_username
+
+          # The current registration status of your SIP connection
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :status
+
+          sig do
+            params(
+              status:
+                Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status::OrSymbol
+            ).void
+          end
+          attr_writer :status
+
+          # The protocol of the SIP connection
+          sig { returns(T.nilable(String)) }
+          attr_reader :transport
+
+          sig { params(transport: String).void }
+          attr_writer :transport
+
+          # The user agent of the SIP connection
+          sig { returns(T.nilable(String)) }
+          attr_reader :user_agent
+
+          sig { params(user_agent: String).void }
+          attr_writer :user_agent
+
+          sig do
+            params(
+              ip_address: String,
+              last_registration: String,
+              port: Integer,
+              record_type: String,
+              sip_username: String,
+              status:
+                Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status::OrSymbol,
+              transport: String,
+              user_agent: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The ip used during the SIP connection
+            ip_address: nil,
+            # ISO 8601 formatted date indicating when the resource was last updated.
+            last_registration: nil,
+            # The port of the SIP connection
+            port: nil,
+            # Identifies the type of the resource.
+            record_type: nil,
+            # The user name of the SIP connection
+            sip_username: nil,
+            # The current registration status of your SIP connection
+            status: nil,
+            # The protocol of the SIP connection
+            transport: nil,
+            # The user agent of the SIP connection
+            user_agent: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                ip_address: String,
+                last_registration: String,
+                port: Integer,
+                record_type: String,
+                sip_username: String,
+                status:
+                  Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status::TaggedSymbol,
+                transport: String,
+                user_agent: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The current registration status of your SIP connection
+          module Status
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            NOT_APPLICABLE =
+              T.let(
+                :"Not Applicable",
+                Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status::TaggedSymbol
+              )
+            NOT_REGISTERED =
+              T.let(
+                :"Not Registered",
+                Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status::TaggedSymbol
+              )
+            FAILED =
+              T.let(
+                :Failed,
+                Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status::TaggedSymbol
+              )
+            EXPIRED =
+              T.let(
+                :Expired,
+                Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status::TaggedSymbol
+              )
+            REGISTERED =
+              T.let(
+                :Registered,
+                Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status::TaggedSymbol
+              )
+            UNREGISTERED =
+              T.let(
+                :Unregistered,
+                Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse::Data::Status::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models.rbi

@@ -1798,6 +1798,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/rbi/telnyx/resources/ai/assistants/canary_deploys.rbi

@@ -13,16 +13,12 @@ module Telnyx
           sig do
             params(
               assistant_id: String,
-              versions: T::Array[Telnyx::AI::Assistants::VersionConfig::OrHash],
+              rules:
+                T::Array[Telnyx::AI::Assistants::CanaryDeploy::Rule::OrHash],
               request_options: Telnyx::RequestOptions::OrHash
             ).returns(Telnyx::AI::Assistants::CanaryDeployResponse)
           end
-          def create(
-            assistant_id,
-            # List of version configurations
-            versions:,
-            request_options: {}
-          )
+          def create(assistant_id, rules: nil, request_options: {})
           end
 
           # Endpoint to get a canary deploy configuration for an assistant.
@@ -46,16 +42,12 @@ module Telnyx
           sig do
             params(
               assistant_id: String,
-              versions: T::Array[Telnyx::AI::Assistants::VersionConfig::OrHash],
+              rules:
+                T::Array[Telnyx::AI::Assistants::CanaryDeploy::Rule::OrHash],
               request_options: Telnyx::RequestOptions::OrHash
             ).returns(Telnyx::AI::Assistants::CanaryDeployResponse)
           end
-          def update(
-            assistant_id,
-            # List of version configurations
-            versions:,
-            request_options: {}
-          )
+          def update(assistant_id, rules: nil, request_options: {})
           end
 
           # Endpoint to delete a canary deploy configuration for an assistant.

data/rbi/telnyx/resources/ai/chat.rbi

@@ -5,7 +5,8 @@ module Telnyx
     class AI
       # Generate text with LLMs
       class Chat
-        # 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.
         sig do
@@ -29,6 +30,8 @@ module Telnyx
             presence_penalty: Float,
             response_format:
               Telnyx::AI::ChatCreateCompletionParams::ResponseFormat::OrHash,
+            seed: Integer,
+            stop: Telnyx::AI::ChatCreateCompletionParams::Stop::Variants,
             stream: T::Boolean,
             temperature: Float,
             tool_choice:
@@ -95,6 +98,13 @@ module Telnyx
           # Use this is you want to guarantee a JSON output without defining a schema. For
           # control over the schema, use `guided_json`.
           response_format: nil,
+          # If specified, the system will make a best effort to sample deterministically,
+          # such that repeated requests with the same `seed` and parameters should return
+          # the same result.
+          seed: nil,
+          # Up to 4 sequences where the API will stop generating further tokens. The
+          # returned text will not contain the stop sequence.
+          stop: nil,
           # Whether or not to stream data-only server-sent events as they become available.
           stream: nil,
           # Adjusts the "creativity" of the model. Lower values make the model more

data/rbi/telnyx/resources/ai/openai/chat.rbi

@@ -0,0 +1,147 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class AI
+      class OpenAI
+        class Chat
+          # 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`.
+          sig do
+            params(
+              messages:
+                T::Array[
+                  Telnyx::AI::OpenAI::ChatCreateCompletionParams::Message::OrHash
+                ],
+              api_key_ref: String,
+              best_of: Integer,
+              early_stopping: T::Boolean,
+              enable_thinking: T::Boolean,
+              frequency_penalty: Float,
+              guided_choice: T::Array[String],
+              guided_json: T::Hash[Symbol, T.anything],
+              guided_regex: String,
+              length_penalty: Float,
+              logprobs: T::Boolean,
+              max_tokens: Integer,
+              min_p: Float,
+              model: String,
+              n: Float,
+              presence_penalty: Float,
+              response_format:
+                Telnyx::AI::OpenAI::ChatCreateCompletionParams::ResponseFormat::OrHash,
+              seed: Integer,
+              stop:
+                Telnyx::AI::OpenAI::ChatCreateCompletionParams::Stop::Variants,
+              stream: T::Boolean,
+              temperature: Float,
+              tool_choice:
+                Telnyx::AI::OpenAI::ChatCreateCompletionParams::ToolChoice::OrSymbol,
+              tools:
+                T::Array[
+                  T.any(
+                    Telnyx::AI::OpenAI::ChatCreateCompletionParams::Tool::Function::OrHash,
+                    Telnyx::AI::OpenAI::ChatCreateCompletionParams::Tool::Retrieval::OrHash
+                  )
+                ],
+              top_logprobs: Integer,
+              top_p: Float,
+              use_beam_search: T::Boolean,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(T::Hash[Symbol, T.anything])
+          end
+          def create_completion(
+            # A list of the previous chat messages for context.
+            messages:,
+            # If you are using an external inference provider like xAI or OpenAI, this field
+            # allows you to pass along a reference to your API key. After creating an
+            # [integration secret](https://developers.telnyx.com/api-reference/integration-secrets/create-a-secret)
+            # for you API key, pass the secret's `identifier` in this field.
+            api_key_ref: nil,
+            # This is used with `use_beam_search` to determine how many candidate beams to
+            # explore.
+            best_of: nil,
+            # This is used with `use_beam_search`. If `true`, generation stops as soon as
+            # there are `best_of` complete candidates; if `false`, a heuristic is applied and
+            # the generation stops when is it very unlikely to find better candidates.
+            early_stopping: nil,
+            # Whether to enable the thinking/reasoning phase for models that support it (e.g.,
+            # QwQ, Qwen3). When set to false, the model will skip the internal reasoning step
+            # and respond directly, which can reduce latency. Defaults to true.
+            enable_thinking: nil,
+            # Higher values will penalize the model from repeating the same output tokens.
+            frequency_penalty: nil,
+            # If specified, the output will be exactly one of the choices.
+            guided_choice: nil,
+            # Must be a valid JSON schema. If specified, the output will follow the JSON
+            # schema.
+            guided_json: nil,
+            # If specified, the output will follow the regex pattern.
+            guided_regex: nil,
+            # This is used with `use_beam_search` to prefer shorter or longer completions.
+            length_penalty: nil,
+            # Whether to return log probabilities of the output tokens or not. If true,
+            # returns the log probabilities of each output token returned in the `content` of
+            # `message`.
+            logprobs: nil,
+            # Maximum number of completion tokens the model should generate.
+            max_tokens: nil,
+            # This is an alternative to `top_p` that
+            # [many prefer](https://github.com/huggingface/transformers/issues/27670). Must be
+            # in [0, 1].
+            min_p: nil,
+            # The language model to chat with.
+            model: nil,
+            # This will return multiple choices for you instead of a single chat completion.
+            n: nil,
+            # Higher values will penalize the model from repeating the same output tokens.
+            presence_penalty: nil,
+            # Use this is you want to guarantee a JSON output without defining a schema. For
+            # control over the schema, use `guided_json`.
+            response_format: nil,
+            # If specified, the system will make a best effort to sample deterministically,
+            # such that repeated requests with the same `seed` and parameters should return
+            # the same result.
+            seed: nil,
+            # Up to 4 sequences where the API will stop generating further tokens. The
+            # returned text will not contain the stop sequence.
+            stop: nil,
+            # Whether or not to stream data-only server-sent events as they become available.
+            stream: nil,
+            # Adjusts the "creativity" of the model. Lower values make the model more
+            # deterministic and repetitive, while higher values make the model more random and
+            # creative.
+            temperature: nil,
+            tool_choice: nil,
+            # The `function` tool type follows the same schema as the
+            # [OpenAI Chat Completions API](https://platform.openai.com/docs/api-reference/chat).
+            # The `retrieval` tool type is unique to Telnyx. You may pass a list of
+            # [embedded storage buckets](https://developers.telnyx.com/api-reference/embeddings/embed-documents)
+            # for retrieval-augmented generation.
+            tools: nil,
+            # This is used with `logprobs`. An integer between 0 and 20 specifying the number
+            # of most likely tokens to return at each token position, each with an associated
+            # log probability.
+            top_logprobs: nil,
+            # An alternative or complement to `temperature`. This adjusts how many of the top
+            # possibilities to consider.
+            top_p: nil,
+            # Setting this to `true` will allow the model to
+            # [explore more completion options](https://huggingface.co/blog/how-to-generate#beam-search).
+            # This is not supported by OpenAI.
+            use_beam_search: nil,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: Telnyx::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/ai/openai.rbi

@@ -9,6 +9,22 @@ module Telnyx
         sig { returns(Telnyx::Resources::AI::OpenAI::Embeddings) }
         attr_reader :embeddings
 
+        sig { returns(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.
+        sig do
+          params(request_options: Telnyx::RequestOptions::OrHash).returns(
+            Telnyx::Models::AI::OpenAIListModelsResponse
+          )
+        end
+        def list_models(request_options: {})
+        end
+
         # @api private
         sig { params(client: Telnyx::Client).returns(T.attached_class) }
         def self.new(client:)

data/rbi/telnyx/resources/ai.rbi

@@ -46,11 +46,11 @@ module Telnyx
       sig { returns(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**: 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.
       sig do
         params(request_options: Telnyx::RequestOptions::OrHash).returns(
           Telnyx::Models::AIRetrieveModelsResponse

data/rbi/telnyx/resources/uac_connections/actions.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+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`).
+        sig do
+          params(
+            id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(
+            Telnyx::Models::UacConnections::ActionCheckRegistrationStatusResponse
+          )
+        end
+        def check_registration_status(
+          # Identifies the resource.
+          id,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Telnyx::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end