telnyx 5.170.0 → 5.173.0

data/rbi/telnyx/client.rbi

@@ -22,6 +22,9 @@ module Telnyx
     sig { returns(T.nilable(String)) }
     attr_reader :client_secret
 
+    sig { returns(Telnyx::Resources::BrowserSessions) }
+    attr_reader :browser_sessions
+
     sig { returns(Telnyx::Resources::Legacy) }
     attr_reader :legacy
 
@@ -730,6 +733,7 @@ module Telnyx
     sig { returns(Telnyx::Resources::ExternalRequirements) }
     attr_reader :external_requirements
 
+    # Inspect Stateful Actor types
     sig { returns(Telnyx::Resources::Compute) }
     attr_reader :compute
 
@@ -768,6 +772,80 @@ module Telnyx
     sig { returns(Telnyx::Resources::MachinePayments) }
     attr_reader :machine_payments
 
+    # Daily and monthly spend limits per product. A limit applies to the organization
+    # of the authenticated user, or to the user's own account when they belong to no
+    # organization; every user of the organization sees and changes the same limits.
+    #
+    # - **Periods.** `daily` covers the current UTC day and `monthly` the current UTC
+    #   calendar month. The two limits are independent: you can set either, both or
+    #   neither.
+    # - **Blocking.** When spend in a period goes above the limit (strictly greater),
+    #   the product is blocked until the period ends: 00:00 UTC the next day for
+    #   `daily`, 00:00 UTC on the 1st of the next month for `monthly`. A block appears
+    #   within about 2 minutes (daily) or 10 minutes (monthly) of the spend being
+    #   recorded.
+    # - **Changes apply immediately.** Creating, updating or deleting a limit checks
+    #   the period's spend in the same request: raising the limit above the spend, or
+    #   removing it, lifts that period's block, and lowering it below the spend blocks
+    #   the product at once. The `evaluation` object in the response says what
+    #   happened.
+    # - **Supported products.** Today only `inference` supports spend limits. A
+    #   blocked account gets HTTP 403 with the error title
+    #   `Inference spend limit reached` (code `10039`) on new billable chat
+    #   completions, Responses, Anthropic Messages and classification requests;
+    #   requests already running finish normally. Take the list of products from the
+    #   list operation.
+    # - **API key limits.** For `inference`, a limit can also apply to one API key,
+    #   named by `credential_id`: the key's identifier as recorded on usage, never its
+    #   secret. When the key's spend goes above its own limit, only that key is
+    #   blocked, with the error title `API key spend limit reached` (code `10039`);
+    #   the account's other keys keep working. The API key limits of a period cannot
+    #   add up to more than the total limit when the total has an amount. Only
+    #   language-model requests authenticated with an API key count toward its limit.
+    # - **Limits set by Telnyx.** Telnyx support can also set a limit on your account.
+    #   It is listed with `origin: operator` and you can update or delete it like your
+    #   own.
+    sig { returns(Telnyx::Resources::SpendLimits) }
+    attr_reader :spend_limits
+
+    sig { returns(Telnyx::Resources::LlmTokenGateway) }
+    attr_reader :llm_token_gateway
+
+    # UAC connection operations
+    sig { returns(Telnyx::Resources::SipRegistrationStatus) }
+    attr_reader :sip_registration_status
+
+    # Call information
+    sig { returns(Telnyx::Resources::DialMetrics) }
+    attr_reader :dial_metrics
+
+    sig { returns(Telnyx::Resources::TtsIntegrations) }
+    attr_reader :tts_integrations
+
+    # Tailscale Subnet Router operations
+    sig { returns(Telnyx::Resources::TailscaleSubnetRouters) }
+    attr_reader :tailscale_subnet_routers
+
+    # Download screenshots and other artifacts.
+    sig { returns(Telnyx::Resources::ArtifactDownloads) }
+    attr_reader :artifact_downloads
+
+    sig { returns(Telnyx::Resources::Email) }
+    attr_reader :email
+
+    # Routes on a Network that send a CIDR to a next hop, such as a tunnel.
+    sig { returns(Telnyx::Resources::NetworkRoutes) }
+    attr_reader :network_routes
+
+    # Generic payment connector configuration.
+    sig { returns(Telnyx::Resources::PayConnectors) }
+    attr_reader :pay_connectors
+
+    # Tunnels connect a Network to hosts behind a tunnel process within the user's
+    # network.
+    sig { returns(Telnyx::Resources::Tunnels) }
+    attr_reader :tunnels
+
     # @api private
     sig { override.returns(T::Hash[String, String]) }
     private def auth_headers

