telnyx 5.174.0 → 5.175.0

data/lib/telnyx/models/agent_gateways/agent_gateway_mcp_server.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AgentGateways
+      class AgentGatewayMcpServer < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #   Identifies the server.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute auth
+        #   The server's outbound authentication method. Credentials are never returned.
+        #
+        #   @return [Telnyx::Models::AgentGateways::AgentGatewayShownAuth]
+        required :auth, -> { Telnyx::AgentGateways::AgentGatewayShownAuth }
+
+        # @!attribute created_at
+        #
+        #   @return [Time, nil]
+        required :created_at, Time, nil?: true
+
+        # @!attribute forwarded_headers
+        #   Headers copied from the agent's request, by name.
+        #
+        #   @return [Array<String>]
+        required :forwarded_headers, Telnyx::Internal::Type::ArrayOf[String]
+
+        # @!attribute name
+        #   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.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute open_to_every_key
+        #   `true` lets every key on the instance use the server, granted or not.
+        #
+        #   @return [Boolean]
+        required :open_to_every_key, Telnyx::Internal::Type::Boolean
+
+        # @!attribute static_headers
+        #   Headers sent on every request.
+        #
+        #   @return [Hash{Symbol=>String}]
+        required :static_headers, Telnyx::Internal::Type::HashOf[String]
+
+        # @!attribute tools
+        #   The tools the server exposes to every key, by name. `[]` exposes every tool.
+        #
+        #   @return [Array<String>]
+        required :tools, Telnyx::Internal::Type::ArrayOf[String]
+
+        # @!attribute transport
+        #   `http` for Streamable HTTP, or `sse` for Server-Sent Events.
+        #
+        #   @return [Symbol, Telnyx::Models::AgentGateways::AgentGatewayMcpServer::Transport]
+        required :transport, enum: -> { Telnyx::AgentGateways::AgentGatewayMcpServer::Transport }
+
+        # @!attribute updated_at
+        #
+        #   @return [Time, nil]
+        required :updated_at, Time, nil?: true
+
+        # @!attribute url
+        #   The server's MCP endpoint.
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!method initialize(id:, auth:, created_at:, forwarded_headers:, name:, open_to_every_key:, static_headers:, tools:, transport:, updated_at:, url:)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AgentGateways::AgentGatewayMcpServer} for more details.
+        #
+        #   @param id [String] Identifies the server.
+        #
+        #   @param auth [Telnyx::Models::AgentGateways::AgentGatewayShownAuth] The server's outbound authentication method. Credentials are never returned.
+        #
+        #   @param created_at [Time, nil]
+        #
+        #   @param forwarded_headers [Array<String>] Headers copied from the agent's request, by name.
+        #
+        #   @param name [String] A name for the server, unique on the instance across MCP servers and APIs, regar
+        #
+        #   @param open_to_every_key [Boolean] `true` lets every key on the instance use the server, granted or not.
+        #
+        #   @param static_headers [Hash{Symbol=>String}] Headers sent on every request.
+        #
+        #   @param tools [Array<String>] The tools the server exposes to every key, by name. `[]` exposes every tool.
+        #
+        #   @param transport [Symbol, Telnyx::Models::AgentGateways::AgentGatewayMcpServer::Transport] `http` for Streamable HTTP, or `sse` for Server-Sent Events.
+        #
+        #   @param updated_at [Time, nil]
+        #
+        #   @param url [String] The server's MCP endpoint.
+
+        # `http` for Streamable HTTP, or `sse` for Server-Sent Events.
+        #
+        # @see Telnyx::Models::AgentGateways::AgentGatewayMcpServer#transport
+        module Transport
+          extend Telnyx::Internal::Type::Enum
+
+          HTTP = :http
+          SSE = :sse
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+
+    AgentGatewayMcpServer = AgentGateways::AgentGatewayMcpServer
+  end
+end

