telnyx 5.174.0 → 5.175.0

data/rbi/telnyx/models/agent_gateways/key_create_response.rbi

@@ -0,0 +1,199 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AgentGateways
+      class KeyCreateResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::AgentGateways::KeyCreateResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # A key that was just issued: the only response that carries its value.
+        sig { returns(Telnyx::Models::AgentGateways::KeyCreateResponse::Data) }
+        attr_reader :data
+
+        sig do
+          params(
+            data: Telnyx::Models::AgentGateways::KeyCreateResponse::Data::OrHash
+          ).void
+        end
+        attr_writer :data
+
+        sig do
+          params(
+            data: Telnyx::Models::AgentGateways::KeyCreateResponse::Data::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # A key that was just issued: the only response that carries its value.
+          data:
+        )
+        end
+
+        sig do
+          override.returns(
+            { data: Telnyx::Models::AgentGateways::KeyCreateResponse::Data }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::AgentGateways::KeyCreateResponse::Data,
+                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 key's value, sent as `Authorization: Bearer <key>` to the instance. Shown
+          # only in this response.
+          sig { returns(String) }
+          attr_accessor :key
+
+          # 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 that was just issued: the only response that carries 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),
+              key: String,
+              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 key's value, sent as `Authorization: Bearer <key>` to the instance. Shown
+            # only in this response.
+            key:,
+            # 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),
+                key: String,
+                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
+end

data/rbi/telnyx/models/agent_gateways/key_delete_params.rbi

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

data/rbi/telnyx/models/agent_gateways/key_list_params.rbi

@@ -0,0 +1,57 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AgentGateways
+      class KeyListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::AgentGateways::KeyListParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :instance_id
+
+        # Only the keys of this team.
+        sig { returns(T.nilable(String)) }
+        attr_reader :team_id
+
+        sig { params(team_id: String).void }
+        attr_writer :team_id
+
+        sig do
+          params(
+            instance_id: String,
+            team_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          instance_id:,
+          # Only the keys of this team.
+          team_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              instance_id: String,
+              team_id: String,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/agent_gateways/key_list_response.rbi

@@ -0,0 +1,36 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AgentGateways
+      class KeyListResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::AgentGateways::KeyListResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T::Array[Telnyx::AgentGateways::AgentGatewayKey]) }
+        attr_accessor :data
+
+        sig do
+          params(
+            data: T::Array[Telnyx::AgentGateways::AgentGatewayKey::OrHash]
+          ).returns(T.attached_class)
+        end
+        def self.new(data:)
+        end
+
+        sig do
+          override.returns(
+            { data: T::Array[Telnyx::AgentGateways::AgentGatewayKey] }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/agent_gateways/key_update_params.rbi

@@ -0,0 +1,141 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AgentGateways
+      class KeyUpdateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::AgentGateways::KeyUpdateParams,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :instance_id
+
+        sig { returns(String) }
+        attr_accessor :key_id
+
+        # `true` makes the instance refuse the key; `false` lets it through again.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :blocked
+
+        sig { params(blocked: T::Boolean).void }
+        attr_writer :blocked
+
+        # How often the spend resets.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :budget_resets_every
+
+        # How long from now until the key stops working.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :expires_in
+
+        # The most the key may spend, in USD.
+        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. `[]` allows every model.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :models
+
+        sig { params(models: T::Array[String]).void }
+        attr_writer :models
+
+        # A label for people.
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        # The most requests the key may make per minute.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :requests_per_minute
+
+        # Move the key to this team, or `null` to leave its team.
+        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
+
+        sig do
+          params(
+            instance_id: String,
+            key_id: String,
+            blocked: T::Boolean,
+            budget_resets_every: T.nilable(String),
+            expires_in: T.nilable(String),
+            max_budget: T.nilable(Float),
+            max_parallel_requests: T.nilable(Integer),
+            models: T::Array[String],
+            name: String,
+            requests_per_minute: T.nilable(Integer),
+            team_id: T.nilable(String),
+            tokens_per_minute: T.nilable(Integer),
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          instance_id:,
+          key_id:,
+          # `true` makes the instance refuse the key; `false` lets it through again.
+          blocked: nil,
+          # How often the spend resets.
+          budget_resets_every: nil,
+          # How long from now until the key stops working.
+          expires_in: nil,
+          # The most the key may spend, in USD.
+          max_budget: nil,
+          # The most requests the key may have in flight at once.
+          max_parallel_requests: nil,
+          # The models the key may use. `[]` allows every model.
+          models: nil,
+          # A label for people.
+          name: nil,
+          # The most requests the key may make per minute.
+          requests_per_minute: nil,
+          # Move the key to this team, or `null` to leave its team.
+          team_id: nil,
+          # The most tokens the key may use per minute.
+          tokens_per_minute: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              instance_id: String,
+              key_id: String,
+              blocked: T::Boolean,
+              budget_resets_every: T.nilable(String),
+              expires_in: T.nilable(String),
+              max_budget: T.nilable(Float),
+              max_parallel_requests: T.nilable(Integer),
+              models: T::Array[String],
+              name: String,
+              requests_per_minute: T.nilable(Integer),
+              team_id: T.nilable(String),
+              tokens_per_minute: T.nilable(Integer),
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/agent_gateways/keys/agent_gateway_tool_permissions.rbi

@@ -0,0 +1,96 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AgentGateways
+      module Keys
+        class AgentGatewayToolPermissions < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::AgentGateways::Keys::AgentGatewayToolPermissions,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # The servers granted, each with its tools. `[]` grants none.
+          sig do
+            returns(
+              T::Array[
+                Telnyx::AgentGateways::Keys::AgentGatewayToolPermissions::Server
+              ]
+            )
+          end
+          attr_accessor :servers
+
+          sig do
+            params(
+              servers:
+                T::Array[
+                  Telnyx::AgentGateways::Keys::AgentGatewayToolPermissions::Server::OrHash
+                ]
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The servers granted, each with its tools. `[]` grants none.
+            servers:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                servers:
+                  T::Array[
+                    Telnyx::AgentGateways::Keys::AgentGatewayToolPermissions::Server
+                  ]
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Server < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::AgentGateways::Keys::AgentGatewayToolPermissions::Server,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # An MCP server's or API's `id` on the instance.
+            sig { returns(String) }
+            attr_accessor :id
+
+            # The tools the grant covers, by name without the server prefix. `[]` covers every
+            # tool the server exposes.
+            sig { returns(T.nilable(T::Array[String])) }
+            attr_reader :tools
+
+            sig { params(tools: T::Array[String]).void }
+            attr_writer :tools
+
+            sig do
+              params(id: String, tools: T::Array[String]).returns(
+                T.attached_class
+              )
+            end
+            def self.new(
+              # An MCP server's or API's `id` on the instance.
+              id:,
+              # The tools the grant covers, by name without the server prefix. `[]` covers every
+              # tool the server exposes.
+              tools: nil
+            )
+            end
+
+            sig { override.returns({ id: String, tools: T::Array[String] }) }
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/agent_gateways/keys/agent_gateway_tool_permissions_response.rbi

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

data/rbi/telnyx/models/agent_gateways/keys/tool_permission_create_params.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AgentGateways
+      module Keys
+        class ToolPermissionCreateParams < Telnyx::Models::AgentGateways::Keys::AgentGatewayToolPermissions
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::AgentGateways::Keys::ToolPermissionCreateParams,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :instance_id
+
+          sig { returns(String) }
+          attr_accessor :key_id
+
+          sig do
+            params(
+              instance_id: String,
+              key_id: String,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(instance_id:, key_id:, request_options: {})
+          end
+
+          sig do
+            override.returns(
+              {
+                instance_id: String,
+                key_id: String,
+                request_options: Telnyx::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end