telnyx 5.174.0 → 5.175.0

data/rbi/telnyx/models/agent_gateways/agent_gateway_passthrough_auth.rbi

@@ -0,0 +1,87 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    AgentGatewayPassthroughAuth = AgentGateways::AgentGatewayPassthroughAuth
+
+    module AgentGateways
+      class AgentGatewayPassthroughAuth < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::AgentGateways::AgentGatewayPassthroughAuth,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::AgentGateways::AgentGatewayPassthroughAuth::Type::OrSymbol
+            )
+          )
+        end
+        attr_reader :type
+
+        sig do
+          params(
+            type:
+              Telnyx::AgentGateways::AgentGatewayPassthroughAuth::Type::OrSymbol
+          ).void
+        end
+        attr_writer :type
+
+        # The gateway forwards the agent's own `Authorization` header to the server
+        # unchanged.
+        sig do
+          params(
+            type:
+              Telnyx::AgentGateways::AgentGatewayPassthroughAuth::Type::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(type: nil)
+        end
+
+        sig do
+          override.returns(
+            {
+              type:
+                Telnyx::AgentGateways::AgentGatewayPassthroughAuth::Type::OrSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Type
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::AgentGateways::AgentGatewayPassthroughAuth::Type
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PASSTHROUGH =
+            T.let(
+              :passthrough,
+              Telnyx::AgentGateways::AgentGatewayPassthroughAuth::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::AgentGateways::AgentGatewayPassthroughAuth::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/agent_gateways/agent_gateway_policy.rbi

@@ -0,0 +1,136 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    AgentGatewayPolicy = AgentGateways::AgentGatewayPolicy
+
+    module AgentGateways
+      class AgentGatewayPolicy < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::AgentGateways::AgentGatewayPolicy,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # A policy this one builds on, by name. The policy starts with the base's
+        # guardrails.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :base
+
+        # When the policy's current version was created. An update creates a new version.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :created_at
+
+        # What the policy is for.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
+        # The guardrails a policy adds to its base's, and the ones it removes from them,
+        # by name.
+        sig { returns(Telnyx::AgentGateways::AgentGatewayPolicyGuardrails) }
+        attr_reader :guardrails
+
+        sig do
+          params(
+            guardrails:
+              Telnyx::AgentGateways::AgentGatewayPolicyGuardrails::OrHash
+          ).void
+        end
+        attr_writer :guardrails
+
+        # 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.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :model
+
+        # A name, unique on the instance. A request names the policy in its `policies`
+        # field.
+        sig { returns(String) }
+        attr_accessor :name
+
+        # Ordered steps that run in place of the policy's guardrails running
+        # independently.
+        sig do
+          returns(T.nilable(Telnyx::AgentGateways::AgentGatewayPolicyPipeline))
+        end
+        attr_reader :pipeline
+
+        sig do
+          params(
+            pipeline:
+              T.nilable(
+                Telnyx::AgentGateways::AgentGatewayPolicyPipeline::OrHash
+              )
+          ).void
+        end
+        attr_writer :pipeline
+
+        # When the policy last changed.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :updated_at
+
+        # A named set of guardrails.
+        sig do
+          params(
+            base: T.nilable(String),
+            created_at: T.nilable(Time),
+            description: T.nilable(String),
+            guardrails:
+              Telnyx::AgentGateways::AgentGatewayPolicyGuardrails::OrHash,
+            model: T.nilable(String),
+            name: String,
+            pipeline:
+              T.nilable(
+                Telnyx::AgentGateways::AgentGatewayPolicyPipeline::OrHash
+              ),
+            updated_at: T.nilable(Time)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # A policy this one builds on, by name. The policy starts with the base's
+          # guardrails.
+          base:,
+          # When the policy's current version was created. An update creates a new version.
+          created_at:,
+          # What the policy is for.
+          description:,
+          # The guardrails a policy adds to its base's, and the ones it removes from them,
+          # by name.
+          guardrails:,
+          # 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:,
+          # A name, unique on the instance. A request names the policy in its `policies`
+          # field.
+          name:,
+          # Ordered steps that run in place of the policy's guardrails running
+          # independently.
+          pipeline:,
+          # When the policy last changed.
+          updated_at:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              base: T.nilable(String),
+              created_at: T.nilable(Time),
+              description: T.nilable(String),
+              guardrails: Telnyx::AgentGateways::AgentGatewayPolicyGuardrails,
+              model: T.nilable(String),
+              name: String,
+              pipeline:
+                T.nilable(Telnyx::AgentGateways::AgentGatewayPolicyPipeline),
+              updated_at: T.nilable(Time)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/agent_gateways/agent_gateway_policy_attachment.rbi

@@ -0,0 +1,95 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    AgentGatewayPolicyAttachment = AgentGateways::AgentGatewayPolicyAttachment
+
+    module AgentGateways
+      class AgentGatewayPolicyAttachment < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::AgentGateways::AgentGatewayPolicyAttachment,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # The attachment's ID.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # When the attachment was created.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :created_at
+
+        # `true` applies the policy only to the requests no other attachment matches.
+        sig { returns(T::Boolean) }
+        attr_accessor :default
+
+        # The models whose requests the policy applies to, by name. A name can use `*` as
+        # a wildcard. Empty applies the policy to every request.
+        sig { returns(T::Array[String]) }
+        attr_accessor :models
+
+        # The policy to apply, by name.
+        sig { returns(String) }
+        attr_accessor :policy
+
+        # An attachment with a priority applies before the others.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :priority
+
+        # When the attachment last changed.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :updated_at
+
+        # Where an instance applies a policy.
+        sig do
+          params(
+            id: String,
+            created_at: T.nilable(Time),
+            default: T::Boolean,
+            models: T::Array[String],
+            policy: String,
+            priority: T.nilable(Integer),
+            updated_at: T.nilable(Time)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The attachment's ID.
+          id:,
+          # When the attachment was created.
+          created_at:,
+          # `true` applies the policy only to the requests no other attachment matches.
+          default:,
+          # 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:,
+          # The policy to apply, by name.
+          policy:,
+          # An attachment with a priority applies before the others.
+          priority:,
+          # When the attachment last changed.
+          updated_at:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: T.nilable(Time),
+              default: T::Boolean,
+              models: T::Array[String],
+              policy: String,
+              priority: T.nilable(Integer),
+              updated_at: T.nilable(Time)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/agent_gateways/agent_gateway_policy_attachment_response.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    AgentGatewayPolicyAttachmentResponse =
+      AgentGateways::AgentGatewayPolicyAttachmentResponse
+
+    module AgentGateways
+      class AgentGatewayPolicyAttachmentResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::AgentGateways::AgentGatewayPolicyAttachmentResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Where an instance applies a policy.
+        sig { returns(Telnyx::AgentGateways::AgentGatewayPolicyAttachment) }
+        attr_reader :data
+
+        sig do
+          params(
+            data: Telnyx::AgentGateways::AgentGatewayPolicyAttachment::OrHash
+          ).void
+        end
+        attr_writer :data
+
+        sig do
+          params(
+            data: Telnyx::AgentGateways::AgentGatewayPolicyAttachment::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Where an instance applies a policy.
+          data:
+        )
+        end
+
+        sig do
+          override.returns(
+            { data: Telnyx::AgentGateways::AgentGatewayPolicyAttachment }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/agent_gateways/agent_gateway_policy_guardrails.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    AgentGatewayPolicyGuardrails = AgentGateways::AgentGatewayPolicyGuardrails
+
+    module AgentGateways
+      class AgentGatewayPolicyGuardrails < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::AgentGateways::AgentGatewayPolicyGuardrails,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Guardrails the policy runs in addition to its base's.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :add
+
+        sig { params(add: T::Array[String]).void }
+        attr_writer :add
+
+        # Guardrails from its base that the policy does not run.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :remove
+
+        sig { params(remove: T::Array[String]).void }
+        attr_writer :remove
+
+        # The guardrails a policy adds to its base's, and the ones it removes from them,
+        # by name.
+        sig do
+          params(add: T::Array[String], remove: T::Array[String]).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Guardrails the policy runs in addition to its base's.
+          add: nil,
+          # Guardrails from its base that the policy does not run.
+          remove: nil
+        )
+        end
+
+        sig do
+          override.returns({ add: T::Array[String], remove: T::Array[String] })
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/agent_gateways/agent_gateway_policy_pipeline.rbi

@@ -0,0 +1,97 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    AgentGatewayPolicyPipeline = AgentGateways::AgentGatewayPolicyPipeline
+
+    module AgentGateways
+      class AgentGatewayPolicyPipeline < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::AgentGateways::AgentGatewayPolicyPipeline,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # `before_request` runs the steps on the request, and `after_request` on the
+        # model's response.
+        sig do
+          returns(
+            Telnyx::AgentGateways::AgentGatewayPolicyPipeline::Hook::OrSymbol
+          )
+        end
+        attr_accessor :hook
+
+        sig { returns(T::Array[Telnyx::AgentGateways::AgentGatewayPolicyStep]) }
+        attr_accessor :steps
+
+        # Ordered steps that run in place of the policy's guardrails running
+        # independently.
+        sig do
+          params(
+            hook:
+              Telnyx::AgentGateways::AgentGatewayPolicyPipeline::Hook::OrSymbol,
+            steps:
+              T::Array[Telnyx::AgentGateways::AgentGatewayPolicyStep::OrHash]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # `before_request` runs the steps on the request, and `after_request` on the
+          # model's response.
+          hook:,
+          steps:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              hook:
+                Telnyx::AgentGateways::AgentGatewayPolicyPipeline::Hook::OrSymbol,
+              steps: T::Array[Telnyx::AgentGateways::AgentGatewayPolicyStep]
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # `before_request` runs the steps on the request, and `after_request` on the
+        # model's response.
+        module Hook
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::AgentGateways::AgentGatewayPolicyPipeline::Hook
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          BEFORE_REQUEST =
+            T.let(
+              :before_request,
+              Telnyx::AgentGateways::AgentGatewayPolicyPipeline::Hook::TaggedSymbol
+            )
+          AFTER_REQUEST =
+            T.let(
+              :after_request,
+              Telnyx::AgentGateways::AgentGatewayPolicyPipeline::Hook::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::AgentGateways::AgentGatewayPolicyPipeline::Hook::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/agent_gateways/agent_gateway_policy_response.rbi

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