data/lib/telnyx/models/agent_gateways/agent_gateway_mcp_server_response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AgentGateways
+      # @see Telnyx::Resources::AgentGateways::McpServers#create
+      class AgentGatewayMcpServerResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Telnyx::Models::AgentGateways::AgentGatewayMcpServer]
+        required :data, -> { Telnyx::AgentGateways::AgentGatewayMcpServer }
+
+        # @!method initialize(data:)
+        #   @param data [Telnyx::Models::AgentGateways::AgentGatewayMcpServer]
+      end
+    end
+
+    AgentGatewayMcpServerResponse = AgentGateways::AgentGatewayMcpServerResponse
+  end
+end

data/lib/telnyx/models/agent_gateways/agent_gateway_no_auth.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AgentGateways
+      class AgentGatewayNoAuth < Telnyx::Internal::Type::BaseModel
+        # @!attribute type
+        #
+        #   @return [Symbol, Telnyx::Models::AgentGateways::AgentGatewayNoAuth::Type, nil]
+        optional :type, enum: -> { Telnyx::AgentGateways::AgentGatewayNoAuth::Type }
+
+        # @!method initialize(type: nil)
+        #   The gateway sends no credential.
+        #
+        #   @param type [Symbol, Telnyx::Models::AgentGateways::AgentGatewayNoAuth::Type]
+
+        # @see Telnyx::Models::AgentGateways::AgentGatewayNoAuth#type
+        module Type
+          extend Telnyx::Internal::Type::Enum
+
+          NONE = :none
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+
+    AgentGatewayNoAuth = AgentGateways::AgentGatewayNoAuth
+  end
+end

data/lib/telnyx/models/agent_gateways/agent_gateway_oauth_client_credentials.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AgentGateways
+      class AgentGatewayOAuthClientCredentials < Telnyx::Internal::Type::BaseModel
+        # @!attribute token_url
+        #   The OAuth provider's token endpoint.
+        #
+        #   @return [String]
+        required :token_url, String
+
+        # @!attribute type
+        #
+        #   @return [Symbol, :oauth_client_credentials]
+        required :type, const: :oauth_client_credentials
+
+        # @!attribute audience
+        #   The token's audience, sent in the token request.
+        #
+        #   @return [String, nil]
+        optional :audience, String, nil?: true
+
+        # @!attribute credentials_in
+        #   Whether the client ID and secret go in the token request's body or as HTTP Basic
+        #   authentication.
+        #
+        #   @return [Symbol, Telnyx::Models::AgentGateways::AgentGatewayOAuthClientCredentials::CredentialsIn, nil]
+        optional :credentials_in,
+                 enum: -> { Telnyx::AgentGateways::AgentGatewayOAuthClientCredentials::CredentialsIn }
+
+        # @!attribute resource
+        #   The resource the token is for, sent in the token request.
+        #
+        #   @return [String, nil]
+        optional :resource, String, nil?: true
+
+        # @!attribute scopes
+        #   The scopes to request.
+        #
+        #   @return [Array<String>, nil]
+        optional :scopes, Telnyx::Internal::Type::ArrayOf[String]
+
+        request_only do
+          # @!attribute client_id
+          #
+          #   @return [String]
+          required :client_id, String
+
+          # @!attribute client_secret
+          #
+          #   @return [String]
+          required :client_secret, String
+        end
+
+        # @!method initialize(client_id:, client_secret:, token_url:, audience: nil, credentials_in: nil, resource: nil, scopes: nil, type: :oauth_client_credentials)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AgentGateways::AgentGatewayOAuthClientCredentials} for more
+        #   details.
+        #
+        #   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.
+        #
+        #   @param client_id [String]
+        #
+        #   @param client_secret [String]
+        #
+        #   @param token_url [String] The OAuth provider's token endpoint.
+        #
+        #   @param audience [String, nil] The token's audience, sent in the token request.
+        #
+        #   @param credentials_in [Symbol, Telnyx::Models::AgentGateways::AgentGatewayOAuthClientCredentials::CredentialsIn] Whether the client ID and secret go in the token request's body or as HTTP Basic
+        #
+        #   @param resource [String, nil] The resource the token is for, sent in the token request.
+        #
+        #   @param scopes [Array<String>] The scopes to request.
+        #
+        #   @param type [Symbol, :oauth_client_credentials]
+
+        # Whether the client ID and secret go in the token request's body or as HTTP Basic
+        # authentication.
+        #
+        # @see Telnyx::Models::AgentGateways::AgentGatewayOAuthClientCredentials#credentials_in
+        module CredentialsIn
+          extend Telnyx::Internal::Type::Enum
+
+          BODY = :body
+          BASIC = :basic
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+
+    AgentGatewayOAuthClientCredentials = AgentGateways::AgentGatewayOAuthClientCredentials
+  end
+end

