telnyx 5.174.0 → 5.175.0

data/rbi/telnyx/models/agent_gateways/agent_gateway_key.rbi

@@ -0,0 +1,151 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    AgentGatewayKey = AgentGateways::AgentGatewayKey
+
+    module AgentGateways
+      class AgentGatewayKey < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::AgentGateways::AgentGatewayKey,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Identifies the key. It is a 64-character hash the instance stores in place of
+        # the key's value.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Whether the instance refuses the key.
+        sig { returns(T::Boolean) }
+        attr_accessor :blocked
+
+        # When the key's spend next resets.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :budget_resets_at
+
+        # How often the key's spend resets, such as `30d`.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :budget_resets_every
+
+        # When the key was issued.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :created_at
+
+        # When the key stops working; `null` when it does not expire.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :expires_at
+
+        # The most the key may spend, in USD, until its budget resets.
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :max_budget
+
+        # The most requests the key may have in flight at once.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :max_parallel_requests
+
+        # The models the key may use. Empty means every model the instance serves.
+        sig { returns(T::Array[String]) }
+        attr_accessor :models
+
+        # A label for people; `null` when none was given.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # The most requests the key may make per minute.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :requests_per_minute
+
+        # What the key has spent since its budget last reset, in USD.
+        sig { returns(Float) }
+        attr_accessor :spend
+
+        # The team the key belongs to, if any.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :team_id
+
+        # The most tokens the key may use per minute.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :tokens_per_minute
+
+        # A key on an instance, without its value.
+        sig do
+          params(
+            id: String,
+            blocked: T::Boolean,
+            budget_resets_at: T.nilable(Time),
+            budget_resets_every: T.nilable(String),
+            created_at: T.nilable(Time),
+            expires_at: T.nilable(Time),
+            max_budget: T.nilable(Float),
+            max_parallel_requests: T.nilable(Integer),
+            models: T::Array[String],
+            name: T.nilable(String),
+            requests_per_minute: T.nilable(Integer),
+            spend: Float,
+            team_id: T.nilable(String),
+            tokens_per_minute: T.nilable(Integer)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Identifies the key. It is a 64-character hash the instance stores in place of
+          # the key's value.
+          id:,
+          # Whether the instance refuses the key.
+          blocked:,
+          # When the key's spend next resets.
+          budget_resets_at:,
+          # How often the key's spend resets, such as `30d`.
+          budget_resets_every:,
+          # When the key was issued.
+          created_at:,
+          # When the key stops working; `null` when it does not expire.
+          expires_at:,
+          # The most the key may spend, in USD, until its budget resets.
+          max_budget:,
+          # The most requests the key may have in flight at once.
+          max_parallel_requests:,
+          # The models the key may use. Empty means every model the instance serves.
+          models:,
+          # A label for people; `null` when none was given.
+          name:,
+          # The most requests the key may make per minute.
+          requests_per_minute:,
+          # What the key has spent since its budget last reset, in USD.
+          spend:,
+          # The team the key belongs to, if any.
+          team_id:,
+          # The most tokens the key may use per minute.
+          tokens_per_minute:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              blocked: T::Boolean,
+              budget_resets_at: T.nilable(Time),
+              budget_resets_every: T.nilable(String),
+              created_at: T.nilable(Time),
+              expires_at: T.nilable(Time),
+              max_budget: T.nilable(Float),
+              max_parallel_requests: T.nilable(Integer),
+              models: T::Array[String],
+              name: T.nilable(String),
+              requests_per_minute: T.nilable(Integer),
+              spend: Float,
+              team_id: T.nilable(String),
+              tokens_per_minute: T.nilable(Integer)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/agent_gateways/agent_gateway_key_response.rbi

@@ -0,0 +1,45 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    AgentGatewayKeyResponse = AgentGateways::AgentGatewayKeyResponse
+
+    module AgentGateways
+      class AgentGatewayKeyResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::AgentGateways::AgentGatewayKeyResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # A key on an instance, without its value.
+        sig { returns(Telnyx::AgentGateways::AgentGatewayKey) }
+        attr_reader :data
+
+        sig do
+          params(data: Telnyx::AgentGateways::AgentGatewayKey::OrHash).void
+        end
+        attr_writer :data
+
+        sig do
+          params(data: Telnyx::AgentGateways::AgentGatewayKey::OrHash).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # A key on an instance, without its value.
+          data:
+        )
+        end
+
+        sig do
+          override.returns({ data: Telnyx::AgentGateways::AgentGatewayKey })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/agent_gateways/agent_gateway_mcp_server.rbi