data/rbi/telnyx/models/address.rbi

@@ -146,7 +146,11 @@ module Telnyx
       # have used the `/addresses/actions/validate` endpoint to validate the address
       # separately prior to creation. If an address is not validated for emergency use
       # upon creation and it is not valid, it will not be able to be used for emergency
-      # services.
+      # services. In an address record, this flag indicates whether emergency validation
+      # was performed at creation: `true` means the record passed emergency validation
+      # before it was created; `false` means validation was skipped during this creation
+      # request, and the address may have been validated separately. This flag is not a
+      # current validity status; emergency use still requires a valid address.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :validate_address
 
@@ -227,7 +231,11 @@ module Telnyx
         # have used the `/addresses/actions/validate` endpoint to validate the address
         # separately prior to creation. If an address is not validated for emergency use
         # upon creation and it is not valid, it will not be able to be used for emergency
-        # services.
+        # services. In an address record, this flag indicates whether emergency validation
+        # was performed at creation: `true` means the record passed emergency validation
+        # before it was created; `false` means validation was skipped during this creation
+        # request, and the address may have been validated separately. This flag is not a
+        # current validity status; emergency use still requires a valid address.
         validate_address: nil
       )
       end

data/rbi/telnyx/models/address_create_params.rbi

@@ -105,7 +105,11 @@ module Telnyx
       # have used the `/addresses/actions/validate` endpoint to validate the address
       # separately prior to creation. If an address is not validated for emergency use
       # upon creation and it is not valid, it will not be able to be used for emergency
-      # services.
+      # services. In an address record, this flag indicates whether emergency validation
+      # was performed at creation: `true` means the record passed emergency validation
+      # before it was created; `false` means validation was skipped during this creation
+      # request, and the address may have been validated separately. This flag is not a
+      # current validity status; emergency use still requires a valid address.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :validate_address
 
@@ -175,7 +179,11 @@ module Telnyx
         # have used the `/addresses/actions/validate` endpoint to validate the address
         # separately prior to creation. If an address is not validated for emergency use
         # upon creation and it is not valid, it will not be able to be used for emergency
-        # services.
+        # services. In an address record, this flag indicates whether emergency validation
+        # was performed at creation: `true` means the record passed emergency validation
+        # before it was created; `false` means validation was skipped during this creation
+        # request, and the address may have been validated separately. This flag is not a
+        # current validity status; emergency use still requires a valid address.
         validate_address: nil,
         request_options: {}
       )

data/rbi/telnyx/models/addresses/action_validate_response.rbi

@@ -53,7 +53,6 @@ module Telnyx
               )
             end
 
-          # Indicates whether an address is valid or invalid.
           sig do
             returns(
               Telnyx::Models::Addresses::ActionValidateResponse::Data::Result::TaggedSymbol
@@ -101,7 +100,6 @@ module Telnyx
             ).returns(T.attached_class)
           end
           def self.new(
-            # Indicates whether an address is valid or invalid.
             result:,
             # Provides normalized address when available.
             suggested:,
@@ -126,7 +124,6 @@ module Telnyx
           def to_hash
           end
 
-          # Indicates whether an address is valid or invalid.
           module Result
             extend Telnyx::Internal::Type::Enum
 
@@ -144,11 +141,6 @@ module Telnyx
                 :valid,
                 Telnyx::Models::Addresses::ActionValidateResponse::Data::Result::TaggedSymbol
               )