data/lib/telnyx/models/agent_gateways/agent_gateway_passthrough_auth.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AgentGateways
+      class AgentGatewayPassthroughAuth < Telnyx::Internal::Type::BaseModel
+        # @!attribute type
+        #
+        #   @return [Symbol, Telnyx::Models::AgentGateways::AgentGatewayPassthroughAuth::Type, nil]
+        optional :type, enum: -> { Telnyx::AgentGateways::AgentGatewayPassthroughAuth::Type }
+
+        # @!method initialize(type: nil)
+        #   The gateway forwards the agent's own `Authorization` header to the server
+        #   unchanged.
+        #
+        #   @param type [Symbol, Telnyx::Models::AgentGateways::AgentGatewayPassthroughAuth::Type]
+
+        # @see Telnyx::Models::AgentGateways::AgentGatewayPassthroughAuth#type
+        module Type
+          extend Telnyx::Internal::Type::Enum
+
+          PASSTHROUGH = :passthrough
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+
+    AgentGatewayPassthroughAuth = AgentGateways::AgentGatewayPassthroughAuth
+  end
+end

data/lib/telnyx/models/agent_gateways/agent_gateway_policy.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AgentGateways
+      class AgentGatewayPolicy < Telnyx::Internal::Type::BaseModel
+        # @!attribute base
+        #   A policy this one builds on, by name. The policy starts with the base's
+        #   guardrails.
+        #
+        #   @return [String, nil]
+        required :base, String, nil?: true
+
+        # @!attribute created_at
+        #   When the policy's current version was created. An update creates a new version.
+        #
+        #   @return [Time, nil]
+        required :created_at, Time, nil?: true
+
+        # @!attribute description
+        #   What the policy is for.
+        #
+        #   @return [String, nil]
+        required :description, String, nil?: true
+
+        # @!attribute guardrails
+        #   The guardrails a policy adds to its base's, and the ones it removes from them,
+        #   by name.
+        #
+        #   @return [Telnyx::Models::AgentGateways::AgentGatewayPolicyGuardrails]
+        required :guardrails, -> { Telnyx::AgentGateways::AgentGatewayPolicyGuardrails }
+
+        # @!attribute model
+        #   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.
+        #
+        #   @return [String, nil]
+        required :model, String, nil?: true
+
+        # @!attribute name
+        #   A name, unique on the instance. A request names the policy in its `policies`
+        #   field.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute pipeline
+        #   Ordered steps that run in place of the policy's guardrails running
+        #   independently.
+        #
+        #   @return [Telnyx::Models::AgentGateways::AgentGatewayPolicyPipeline, nil]
+        required :pipeline, -> { Telnyx::AgentGateways::AgentGatewayPolicyPipeline }, nil?: true
+
+        # @!attribute updated_at
+        #   When the policy last changed.
+        #
+        #   @return [Time, nil]
+        required :updated_at, Time, nil?: true
+
+        # @!method initialize(base:, created_at:, description:, guardrails:, model:, name:, pipeline:, updated_at:)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AgentGateways::AgentGatewayPolicy} for more details.
+        #
+        #   A named set of guardrails.
+        #
+        #   @param base [String, nil] A policy this one builds on, by name. The policy starts with the base's guardrai
+        #
+        #   @param created_at [Time, nil] When the policy's current version was created. An update creates a new version.
+        #
+        #   @param description [String, nil] What the policy is for.
+        #
+        #   @param guardrails [Telnyx::Models::AgentGateways::AgentGatewayPolicyGuardrails] The guardrails a policy adds to its base's, and the ones it removes from them, b
+        #
+        #   @param model [String, nil] A condition on the model, by name or regular expression. The policy's guardrails
+        #
+        #   @param name [String] A name, unique on the instance. A request names the policy in its `policies` fie
+        #
+        #   @param pipeline [Telnyx::Models::AgentGateways::AgentGatewayPolicyPipeline, nil] Ordered steps that run in place of the policy's guardrails running independently
+        #
+        #   @param updated_at [Time, nil] When the policy last changed.
+      end
+    end
+
+    AgentGatewayPolicy = AgentGateways::AgentGatewayPolicy
+  end
+end

