telnyx 5.174.0 → 5.175.0

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

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AgentGateways
+      # @see Telnyx::Resources::AgentGateways::Guardrails#create
+      class GuardrailCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute instance_id
+        #
+        #   @return [String]
+        required :instance_id, String
+
+        # @!attribute modes
+        #   When the guardrail runs. Each type runs in some modes only.
+        #
+        #   @return [Array<Symbol, Telnyx::Models::AgentGateways::GuardrailCreateParams::Mode>]
+        required :modes,
+                 -> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::AgentGateways::GuardrailCreateParams::Mode] }
+
+        # @!attribute name
+        #   A name, unique on the instance. A request names it in its `guardrails` field.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute type
+        #   The kind of check. It cannot change after create.
+        #
+        #   @return [Symbol, Telnyx::Models::AgentGateways::GuardrailCreateParams::Type]
+        required :type, enum: -> { Telnyx::AgentGateways::GuardrailCreateParams::Type }
+
+        # @!attribute always_on
+        #   `true` runs the guardrail on every request, and a request cannot turn it off.
+        #   `false` runs it on the requests that name it.
+        #
+        #   @return [Boolean, nil]
+        optional :always_on, Telnyx::Internal::Type::Boolean
+
+        # @!attribute settings
+        #   The type's settings. `content_filter`: `patterns` (prebuilt patterns by `name`,
+        #   such as `us_ssn` or `email`), `regexes` (each a `name`, which tags masked
+        #   matches, and a `pattern`), `keywords` (each a `keyword`), and `categories` (each
+        #   a `name`), each entry with an `action` of `block` or `mask`. `tool_permission`:
+        #   `rules` (`id`, `tool_name`, `tool_type`, `decision`, `argument_patterns`), a
+        #   `default` decision, and `on_denied` (`block` or `rewrite`). `model_judge`: a
+        #   `model` on the instance and weighted `criteria` (`name`, `description`,
+        #   `weight`, the weights summing to 100). `custom_code`: `code` defining
+        #   `apply_guardrail(inputs, request_data, input_type)`. `lakera`: `api_key`,
+        #   `project_id`, `api_base`. `presidio`: `analyzer_url`, `anonymizer_url`,
+        #   `entities` (entity name to `block` or `mask`), `language`. `bedrock`:
+        #   `guardrail_id`, `version`, `region`, and `access_key_id` with
+        #   `secret_access_key`, or `role_name`. `azure_content_safety`: `api_key`,
+        #   `endpoint`, `severity` (0 to 7). Provider secrets are write-only.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :settings, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+        # @!method initialize(instance_id:, modes:, name:, type:, always_on: nil, settings: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AgentGateways::GuardrailCreateParams} for more details.
+        #
+        #   @param instance_id [String]
+        #
+        #   @param modes [Array<Symbol, Telnyx::Models::AgentGateways::GuardrailCreateParams::Mode>] When the guardrail runs. Each type runs in some modes only.
+        #
+        #   @param name [String] A name, unique on the instance. A request names it in its `guardrails` field.
+        #
+        #   @param type [Symbol, Telnyx::Models::AgentGateways::GuardrailCreateParams::Type] The kind of check. It cannot change after create.
+        #
+        #   @param always_on [Boolean] `true` runs the guardrail on every request, and a request cannot turn it off. `f
+        #
+        #   @param settings [Hash{Symbol=>Object}] The type's settings. `content_filter`: `patterns` (prebuilt patterns by `name`,
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+        module Mode
+          extend Telnyx::Internal::Type::Enum
+
+          BEFORE_REQUEST = :before_request
+          DURING_REQUEST = :during_request
+          AFTER_REQUEST = :after_request
+          LOGGING_ONLY = :logging_only
+          BEFORE_TOOL_REQUEST = :before_tool_request
+          DURING_TOOL_REQUEST = :during_tool_request
+          AFTER_TOOL_REQUEST = :after_tool_request
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The kind of check. It cannot change after create.
+        module Type
+          extend Telnyx::Internal::Type::Enum
+
+          CONTENT_FILTER = :content_filter
+          TOOL_PERMISSION = :tool_permission
+          MODEL_JUDGE = :model_judge
+          CUSTOM_CODE = :custom_code
+          LAKERA = :lakera
+          PRESIDIO = :presidio
+          BEDROCK = :bedrock
+          AZURE_CONTENT_SAFETY = :azure_content_safety
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AgentGateways
+      # @see Telnyx::Resources::AgentGateways::Guardrails#delete
+      class GuardrailDeleteParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute instance_id
+        #
+        #   @return [String]
+        required :instance_id, String
+
+        # @!attribute guardrail_id
+        #
+        #   @return [String]
+        required :guardrail_id, String
+
+        # @!method initialize(instance_id:, guardrail_id:, request_options: {})
+        #   @param instance_id [String]
+        #   @param guardrail_id [String]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AgentGateways
+      # @see Telnyx::Resources::AgentGateways::Guardrails#list
+      class GuardrailListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute instance_id
+        #
+        #   @return [String]
+        required :instance_id, String
+
+        # @!method initialize(instance_id:, request_options: {})
+        #   @param instance_id [String]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AgentGateways
+      # @see Telnyx::Resources::AgentGateways::Guardrails#list
+      class GuardrailListResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Array<Telnyx::Models::AgentGateways::AgentGatewayGuardrail>]
+        required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AgentGateways::AgentGatewayGuardrail] }
+
+        # @!method initialize(data:)
+        #   @param data [Array<Telnyx::Models::AgentGateways::AgentGatewayGuardrail>]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AgentGateways
+      # @see Telnyx::Resources::AgentGateways::Guardrails#update
+      class GuardrailUpdateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute instance_id
+        #
+        #   @return [String]
+        required :instance_id, String
+
+        # @!attribute guardrail_id
+        #
+        #   @return [String]
+        required :guardrail_id, String
+
+        # @!attribute always_on
+        #   `true` runs the guardrail on every request, and a request cannot turn it off.
+        #   `false` runs it on the requests that name it.
+        #
+        #   @return [Boolean, nil]
+        optional :always_on, Telnyx::Internal::Type::Boolean
+
+        # @!attribute modes
+        #   When the guardrail runs. Each type runs in some modes only.
+        #
+        #   @return [Array<Symbol, Telnyx::Models::AgentGateways::GuardrailUpdateParams::Mode>, nil]
+        optional :modes,
+                 -> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::AgentGateways::GuardrailUpdateParams::Mode] }
+
+        # @!attribute name
+        #   A name, unique on the instance. A request names it in its `guardrails` field.
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute settings
+        #   The type's settings. `content_filter`: `patterns` (prebuilt patterns by name,
+        #   such as `us_ssn` or `email`), `regexes`, `keywords`, and `categories` (such as
+        #   `prompt_injection`), each with an `action` of `block` or `mask`.
+        #   `tool_permission`: `rules` (`id`, `tool_name`, `tool_type`, `decision`,
+        #   `argument_patterns`), a `default` decision, and `on_denied` (`block` or
+        #   `rewrite`). `model_judge`: a `model` on the instance and weighted `criteria`
+        #   (`name`, `description`, `weight`, the weights summing to 100). `custom_code`:
+        #   `code` defining `apply_guardrail(inputs, request_data, input_type)`. `lakera`:
+        #   `api_key`, `project_id`, `api_base`. `presidio`: `analyzer_url`,
+        #   `anonymizer_url`, `entities` (entity name to `block` or `mask`), `language`.
+        #   `bedrock`: `guardrail_id`, `version`, `region`, and `access_key_id` with
+        #   `secret_access_key`, or `role_name`. `azure_content_safety`: `api_key`,
+        #   `endpoint`, `severity` (0 to 7). Provider secrets are write-only.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :settings, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+        # @!method initialize(instance_id:, guardrail_id:, always_on: nil, modes: nil, name: nil, settings: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AgentGateways::GuardrailUpdateParams} for more details.
+        #
+        #   @param instance_id [String]
+        #
+        #   @param guardrail_id [String]
+        #
+        #   @param always_on [Boolean] `true` runs the guardrail on every request, and a request cannot turn it off. `f
+        #
+        #   @param modes [Array<Symbol, Telnyx::Models::AgentGateways::GuardrailUpdateParams::Mode>] When the guardrail runs. Each type runs in some modes only.
+        #
+        #   @param name [String] A name, unique on the instance. A request names it in its `guardrails` field.
+        #
+        #   @param settings [Hash{Symbol=>Object}] The type's settings. `content_filter`: `patterns` (prebuilt patterns by name, su
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+        module Mode
+          extend Telnyx::Internal::Type::Enum
+
+          BEFORE_REQUEST = :before_request
+          DURING_REQUEST = :during_request
+          AFTER_REQUEST = :after_request
+          LOGGING_ONLY = :logging_only
+          BEFORE_TOOL_REQUEST = :before_tool_request
+          DURING_TOOL_REQUEST = :during_tool_request
+          AFTER_TOOL_REQUEST = :after_tool_request
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AgentGateways
+      # @see Telnyx::Resources::AgentGateways::Keys#create
+      class KeyCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute instance_id
+        #
+        #   @return [String]
+        required :instance_id, String
+
+        # @!attribute budget_resets_every
+        #   How often the spend resets: a number and a unit, `s`, `m`, `h`, or `d`.
+        #
+        #   @return [String, nil]
+        optional :budget_resets_every, String, nil?: true
+
+        # @!attribute expires_in
+        #   How long until the key stops working: a number and a unit, `s`, `m`, `h`, or
+        #   `d`.
+        #
+        #   @return [String, nil]
+        optional :expires_in, String, nil?: true
+
+        # @!attribute max_budget
+        #   The most the key may spend, in USD.
+        #
+        #   @return [Float, nil]
+        optional :max_budget, Float, nil?: true
+
+        # @!attribute max_parallel_requests
+        #   The most requests the key may have in flight at once.
+        #
+        #   @return [Integer, nil]
+        optional :max_parallel_requests, Integer, nil?: true
+
+        # @!attribute models
+        #   The models the key may use. Leave it out to allow every model.
+        #
+        #   @return [Array<String>, nil]
+        optional :models, Telnyx::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!attribute name
+        #   A label for people, unique on the instance.
+        #
+        #   @return [String, nil]
+        optional :name, String, nil?: true
+
+        # @!attribute requests_per_minute
+        #   The most requests the key may make per minute.
+        #
+        #   @return [Integer, nil]
+        optional :requests_per_minute, Integer, nil?: true
+
+        # @!attribute team_id
+        #   A team on the instance. The key shares the team's model list, budget, and rate
+        #   limits.
+        #
+        #   @return [String, nil]
+        optional :team_id, String, nil?: true
+
+        # @!attribute tokens_per_minute
+        #   The most tokens the key may use per minute.
+        #
+        #   @return [Integer, nil]
+        optional :tokens_per_minute, Integer, nil?: true
+
+        # @!method initialize(instance_id:, budget_resets_every: nil, expires_in: nil, max_budget: nil, max_parallel_requests: nil, models: nil, name: nil, requests_per_minute: nil, team_id: nil, tokens_per_minute: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AgentGateways::KeyCreateParams} for more details.
+        #
+        #   @param instance_id [String]
+        #
+        #   @param budget_resets_every [String, nil] How often the spend resets: a number and a unit, `s`, `m`, `h`, or `d`.
+        #
+        #   @param expires_in [String, nil] How long until the key stops working: a number and a unit, `s`, `m`, `h`, or `d`
+        #
+        #   @param max_budget [Float, nil] The most the key may spend, in USD.
+        #
+        #   @param max_parallel_requests [Integer, nil] The most requests the key may have in flight at once.
+        #
+        #   @param models [Array<String>, nil] The models the key may use. Leave it out to allow every model.
+        #
+        #   @param name [String, nil] A label for people, unique on the instance.
+        #
+        #   @param requests_per_minute [Integer, nil] The most requests the key may make per minute.
+        #
+        #   @param team_id [String, nil] A team on the instance. The key shares the team's model list, budget, and rate l
+        #
+        #   @param tokens_per_minute [Integer, nil] The most tokens the key may use per minute.
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AgentGateways
+      # @see Telnyx::Resources::AgentGateways::Keys#create
+      class KeyCreateResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #   A key that was just issued: the only response that carries its value.
+        #
+        #   @return [Telnyx::Models::AgentGateways::KeyCreateResponse::Data]
+        required :data, -> { Telnyx::Models::AgentGateways::KeyCreateResponse::Data }
+
+        # @!method initialize(data:)
+        #   @param data [Telnyx::Models::AgentGateways::KeyCreateResponse::Data] A key that was just issued: the only response that carries its value.
+
+        # @see Telnyx::Models::AgentGateways::KeyCreateResponse#data
+        class Data < Telnyx::Internal::Type::BaseModel
+          # @!attribute id
+          #   Identifies the key. It is a 64-character hash the instance stores in place of
+          #   the key's value.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute blocked
+          #   Whether the instance refuses the key.
+          #
+          #   @return [Boolean]
+          required :blocked, Telnyx::Internal::Type::Boolean
+
+          # @!attribute budget_resets_at
+          #   When the key's spend next resets.
+          #
+          #   @return [Time, nil]
+          required :budget_resets_at, Time, nil?: true
+
+          # @!attribute budget_resets_every
+          #   How often the key's spend resets, such as `30d`.
+          #
+          #   @return [String, nil]
+          required :budget_resets_every, String, nil?: true
+
+          # @!attribute created_at
+          #   When the key was issued.
+          #
+          #   @return [Time, nil]
+          required :created_at, Time, nil?: true
+
+          # @!attribute expires_at
+          #   When the key stops working; `null` when it does not expire.
+          #
+          #   @return [Time, nil]
+          required :expires_at, Time, nil?: true
+
+          # @!attribute key
+          #   The key's value, sent as `Authorization: Bearer <key>` to the instance. Shown
+          #   only in this response.
+          #
+          #   @return [String]
+          required :key, String
+
+          # @!attribute max_budget
+          #   The most the key may spend, in USD, until its budget resets.
+          #
+          #   @return [Float, nil]
+          required :max_budget, Float, nil?: true
+
+          # @!attribute max_parallel_requests
+          #   The most requests the key may have in flight at once.
+          #
+          #   @return [Integer, nil]
+          required :max_parallel_requests, Integer, nil?: true
+
+          # @!attribute models
+          #   The models the key may use. Empty means every model the instance serves.
+          #
+          #   @return [Array<String>]
+          required :models, Telnyx::Internal::Type::ArrayOf[String]
+
+          # @!attribute name
+          #   A label for people; `null` when none was given.
+          #
+          #   @return [String, nil]
+          required :name, String, nil?: true
+
+          # @!attribute requests_per_minute
+          #   The most requests the key may make per minute.
+          #
+          #   @return [Integer, nil]
+          required :requests_per_minute, Integer, nil?: true
+
+          # @!attribute spend
+          #   What the key has spent since its budget last reset, in USD.
+          #
+          #   @return [Float]
+          required :spend, Float
+
+          # @!attribute team_id
+          #   The team the key belongs to, if any.
+          #
+          #   @return [String, nil]
+          required :team_id, String, nil?: true
+
+          # @!attribute tokens_per_minute
+          #   The most tokens the key may use per minute.
+          #
+          #   @return [Integer, nil]
+          required :tokens_per_minute, Integer, nil?: true
+
+          # @!method initialize(id:, blocked:, budget_resets_at:, budget_resets_every:, created_at:, expires_at:, key:, max_budget:, max_parallel_requests:, models:, name:, requests_per_minute:, spend:, team_id:, tokens_per_minute:)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::AgentGateways::KeyCreateResponse::Data} for more details.
+          #
+          #   A key that was just issued: the only response that carries its value.
+          #
+          #   @param id [String] Identifies the key. It is a 64-character hash the instance stores in place of th
+          #
+          #   @param blocked [Boolean] Whether the instance refuses the key.
+          #
+          #   @param budget_resets_at [Time, nil] When the key's spend next resets.
+          #
+          #   @param budget_resets_every [String, nil] How often the key's spend resets, such as `30d`.
+          #
+          #   @param created_at [Time, nil] When the key was issued.
+          #
+          #   @param expires_at [Time, nil] When the key stops working; `null` when it does not expire.
+          #
+          #   @param key [String] The key's value, sent as `Authorization: Bearer <key>` to the instance. Shown on
+          #
+          #   @param max_budget [Float, nil] The most the key may spend, in USD, until its budget resets.
+          #
+          #   @param max_parallel_requests [Integer, nil] The most requests the key may have in flight at once.
+          #
+          #   @param models [Array<String>] The models the key may use. Empty means every model the instance serves.
+          #
+          #   @param name [String, nil] A label for people; `null` when none was given.
+          #
+          #   @param requests_per_minute [Integer, nil] The most requests the key may make per minute.
+          #
+          #   @param spend [Float] What the key has spent since its budget last reset, in USD.
+          #
+          #   @param team_id [String, nil] The team the key belongs to, if any.
+          #
+          #   @param tokens_per_minute [Integer, nil] The most tokens the key may use per minute.
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AgentGateways
+      # @see Telnyx::Resources::AgentGateways::Keys#delete
+      class KeyDeleteParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute instance_id
+        #
+        #   @return [String]
+        required :instance_id, String
+
+        # @!attribute key_id
+        #
+        #   @return [String]
+        required :key_id, String
+
+        # @!method initialize(instance_id:, key_id:, request_options: {})
+        #   @param instance_id [String]
+        #   @param key_id [String]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AgentGateways
+      # @see Telnyx::Resources::AgentGateways::Keys#list
+      class KeyListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute instance_id
+        #
+        #   @return [String]
+        required :instance_id, String
+
+        # @!attribute team_id
+        #   Only the keys of this team.
+        #
+        #   @return [String, nil]
+        optional :team_id, String
+
+        # @!method initialize(instance_id:, team_id: nil, request_options: {})
+        #   @param instance_id [String]
+        #
+        #   @param team_id [String] Only the keys of this team.
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AgentGateways
+      # @see Telnyx::Resources::AgentGateways::Keys#list
+      class KeyListResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Array<Telnyx::Models::AgentGateways::AgentGatewayKey>]
+        required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AgentGateways::AgentGatewayKey] }
+
+        # @!method initialize(data:)
+        #   @param data [Array<Telnyx::Models::AgentGateways::AgentGatewayKey>]
+      end
+    end
+  end
+end