-            INVALID =
-              T.let(
-                :invalid,
-                Telnyx::Models::Addresses::ActionValidateResponse::Data::Result::TaggedSymbol
-              )
 
             sig do
               override.returns(
@@ -178,6 +170,14 @@ module Telnyx
             sig { params(administrative_area: String).void }
             attr_writer :administrative_area
 
+            # The borough of the address. This field is not used for addresses in the US but
+            # is used for some international addresses.
+            sig { returns(T.nilable(String)) }
+            attr_reader :borough
+
+            sig { params(borough: String).void }
+            attr_writer :borough
+
             # The two-character (ISO 3166-1 alpha-2) country code of the address.
             sig { returns(T.nilable(String)) }
             attr_reader :country_code
@@ -193,6 +193,10 @@ module Telnyx
             sig { params(extended_address: String).void }
             attr_writer :extended_address
 
+            # Latitude of the suggested address, when available.
+            sig { returns(T.nilable(Float)) }
+            attr_accessor :latitude
+
             # The locality of the address. For US addresses, this corresponds to the city of
             # the address.
             sig { returns(T.nilable(String)) }
@@ -201,6 +205,18 @@ module Telnyx
             sig { params(locality: String).void }
             attr_writer :locality
 
+            # Longitude of the suggested address, when available.
+            sig { returns(T.nilable(Float)) }
+            attr_accessor :longitude
+
+            # The neighborhood of the address. This field is not used for addresses in the US
+            # but is used for some international addresses.
+            sig { returns(T.nilable(String)) }
+            attr_reader :neighborhood
+
+            sig { params(neighborhood: String).void }
+            attr_writer :neighborhood
+
             # The postal code of the address.
             sig { returns(T.nilable(String)) }
             attr_reader :postal_code
@@ -219,9 +235,13 @@ module Telnyx
             sig do
               params(
                 administrative_area: String,
+                borough: String,
                 country_code: String,
                 extended_address: String,
+                latitude: T.nilable(Float),
                 locality: String,
+                longitude: T.nilable(Float),
+                neighborhood: String,
                 postal_code: String,
                 street_address: String
               ).returns(T.attached_class)
@@ -230,14 +250,24 @@ module Telnyx
               # The locality of the address. For US addresses, this corresponds to the state of
               # the address.
               administrative_area: nil,
+              # The borough of the address. This field is not used for addresses in the US but
+              # is used for some international addresses.
+              borough: nil,
               # The two-character (ISO 3166-1 alpha-2) country code of the address.
               country_code: nil,
               # Additional street address information about the address such as, but not limited
               # to, unit number or apartment number.
               extended_address: nil,
+              # Latitude of the suggested address, when available.
+              latitude: nil,
               # The locality of the address. For US addresses, this corresponds to the city of
               # the address.
               locality: nil,
+              # Longitude of the suggested address, when available.
+              longitude: nil,
+              # The neighborhood of the address. This field is not used for addresses in the US
+              # but is used for some international addresses.
+              neighborhood: nil,
               # The postal code of the address.
               postal_code: nil,
               # The primary street address information about the address.
@@ -249,9 +279,13 @@ module Telnyx
               override.returns(
                 {
                   administrative_area: String,
+                  borough: String,
                   country_code: String,
                   extended_address: String,
+                  latitude: T.nilable(Float),
                   locality: String,
+                  longitude: T.nilable(Float),
+                  neighborhood: String,
                   postal_code: String,
                   street_address: String
                 }

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

@@ -38,6 +38,21 @@ module Telnyx
         end
         attr_writer :a2a_agents
 
+        # **Beta:** Configuration for the Telnyx open-source avatar provider. Use a stock
+        # avatar or an organization-owned custom avatar returned by the Avatars API.
+        # Discover the available stock catalog with GET /v2/ai/avatars and
+        # filter[avatar_type]=stock; follow meta.total_pages to load every page.
+        sig { returns(T.nilable(Telnyx::AI::AvatarSettingsRequest)) }
+        attr_reader :avatar_settings
+
+        sig do
+          params(
+            avatar_settings:
+              T.nilable(Telnyx::AI::AvatarSettingsRequest::OrHash)
+          ).void
+        end
+        attr_writer :avatar_settings
+
         # Conversation flow as supplied by API clients (create / update).
         #
         # A directed graph of `FlowNodeReq` connected by `FlowEdge`s. Validation enforces
@@ -53,6 +68,23 @@ module Telnyx
         end
         attr_writer :conversation_flow
 
+        # Splits the conversation between a frontend model that talks to the caller and a
+        # backend model that does the work. On the GPT-Live route the frontend model
+        # cannot call tools at all — when it needs something done it raises a delegation
+        # and waits. On the chat completion route the frontend keeps a single `delegate`
+        # tool that returns immediately, so the conversation carries on while the backend
+        # works. Either way the backend's answer is spoken as commentary or kept as silent
+        # context, depending on `speak_results`. Beta feature.
+        sig { returns(T.nilable(Telnyx::AI::DelegationSettings)) }
+        attr_reader :delegation_settings
+
+        sig do
+          params(
+            delegation_settings: Telnyx::AI::DelegationSettings::OrHash
+          ).void
+        end
+        attr_writer :delegation_settings
+
         sig { returns(T.nilable(String)) }
         attr_reader :description
 
@@ -291,6 +323,7 @@ module Telnyx
                   Telnyx::AI::AssistantTool::SendDtmf,
                   Telnyx::AI::AssistantTool::SendMessage,
                   Telnyx::AI::AssistantTool::SkipTurn,
+                  Telnyx::AI::AssistantTool::Vision,
                   Telnyx::AI::AssistantTool::Pay,
                   Telnyx::AI::AssistantTool::UpdateDynamicVariables
                 )
@@ -317,6 +350,7 @@ module Telnyx
                   Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                   Telnyx::AI::AssistantTool::SendMessage::OrHash,
                   Telnyx::AI::AssistantTool::SkipTurn::OrHash,
+                  Telnyx::AI::AssistantTool::Vision::OrHash,
                   Telnyx::AI::AssistantTool::Pay::OrHash,
                   Telnyx::AI::AssistantTool::UpdateDynamicVariables::OrHash
                 )