data/lib/telnyx/models/agent_gateways/agent_gateway_policy_attachment.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AgentGateways
+      class AgentGatewayPolicyAttachment < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #   The attachment's ID.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute created_at
+        #   When the attachment was created.
+        #
+        #   @return [Time, nil]
+        required :created_at, Time, nil?: true
+
+        # @!attribute default
+        #   `true` applies the policy only to the requests no other attachment matches.
+        #
+        #   @return [Boolean]
+        required :default, Telnyx::Internal::Type::Boolean
+
+        # @!attribute models
+        #   The models whose requests the policy applies to, by name. A name can use `*` as
+        #   a wildcard. Empty applies the policy to every request.
+        #
+        #   @return [Array<String>]
+        required :models, Telnyx::Internal::Type::ArrayOf[String]
+
+        # @!attribute policy
+        #   The policy to apply, by name.
+        #
+        #   @return [String]
+        required :policy, String
+
+        # @!attribute priority
+        #   An attachment with a priority applies before the others.
+        #
+        #   @return [Integer, nil]
+        required :priority, Integer, nil?: true
+
+        # @!attribute updated_at
+        #   When the attachment last changed.
+        #
+        #   @return [Time, nil]
+        required :updated_at, Time, nil?: true
+
+        # @!method initialize(id:, created_at:, default:, models:, policy:, priority:, updated_at:)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AgentGateways::AgentGatewayPolicyAttachment} for more details.
+        #
+        #   Where an instance applies a policy.
+        #
+        #   @param id [String] The attachment's ID.
+        #
+        #   @param created_at [Time, nil] When the attachment was created.
+        #
+        #   @param default [Boolean] `true` applies the policy only to the requests no other attachment matches.
+        #
+        #   @param models [Array<String>] The models whose requests the policy applies to, by name. A name can use `*` as
+        #
+        #   @param policy [String] The policy to apply, by name.
+        #
+        #   @param priority [Integer, nil] An attachment with a priority applies before the others.
+        #
+        #   @param updated_at [Time, nil] When the attachment last changed.
+      end
+    end
+
+    AgentGatewayPolicyAttachment = AgentGateways::AgentGatewayPolicyAttachment
+  end
+end

data/lib/telnyx/models/agent_gateways/agent_gateway_policy_attachment_response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AgentGateways
+      # @see Telnyx::Resources::AgentGateways::PolicyAttachments#create
+      class AgentGatewayPolicyAttachmentResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #   Where an instance applies a policy.
+        #
+        #   @return [Telnyx::Models::AgentGateways::AgentGatewayPolicyAttachment]
+        required :data, -> { Telnyx::AgentGateways::AgentGatewayPolicyAttachment }
+
+        # @!method initialize(data:)
+        #   @param data [Telnyx::Models::AgentGateways::AgentGatewayPolicyAttachment] Where an instance applies a policy.
+      end
+    end
+
+    AgentGatewayPolicyAttachmentResponse = AgentGateways::AgentGatewayPolicyAttachmentResponse
+  end
+end