@@ -0,0 +1,172 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    AgentGatewayMcpServer = AgentGateways::AgentGatewayMcpServer
+
+    module AgentGateways
+      class AgentGatewayMcpServer < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::AgentGateways::AgentGatewayMcpServer,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Identifies the server.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The server's outbound authentication method. Credentials are never returned.
+        sig { returns(Telnyx::AgentGateways::AgentGatewayShownAuth) }
+        attr_reader :auth
+
+        sig do
+          params(
+            auth: Telnyx::AgentGateways::AgentGatewayShownAuth::OrHash
+          ).void
+        end
+        attr_writer :auth
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :created_at
+
+        # Headers copied from the agent's request, by name.
+        sig { returns(T::Array[String]) }
+        attr_accessor :forwarded_headers
+
+        # A name for the server, unique on the instance across MCP servers and APIs,
+        # regardless of case. Letters, digits, `_`, and `.`. The gateway prefixes the
+        # server's tools with it and a hyphen.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # `true` lets every key on the instance use the server, granted or not.
+        sig { returns(T::Boolean) }
+        attr_accessor :open_to_every_key
+
+        # Headers sent on every request.
+        sig { returns(T::Hash[Symbol, String]) }
+        attr_accessor :static_headers
+
+        # The tools the server exposes to every key, by name. `[]` exposes every tool.
+        sig { returns(T::Array[String]) }
+        attr_accessor :tools
+
+        # `http` for Streamable HTTP, or `sse` for Server-Sent Events.
+        sig do
+          returns(
+            Telnyx::AgentGateways::AgentGatewayMcpServer::Transport::TaggedSymbol
+          )
+        end
+        attr_accessor :transport
+
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :updated_at
+
+        # The server's MCP endpoint.
+        sig { returns(String) }
+        attr_accessor :url
+
+        sig do
+          params(
+            id: String,
+            auth: Telnyx::AgentGateways::AgentGatewayShownAuth::OrHash,
+            created_at: T.nilable(Time),
+            forwarded_headers: T::Array[String],
+            name: String,
+            open_to_every_key: T::Boolean,
+            static_headers: T::Hash[Symbol, String],
+            tools: T::Array[String],
+            transport:
+              Telnyx::AgentGateways::AgentGatewayMcpServer::Transport::OrSymbol,
+            updated_at: T.nilable(Time),
+            url: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Identifies the server.
+          id:,
+          # The server's outbound authentication method. Credentials are never returned.
+          auth:,
+          created_at:,
+          # Headers copied from the agent's request, by name.
+          forwarded_headers:,
+          # A name for the server, unique on the instance across MCP servers and APIs,
+          # regardless of case. Letters, digits, `_`, and `.`. The gateway prefixes the
+          # server's tools with it and a hyphen.
+          name:,
+          # `true` lets every key on the instance use the server, granted or not.
+          open_to_every_key:,
+          # Headers sent on every request.
+          static_headers:,
+          # The tools the server exposes to every key, by name. `[]` exposes every tool.
+          tools:,
+          # `http` for Streamable HTTP, or `sse` for Server-Sent Events.
+          transport:,
+          updated_at:,
+          # The server's MCP endpoint.
+          url:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              auth: Telnyx::AgentGateways::AgentGatewayShownAuth,
+              created_at: T.nilable(Time),
+              forwarded_headers: T::Array[String],
+              name: String,
+              open_to_every_key: T::Boolean,
+              static_headers: T::Hash[Symbol, String],
+              tools: T::Array[String],
+              transport:
+                Telnyx::AgentGateways::AgentGatewayMcpServer::Transport::TaggedSymbol,
+              updated_at: T.nilable(Time),
+              url: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # `http` for Streamable HTTP, or `sse` for Server-Sent Events.
+        module Transport
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::AgentGateways::AgentGatewayMcpServer::Transport
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          HTTP =
+            T.let(
+              :http,
+              Telnyx::AgentGateways::AgentGatewayMcpServer::Transport::TaggedSymbol
+            )
+          SSE =
+            T.let(
+              :sse,
+              Telnyx::AgentGateways::AgentGatewayMcpServer::Transport::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::AgentGateways::AgentGatewayMcpServer::Transport::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/agent_gateways/agent_gateway_mcp_server_response.rbi

@@ -0,0 +1,45 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    AgentGatewayMcpServerResponse = AgentGateways::AgentGatewayMcpServerResponse
+
+    module AgentGateways
+      class AgentGatewayMcpServerResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::AgentGateways::AgentGatewayMcpServerResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Telnyx::AgentGateways::AgentGatewayMcpServer) }
+        attr_reader :data
+
+        sig do
+          params(
+            data: Telnyx::AgentGateways::AgentGatewayMcpServer::OrHash
+          ).void
+        end
+        attr_writer :data
+
+        sig do
+          params(
+            data: Telnyx::AgentGateways::AgentGatewayMcpServer::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(data:)
+        end
+
+        sig do
+          override.returns(
+            { data: Telnyx::AgentGateways::AgentGatewayMcpServer }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/agent_gateways/agent_gateway_no_auth.rbi

@@ -0,0 +1,76 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    AgentGatewayNoAuth = AgentGateways::AgentGatewayNoAuth
+
+    module AgentGateways
+      class AgentGatewayNoAuth < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::AgentGateways::AgentGatewayNoAuth,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(Telnyx::AgentGateways::AgentGatewayNoAuth::Type::OrSymbol)
+          )
+        end
+        attr_reader :type
+
+        sig do
+          params(
+            type: Telnyx::AgentGateways::AgentGatewayNoAuth::Type::OrSymbol
+          ).void
+        end
+        attr_writer :type
+
+        # The gateway sends no credential.
+        sig do
+          params(
+            type: Telnyx::AgentGateways::AgentGatewayNoAuth::Type::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(type: nil)
+        end
+
+        sig do
+          override.returns(
+            { type: Telnyx::AgentGateways::AgentGatewayNoAuth::Type::OrSymbol }
+          )
+        end
+        def to_hash
+        end
+
+        module Type
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::AgentGateways::AgentGatewayNoAuth::Type)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          NONE =
+            T.let(
+              :none,
+              Telnyx::AgentGateways::AgentGatewayNoAuth::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::AgentGateways::AgentGatewayNoAuth::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/agent_gateways/agent_gateway_oauth_client_credentials.rbi

@@ -0,0 +1,155 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    AgentGatewayOAuthClientCredentials =
+      AgentGateways::AgentGatewayOAuthClientCredentials
+
+    module AgentGateways
+      class AgentGatewayOAuthClientCredentials < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::AgentGateways::AgentGatewayOAuthClientCredentials,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # The OAuth provider's token endpoint.
+        sig { returns(String) }
+        attr_accessor :token_url
+
+        sig { returns(Symbol) }
+        attr_accessor :type
+
+        # The token's audience, sent in the token request.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :audience
+
+        # Whether the client ID and secret go in the token request's body or as HTTP Basic
+        # authentication.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::AgentGateways::AgentGatewayOAuthClientCredentials::CredentialsIn::OrSymbol
+            )
+          )
+        end
+        attr_reader :credentials_in
+
+        sig do
+          params(
+            credentials_in:
+              Telnyx::AgentGateways::AgentGatewayOAuthClientCredentials::CredentialsIn::OrSymbol
+          ).void
+        end
+        attr_writer :credentials_in
+
+        # The resource the token is for, sent in the token request.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :resource
+
+        # The scopes to request.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :scopes
+
+        sig { params(scopes: T::Array[String]).void }
+        attr_writer :scopes
+
+        sig { returns(String) }
+        attr_accessor :client_id
+
+        sig { returns(String) }
+        attr_accessor :client_secret
+
+        # The gateway gets its own access token with the `client_credentials` grant and
+        # sends it as a bearer token on every request, renewing it before it expires. The
+        # client ID and secret are write-only.
+        sig do
+          params(
+            client_id: String,
+            client_secret: String,
+            token_url: String,
+            audience: T.nilable(String),
+            credentials_in:
+              Telnyx::AgentGateways::AgentGatewayOAuthClientCredentials::CredentialsIn::OrSymbol,
+            resource: T.nilable(String),
+            scopes: T::Array[String],
+            type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          client_id:,
+          client_secret:,
+          # The OAuth provider's token endpoint.
+          token_url:,
+          # The token's audience, sent in the token request.
+          audience: nil,
+          # Whether the client ID and secret go in the token request's body or as HTTP Basic
+          # authentication.
+          credentials_in: nil,
+          # The resource the token is for, sent in the token request.
+          resource: nil,
+          # The scopes to request.
+          scopes: nil,
+          type: :oauth_client_credentials
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              client_id: String,
+              client_secret: String,
+              token_url: String,
+              type: Symbol,
+              audience: T.nilable(String),
+              credentials_in:
+                Telnyx::AgentGateways::AgentGatewayOAuthClientCredentials::CredentialsIn::OrSymbol,
+              resource: T.nilable(String),
+              scopes: T::Array[String]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Whether the client ID and secret go in the token request's body or as HTTP Basic
+        # authentication.
+        module CredentialsIn
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::AgentGateways::AgentGatewayOAuthClientCredentials::CredentialsIn
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          BODY =
+            T.let(
+              :body,
+              Telnyx::AgentGateways::AgentGatewayOAuthClientCredentials::CredentialsIn::TaggedSymbol
+            )
+          BASIC =
+            T.let(
+              :basic,
+              Telnyx::AgentGateways::AgentGatewayOAuthClientCredentials::CredentialsIn::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::AgentGateways::AgentGatewayOAuthClientCredentials::CredentialsIn::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end