@@ -343,6 +377,19 @@ module Telnyx
         end
         attr_writer :voice_settings
 
+        # Streams conversation and telephony events to a WebSocket server you host, and
+        # accepts messages injected back into the conversation. Telnyx opens the
+        # connection as a client, once per conversation. Delivery is best effort
+        # throughout: while the connection is down events are dropped rather than queued,
+        # and no socket failure is ever allowed to affect the call. Beta feature.
+        sig { returns(T.nilable(Telnyx::AI::WebsocketSettings)) }
+        attr_reader :websocket_settings
+
+        sig do
+          params(websocket_settings: Telnyx::AI::WebsocketSettings::OrHash).void
+        end
+        attr_writer :websocket_settings
+
         # Configuration settings for the assistant's web widget.
         sig { returns(T.nilable(Telnyx::AI::WidgetSettings)) }
         attr_reader :widget_settings
@@ -361,7 +408,10 @@ module Telnyx
             instructions: String,
             name: String,
             a2a_agents: T::Array[Telnyx::AI::AssistantA2AAgent::OrHash],
+            avatar_settings:
+              T.nilable(Telnyx::AI::AvatarSettingsRequest::OrHash),
             conversation_flow: Telnyx::AI::ConversationFlowReq::OrHash,
+            delegation_settings: Telnyx::AI::DelegationSettings::OrHash,
             description: String,
             dynamic_variables: T::Hash[Symbol, T.anything],
             dynamic_variables_webhook_timeout_ms: Integer,
@@ -400,12 +450,14 @@ module Telnyx
                   Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                   Telnyx::AI::AssistantTool::SendMessage::OrHash,
                   Telnyx::AI::AssistantTool::SkipTurn::OrHash,
+                  Telnyx::AI::AssistantTool::Vision::OrHash,
                   Telnyx::AI::AssistantTool::Pay::OrHash,
                   Telnyx::AI::AssistantTool::UpdateDynamicVariables::OrHash
                 )
               ],
             transcription: Telnyx::AI::TranscriptionSettings::OrHash,
             voice_settings: Telnyx::AI::InferenceEmbeddingVoiceSettings::OrHash,
+            websocket_settings: Telnyx::AI::WebsocketSettings::OrHash,
             widget_settings: Telnyx::AI::WidgetSettings::OrHash,
             idempotency_key: String,
             request_options: Telnyx::RequestOptions::OrHash
@@ -425,12 +477,25 @@ module Telnyx
           # fetches combined. An agent whose card cannot be fetched costs the assistant that
           # capability for the conversation; it does not fail the call.
           a2a_agents: nil,