data/lib/telnyx/models/agent_gateways/agent_gateway_policy_guardrails.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AgentGateways
+      class AgentGatewayPolicyGuardrails < Telnyx::Internal::Type::BaseModel
+        # @!attribute add
+        #   Guardrails the policy runs in addition to its base's.
+        #
+        #   @return [Array<String>, nil]
+        optional :add, Telnyx::Internal::Type::ArrayOf[String]
+
+        # @!attribute remove
+        #   Guardrails from its base that the policy does not run.
+        #
+        #   @return [Array<String>, nil]
+        optional :remove, Telnyx::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(add: nil, remove: nil)
+        #   The guardrails a policy adds to its base's, and the ones it removes from them,
+        #   by name.
+        #
+        #   @param add [Array<String>] Guardrails the policy runs in addition to its base's.
+        #
+        #   @param remove [Array<String>] Guardrails from its base that the policy does not run.
+      end
+    end
+
+    AgentGatewayPolicyGuardrails = AgentGateways::AgentGatewayPolicyGuardrails
+  end
+end

data/lib/telnyx/models/agent_gateways/agent_gateway_policy_pipeline.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AgentGateways
+      class AgentGatewayPolicyPipeline < Telnyx::Internal::Type::BaseModel
+        # @!attribute hook
+        #   `before_request` runs the steps on the request, and `after_request` on the
+        #   model's response.
+        #
+        #   @return [Symbol, Telnyx::Models::AgentGateways::AgentGatewayPolicyPipeline::Hook]
+        required :hook, enum: -> { Telnyx::AgentGateways::AgentGatewayPolicyPipeline::Hook }
+
+        # @!attribute steps
+        #
+        #   @return [Array<Telnyx::Models::AgentGateways::AgentGatewayPolicyStep>]
+        required :steps, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AgentGateways::AgentGatewayPolicyStep] }
+
+        # @!method initialize(hook:, steps:)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AgentGateways::AgentGatewayPolicyPipeline} for more details.
+        #
+        #   Ordered steps that run in place of the policy's guardrails running
+        #   independently.
+        #
+        #   @param hook [Symbol, Telnyx::Models::AgentGateways::AgentGatewayPolicyPipeline::Hook] `before_request` runs the steps on the request, and `after_request` on the model
+        #
+        #   @param steps [Array<Telnyx::Models::AgentGateways::AgentGatewayPolicyStep>]
+
+        # `before_request` runs the steps on the request, and `after_request` on the
+        # model's response.
+        #
+        # @see Telnyx::Models::AgentGateways::AgentGatewayPolicyPipeline#hook
+        module Hook
+          extend Telnyx::Internal::Type::Enum
+
+          BEFORE_REQUEST = :before_request
+          AFTER_REQUEST = :after_request
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+
+    AgentGatewayPolicyPipeline = AgentGateways::AgentGatewayPolicyPipeline
+  end
+end

data/lib/telnyx/models/agent_gateways/agent_gateway_policy_response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AgentGateways
+      # @see Telnyx::Resources::AgentGateways::Policies#create
+      class AgentGatewayPolicyResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #   A named set of guardrails.
+        #
+        #   @return [Telnyx::Models::AgentGateways::AgentGatewayPolicy]
+        required :data, -> { Telnyx::AgentGateways::AgentGatewayPolicy }
+
+        # @!method initialize(data:)
+        #   @param data [Telnyx::Models::AgentGateways::AgentGatewayPolicy] A named set of guardrails.
+      end
+    end
+
+    AgentGatewayPolicyResponse = AgentGateways::AgentGatewayPolicyResponse
+  end
+end