telnyx 5.174.0 → 5.175.0

data/rbi/telnyx/resources/agent_gateways/mcp_servers.rbi

@@ -0,0 +1,157 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class AgentGateways
+      # MCP servers on an instance, served to agents at one MCP endpoint.
+      class McpServers
+        # Adds an MCP server. The instance serves its tools at `{gateway_url}/mcp`, each
+        # named with the server's `name` and a hyphen, to the keys granted the server and,
+        # with `open_to_every_key`, to every key. The instance must be `ready`; otherwise
+        # the request answers `409`.
+        sig do
+          params(
+            instance_id: String,
+            name: String,
+            url: String,
+            auth:
+              T.any(
+                Telnyx::AgentGateways::AgentGatewayNoAuth::OrHash,
+                Telnyx::AgentGateways::AgentGatewayStaticAuth::OrHash,
+                Telnyx::AgentGateways::AgentGatewayOAuthClientCredentials::OrHash,
+                Telnyx::AgentGateways::AgentGatewayPassthroughAuth::OrHash,
+                Telnyx::AgentGateways::AgentGatewayAwsSigV4Auth::OrHash
+              ),
+            forwarded_headers: T::Array[String],
+            open_to_every_key: T::Boolean,
+            static_headers: T::Hash[Symbol, String],
+            tools: T::Array[String],
+            transport:
+              Telnyx::AgentGateways::McpServerCreateParams::Transport::OrSymbol,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::AgentGateways::AgentGatewayMcpServerResponse)
+        end
+        def create(
+          # The Agent Gateway's `id`.
+          instance_id,
+          # A name for the server, unique on the instance across MCP servers and APIs,
+          # regardless of case. Up to 100 letters, digits, `_`, and `.`. The gateway
+          # prefixes the server's tools with it and a hyphen.
+          name:,
+          # The server's MCP endpoint, `http` or `https`.
+          url:,
+          # How the gateway authenticates to the server. Replaced whole on an update;
+          # `{"type": "none"}` removes the credential.
+          auth: nil,
+          # Headers copied from the agent's request, by name.
+          forwarded_headers: nil,
+          # `true` lets every key on the instance use the server, granted or not.
+          open_to_every_key: nil,
+          # Headers sent on every request.
+          static_headers: nil,
+          # The tools the server exposes to every key, by name. `[]` exposes every tool.
+          tools: nil,
+          # `http` for Streamable HTTP, or `sse` for Server-Sent Events.
+          transport: nil,
+          request_options: {}
+        )
+        end
+
+        # Changes an MCP server's settings. A field left out stays as it is. `auth` is
+        # replaced whole, `tools: []` exposes every tool, and `static_headers: {}` clears
+        # the headers. The instance must be `ready`; otherwise the request answers `409`.
+        sig do
+          params(
+            server_id: String,
+            instance_id: String,
+            auth:
+              T.any(
+                Telnyx::AgentGateways::AgentGatewayNoAuth::OrHash,
+                Telnyx::AgentGateways::AgentGatewayStaticAuth::OrHash,
+                Telnyx::AgentGateways::AgentGatewayOAuthClientCredentials::OrHash,
+                Telnyx::AgentGateways::AgentGatewayPassthroughAuth::OrHash,
+                Telnyx::AgentGateways::AgentGatewayAwsSigV4Auth::OrHash
+              ),
+            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::McpServerUpdateParams::Transport::OrSymbol,
+            url: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::AgentGateways::AgentGatewayMcpServerResponse)
+        end
+        def update(
+          # Path param: The MCP server's `id`.
+          server_id,
+          # Path param: The Agent Gateway's `id`.
+          instance_id:,
+          # Body param: How the gateway authenticates to the server. Replaced whole on an
+          # update; `{"type": "none"}` removes the credential.
+          auth: nil,
+          # Body param: Headers copied from the agent's request, by name.
+          forwarded_headers: nil,
+          # Body param: 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: nil,
+          # Body param: `true` lets every key on the instance use the server, granted or
+          # not.
+          open_to_every_key: nil,
+          # Body param: Headers sent on every request.
+          static_headers: nil,
+          # Body param: The tools the server exposes to every key, by name. `[]` exposes
+          # every tool.
+          tools: nil,
+          # Body param: `http` for Streamable HTTP, or `sse` for Server-Sent Events.
+          transport: nil,
+          # Body param: The server's MCP endpoint, `http` or `https`.
+          url: nil,
+          request_options: {}
+        )
+        end
+
+        # Lists the MCP servers the instance serves at `{gateway_url}/mcp`, without their
+        # credentials. The instance must be `ready`; otherwise the request answers `409`.
+        sig do
+          params(
+            instance_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Models::AgentGateways::McpServerListResponse)
+        end
+        def list(
+          # The Agent Gateway's `id`.
+          instance_id,
+          request_options: {}
+        )
+        end
+
+        # Removes an MCP server and returns it as it was. Its `id` stays in the tool
+        # permissions that name it until they are next set. The instance must be `ready`;
+        # otherwise the request answers `409`.
+        sig do
+          params(
+            server_id: String,
+            instance_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::AgentGateways::AgentGatewayMcpServerResponse)
+        end
+        def delete(
+          # The MCP server's `id`.
+          server_id,
+          # The Agent Gateway's `id`.
+          instance_id:,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Telnyx::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/agent_gateways/policies.rbi

@@ -0,0 +1,151 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class AgentGateways
+      # Named sets of guardrails an instance applies to requests.
+      class Policies
+        # Creates a named set of guardrails. It applies from the next request on, to the
+        # requests that name it in `policies` and to those its
+        # [attachments](https://developers.telnyx.com/api-reference/agent-gateway-policy-attachments/attach-a-policy)
+        # match.
+        sig do
+          params(
+            instance_id: String,
+            name: String,
+            base: T.nilable(String),
+            description: T.nilable(String),
+            guardrails:
+              Telnyx::AgentGateways::AgentGatewayPolicyGuardrails::OrHash,
+            model: T.nilable(String),
+            pipeline:
+              T.nilable(
+                Telnyx::AgentGateways::AgentGatewayPolicyPipeline::OrHash
+              ),
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::AgentGateways::AgentGatewayPolicyResponse)
+        end
+        def create(
+          # The Agent Gateway's `id`.
+          instance_id,
+          # A name, unique on the instance. A request names the policy in its `policies`
+          # field.
+          name:,
+          # A policy this one builds on, by name. The policy starts with the base's
+          # guardrails.
+          base: nil,
+          # What the policy is for.
+          description: nil,
+          # The guardrails a policy adds to its base's, and the ones it removes from them,
+          # by name.
+          guardrails: nil,
+          # A condition on the model, by name or regular expression. The policy's guardrails
+          # run only on requests for a matching model. `null` matches every model.
+          model: nil,
+          # Ordered steps that run in place of the policy's guardrails running
+          # independently.
+          pipeline: nil,
+          request_options: {}
+        )
+        end
+
+        # Returns one policy, in its current version.
+        sig do
+          params(
+            name: String,
+            instance_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::AgentGateways::AgentGatewayPolicyResponse)
+        end
+        def retrieve(
+          # The policy's `name`.
+          name,
+          # The Agent Gateway's `id`.
+          instance_id:,
+          request_options: {}
+        )
+        end
+
+        # Changes a policy, which publishes a new version of it. A field left out stays as
+        # it is; `guardrails` and `pipeline` are replaced whole, and `model: null` removes
+        # the condition.
+        sig do
+          params(
+            name: String,
+            instance_id: String,
+            base: T.nilable(String),
+            description: T.nilable(String),
+            guardrails:
+              Telnyx::AgentGateways::AgentGatewayPolicyGuardrails::OrHash,
+            model: T.nilable(String),
+            pipeline:
+              T.nilable(
+                Telnyx::AgentGateways::AgentGatewayPolicyPipeline::OrHash
+              ),
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::AgentGateways::AgentGatewayPolicyResponse)
+        end
+        def update(
+          # Path param: The policy's `name`.
+          name,
+          # Path param: The Agent Gateway's `id`.
+          instance_id:,
+          # Body param: A policy this one builds on, by name. The policy starts with the
+          # base's guardrails.
+          base: nil,
+          # Body param: What the policy is for.
+          description: nil,
+          # Body param: The guardrails a policy adds to its base's, and the ones it removes
+          # from them, by name.
+          guardrails: nil,
+          # Body param: A condition on the model, by name or regular expression. The
+          # policy's guardrails run only on requests for a matching model. `null` matches
+          # every model.
+          model: nil,
+          # Body param: Ordered steps that run in place of the policy's guardrails running
+          # independently.
+          pipeline: nil,
+          request_options: {}
+        )
+        end
+
+        # Lists the instance's policies, each in its current version.
+        sig do
+          params(
+            instance_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Models::AgentGateways::PolicyListResponse)
+        end
+        def list(
+          # The Agent Gateway's `id`.
+          instance_id,
+          request_options: {}
+        )
+        end
+
+        # Deletes a policy and every version of it, and returns it as it was. A policy
+        # that an attachment names, or that another policy builds on, cannot be deleted.
+        sig do
+          params(
+            name: String,
+            instance_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::AgentGateways::AgentGatewayPolicyResponse)
+        end
+        def delete(
+          # The policy's `name`.
+          name,
+          # The Agent Gateway's `id`.
+          instance_id:,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Telnyx::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/agent_gateways/policy_attachments.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class AgentGateways
+      # Where an instance applies each policy.
+      class PolicyAttachments
+        # Applies a policy to every request, or to the requests for the models named. It
+        # applies from the next request on.
+        sig do
+          params(
+            instance_id: String,
+            policy: String,
+            default: T::Boolean,
+            models: T::Array[String],
+            priority: T.nilable(Integer),
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::AgentGateways::AgentGatewayPolicyAttachmentResponse)
+        end
+        def create(
+          # The Agent Gateway's `id`.
+          instance_id,
+          # The policy to apply, by name.
+          policy:,
+          # `true` applies the policy only to the requests no other attachment matches.
+          default: nil,
+          # The models whose requests the policy applies to, by name. A name can use `*` as
+          # a wildcard. Empty applies the policy to every request.
+          models: nil,
+          # An attachment with a priority applies before the others.
+          priority: nil,
+          request_options: {}
+        )
+        end
+
+        # Lists where the instance applies each policy.
+        sig do
+          params(
+            instance_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Models::AgentGateways::PolicyAttachmentListResponse)
+        end
+        def list(
+          # The Agent Gateway's `id`.
+          instance_id,
+          request_options: {}
+        )
+        end
+
+        # Removes an attachment and returns it as it was. The policy stays.
+        sig do
+          params(
+            attachment_id: String,
+            instance_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::AgentGateways::AgentGatewayPolicyAttachmentResponse)
+        end
+        def delete(
+          # The attachment's `id`.
+          attachment_id,
+          # The Agent Gateway's `id`.
+          instance_id:,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Telnyx::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/resources/agent_gateways/teams/tool_permissions.rbi

@@ -0,0 +1,67 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class AgentGateways
+      class Teams
+        # The MCP servers and tools a key or team may use.
+        class ToolPermissions
+          # Replaces the grant whole and returns it. Every server must be one of the
+          # instance's MCP servers or APIs, named once. A key reaches the servers granted to
+          # it or to its team, and the servers open to every key; when both grant, only the
+          # servers in both. The instance must be `ready`; otherwise the request answers
+          # `409`.
+          sig do
+            params(
+              team_id: String,
+              instance_id: String,
+              servers:
+                T::Array[
+                  Telnyx::AgentGateways::Keys::AgentGatewayToolPermissions::Server::OrHash
+                ],
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(
+              Telnyx::AgentGateways::Keys::AgentGatewayToolPermissionsResponse
+            )
+          end
+          def create(
+            # Path param: The team's `id`.
+            team_id,
+            # Path param: The Agent Gateway's `id`.
+            instance_id:,
+            # Body param: The servers granted, each with its tools. `[]` grants none.
+            servers:,
+            request_options: {}
+          )
+          end
+
+          # Returns the MCP servers and APIs the team's keys may use, and the tools within
+          # each. `servers: []` means none. The instance must be `ready`; otherwise the
+          # request answers `409`.
+          sig do
+            params(
+              team_id: String,
+              instance_id: String,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(
+              Telnyx::AgentGateways::Keys::AgentGatewayToolPermissionsResponse
+            )
+          end
+          def list(
+            # The team's `id`.
+            team_id,
+            # The Agent Gateway's `id`.
+            instance_id:,
+            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/agent_gateways/teams.rbi

@@ -0,0 +1,131 @@
+# typed: strong
+
+module Telnyx
+  module Resources
+    class AgentGateways
+      # Teams on an instance: shared model lists, budgets, and rate limits.
+      class Teams
+        # The MCP servers and tools a key or team may use.
+        sig do
+          returns(Telnyx::Resources::AgentGateways::Teams::ToolPermissions)
+        end
+        attr_reader :tool_permissions
+
+        # Creates a team on the instance. A team is a model list, a budget, and rate
+        # limits that its keys share. Names need not be unique; the `id` identifies the
+        # team. The instance must be `ready`; otherwise the request answers `409`.
+        sig do
+          params(
+            instance_id: String,
+            name: String,
+            budget_resets_every: T.nilable(String),
+            max_budget: T.nilable(Float),
+            models: T.nilable(T::Array[String]),
+            requests_per_minute: T.nilable(Integer),
+            tokens_per_minute: T.nilable(Integer),
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::AgentGateways::AgentGatewayTeamResponse)
+        end
+        def create(
+          # The Agent Gateway's `id`.
+          instance_id,
+          # A label for people.
+          name:,
+          # How often the spend resets: a number and a unit, `s`, `m`, `h`, or `d`.
+          budget_resets_every: nil,
+          # The most the team's keys may spend together, in USD.
+          max_budget: nil,
+          # The models the team's keys may use. Leave it out to allow every model.
+          models: nil,
+          # The most requests the team's keys may make per minute, together.
+          requests_per_minute: nil,
+          # The most tokens the team's keys may use per minute, together.
+          tokens_per_minute: nil,
+          request_options: {}
+        )
+        end
+
+        # Changes a team's settings. A field left out stays as it is, and `null` clears
+        # it. `models: []` lifts the model restriction. Setting `blocked` to `true` makes
+        # the instance refuse every key in the team with `401`. The instance must be
+        # `ready`; otherwise the request answers `409`.
+        sig do
+          params(
+            team_id: String,
+            instance_id: String,
+            blocked: T::Boolean,
+            budget_resets_every: T.nilable(String),
+            max_budget: T.nilable(Float),
+            models: T::Array[String],
+            name: String,
+            requests_per_minute: T.nilable(Integer),
+            tokens_per_minute: T.nilable(Integer),
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::AgentGateways::AgentGatewayTeamResponse)
+        end
+        def update(
+          # Path param: The team's `id`.
+          team_id,
+          # Path param: The Agent Gateway's `id`.
+          instance_id:,
+          # Body param: `true` makes the instance refuse every key in the team; `false` lets
+          # them through again.
+          blocked: nil,
+          # Body param: How often the spend resets.
+          budget_resets_every: nil,
+          # Body param: The most the team's keys may spend together, in USD.
+          max_budget: nil,
+          # Body param: The models the team's keys may use. `[]` allows every model.
+          models: nil,
+          # Body param: A label for people.
+          name: nil,
+          # Body param: The most requests the team's keys may make per minute, together.
+          requests_per_minute: nil,
+          # Body param: The most tokens the team's keys may use per minute, together.
+          tokens_per_minute: nil,
+          request_options: {}
+        )
+        end
+
+        # Lists the instance's teams. The instance must be `ready`; otherwise the request
+        # answers `409`.
+        sig do
+          params(
+            instance_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::Models::AgentGateways::TeamListResponse)
+        end
+        def list(
+          # The Agent Gateway's `id`.
+          instance_id,
+          request_options: {}
+        )
+        end
+
+        # Deletes a team that has no keys and returns it. A team that still has keys
+        # answers `409`; delete or move its keys first. The instance must be `ready`;
+        # otherwise the request answers `409`.
+        sig do
+          params(
+            team_id: String,
+            instance_id: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(Telnyx::AgentGateways::AgentGatewayTeamResponse)
+        end
+        def delete(
+          # The team's `id`.
+          team_id,
+          # The Agent Gateway's `id`.
+          instance_id:,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Telnyx::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end