+          # **Beta:** Configuration for the Telnyx open-source avatar provider. Use a stock
+          # avatar or an organization-owned custom avatar returned by the Avatars API.
+          # Discover the available stock catalog with GET /v2/ai/avatars and
+          # filter[avatar_type]=stock; follow meta.total_pages to load every page.
+          avatar_settings: nil,
           # Conversation flow as supplied by API clients (create / update).
           #
           # A directed graph of `FlowNodeReq` connected by `FlowEdge`s. Validation enforces
           # unique node/edge IDs, that `start_node_id` references a real node, and that
           # every edge's endpoints reference real nodes.
           conversation_flow: nil,
+          # Splits the conversation between a frontend model that talks to the caller and a
+          # backend model that does the work. On the GPT-Live route the frontend model
+          # cannot call tools at all — when it needs something done it raises a delegation
+          # and waits. On the chat completion route the frontend keeps a single `delegate`
+          # tool that returns immediately, so the conversation carries on while the backend
+          # works. Either way the backend's answer is spoken as commentary or kept as silent
+          # context, depending on `speak_results`. Beta feature.
+          delegation_settings: nil,
           description: nil,
           # Map of dynamic variables and their default values
           dynamic_variables: nil,
@@ -510,6 +575,12 @@ module Telnyx
           tools: nil,
           transcription: nil,
           voice_settings: nil,
+          # Streams conversation and telephony events to a WebSocket server you host, and
+          # accepts messages injected back into the conversation. Telnyx opens the
+          # connection as a client, once per conversation. Delivery is best effort
+          # throughout: while the connection is down events are dropped rather than queued,
+          # and no socket failure is ever allowed to affect the call. Beta feature.
+          websocket_settings: nil,
           # Configuration settings for the assistant's web widget.
           widget_settings: nil,
           idempotency_key: nil,
@@ -523,7 +594,9 @@ module Telnyx
               instructions: String,
               name: String,
               a2a_agents: T::Array[Telnyx::AI::AssistantA2AAgent],
+              avatar_settings: T.nilable(Telnyx::AI::AvatarSettingsRequest),
               conversation_flow: Telnyx::AI::ConversationFlowReq,
+              delegation_settings: Telnyx::AI::DelegationSettings,
               description: String,
               dynamic_variables: T::Hash[Symbol, T.anything],
               dynamic_variables_webhook_timeout_ms: Integer,
@@ -562,12 +635,14 @@ module Telnyx
                     Telnyx::AI::AssistantTool::SendDtmf,
                     Telnyx::AI::AssistantTool::SendMessage,
                     Telnyx::AI::AssistantTool::SkipTurn,
+                    Telnyx::AI::AssistantTool::Vision,
                     Telnyx::AI::AssistantTool::Pay,
                     Telnyx::AI::AssistantTool::UpdateDynamicVariables
                   )
                 ],
               transcription: Telnyx::AI::TranscriptionSettings,
               voice_settings: Telnyx::AI::InferenceEmbeddingVoiceSettings,
+              websocket_settings: Telnyx::AI::WebsocketSettings,
               widget_settings: Telnyx::AI::WidgetSettings,
               idempotency_key: String,
               request_options: Telnyx::RequestOptions

data/rbi/telnyx/models/ai/assistant_delete_params.rbi

@@ -15,18 +15,37 @@ module Telnyx
         sig { returns(String) }
         attr_accessor :assistant_id
 
+        # Permanently delete the assistant immediately instead of soft-deleting it to the
+        # Recently Deleted list, where it stays restorable for 30 days.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :hard_delete
+
+        sig { params(hard_delete: T::Boolean).void }
+        attr_writer :hard_delete
+
         sig do
           params(
             assistant_id: String,
+            hard_delete: T::Boolean,
             request_options: Telnyx::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(assistant_id:, request_options: {})
+        def self.new(
+          assistant_id:,
+          # Permanently delete the assistant immediately instead of soft-deleting it to the
+          # Recently Deleted list, where it stays restorable for 30 days.
+          hard_delete: nil,
+          request_options: {}
+        )
         end
 
         sig do
           override.returns(
-            { assistant_id: String, request_options: Telnyx::RequestOptions }
+            {
+              assistant_id: String,
+              hard_delete: T::Boolean,
+              request_options: Telnyx::RequestOptions
+            }
           )
         end
         def to_hash

data/rbi/telnyx/models/ai/assistant_restore_params.rbi

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