telnyx 5.170.0 → 5.171.0

data/lib/telnyx/models/llm_token_gateway/token_key_create_params.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module LlmTokenGateway
+      # @see Telnyx::Resources::LlmTokenGateway::TokenKeys#create
+      class TokenKeyCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute token_group_id
+        #
+        #   @return [String]
+        required :token_group_id, String
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String]
+        required :idempotency_key, String
+
+        # @!attribute allowed_models
+        #
+        #   @return [Array<String>, nil]
+        optional :allowed_models, Telnyx::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!attribute blocked
+        #
+        #   @return [Boolean, nil]
+        optional :blocked, Telnyx::Internal::Type::Boolean
+
+        # @!attribute budget_duration
+        #
+        #   @return [Symbol, Telnyx::Models::LlmTokenGateway::BudgetDuration, nil]
+        optional :budget_duration, enum: -> { Telnyx::LlmTokenGateway::BudgetDuration }, nil?: true
+
+        # @!attribute expires_at
+        #
+        #   @return [Time, nil]
+        optional :expires_at, Time, nil?: true
+
+        # @!attribute max_budget
+        #   USD, decimal precision at most 6 places; parse exactly to integer micro-USD,
+        #   never binary float accounting.
+        #
+        #   @return [Float, nil]
+        optional :max_budget, Float, nil?: true
+
+        # @!attribute max_parallel_requests
+        #   Optional maximum concurrent reserved/dispatched cache misses across replicas.
+        #   Null means no concurrency cap. Cache hits do not consume slots; unknown usage
+        #   retains its budget hold without a slot.
+        #
+        #   @return [Integer, nil]
+        optional :max_parallel_requests, Integer, nil?: true
+
+        # @!attribute required_end_user_id
+        #   Require a nonempty caller-asserted end-user ID; not proof of identity.
+        #
+        #   @return [Boolean, nil]
+        optional :required_end_user_id, Telnyx::Internal::Type::Boolean
+
+        # @!attribute rpm_limit
+        #   Omitted or null defaults to the maximum (6000) (on a blocked key, null is kept
+        #   until the key is unblocked); a value below the minimum (1) or above the maximum
+        #   is rejected with 400 limit_out_of_range; a malformed value (negative, wrong type
+        #   or precision) is 400 invalid_request. Block the key (blocked: true) to deny it;
+        #   blocking is always accepted.
+        #
+        #   @return [Integer, nil]
+        optional :rpm_limit, Integer, nil?: true
+
+        # @!attribute token_user_id
+        #
+        #   @return [String, nil]
+        optional :token_user_id, String, nil?: true
+
+        # @!attribute tpm_limit
+        #   Omitted or null defaults to the maximum (10000000) (on a blocked key, null is
+        #   kept until the key is unblocked); a value below the minimum (1) or above the
+        #   maximum is rejected with 400 limit_out_of_range; a malformed value (negative,
+        #   wrong type or precision) is 400 invalid_request. Block the key (blocked: true)
+        #   to deny it; blocking is always accepted.
+        #
+        #   @return [Integer, nil]
+        optional :tpm_limit, Integer, nil?: true
+
+        # @!method initialize(name:, token_group_id:, idempotency_key:, allowed_models: nil, blocked: nil, budget_duration: nil, expires_at: nil, max_budget: nil, max_parallel_requests: nil, required_end_user_id: nil, rpm_limit: nil, token_user_id: nil, tpm_limit: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::LlmTokenGateway::TokenKeyCreateParams} for more details.
+        #
+        #   @param name [String]
+        #
+        #   @param token_group_id [String]
+        #
+        #   @param idempotency_key [String]
+        #
+        #   @param allowed_models [Array<String>, nil]
+        #
+        #   @param blocked [Boolean]
+        #
+        #   @param budget_duration [Symbol, Telnyx::Models::LlmTokenGateway::BudgetDuration, nil]
+        #
+        #   @param expires_at [Time, nil]
+        #
+        #   @param max_budget [Float, nil] USD, decimal precision at most 6 places; parse exactly to integer micro-USD, nev
+        #
+        #   @param max_parallel_requests [Integer, nil] Optional maximum concurrent reserved/dispatched cache misses across replicas. Nu
+        #
+        #   @param required_end_user_id [Boolean] Require a nonempty caller-asserted end-user ID; not proof of identity.
+        #
+        #   @param rpm_limit [Integer, nil] Omitted or null defaults to the maximum (6000) (on a blocked key, null is kept u
+        #
+        #   @param token_user_id [String, nil]
+        #
+        #   @param tpm_limit [Integer, nil] Omitted or null defaults to the maximum (10000000) (on a blocked key, null is ke
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/llm_token_gateway/token_key_delete_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module LlmTokenGateway
+      # @see Telnyx::Resources::LlmTokenGateway::TokenKeys#delete
+      class TokenKeyDeleteParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String]
+        required :idempotency_key, String
+
+        # @!attribute if_match
+        #
+        #   @return [String]
+        required :if_match, String
+
+        # @!method initialize(id:, idempotency_key:, if_match:, request_options: {})
+        #   @param id [String]
+        #   @param idempotency_key [String]
+        #   @param if_match [String]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/llm_token_gateway/token_key_list_params.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module LlmTokenGateway
+      # @see Telnyx::Resources::LlmTokenGateway::TokenKeys#list
+      class TokenKeyListParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute page_number
+        #
+        #   @return [Integer, nil]
+        optional :page_number, Integer
+
+        # @!attribute page_size
+        #
+        #   @return [Integer, nil]
+        optional :page_size, Integer
+
+        # @!attribute page_snapshot
+        #   Required after page 1; account/filter-bound 15-minute stable snapshot;
+        #   expired/mismatch 409.
+        #
+        #   @return [String, nil]
+        optional :page_snapshot, String
+
+        # @!attribute token_group_id
+        #
+        #   @return [String, nil]
+        optional :token_group_id, String
+
+        # @!attribute token_user_id
+        #
+        #   @return [String, nil]
+        optional :token_user_id, String
+
+        # @!method initialize(page_number: nil, page_size: nil, page_snapshot: nil, token_group_id: nil, token_user_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::LlmTokenGateway::TokenKeyListParams} for more details.
+        #
+        #   @param page_number [Integer]
+        #
+        #   @param page_size [Integer]
+        #
+        #   @param page_snapshot [String] Required after page 1; account/filter-bound 15-minute stable snapshot; expired/m
+        #
+        #   @param token_group_id [String]
+        #
+        #   @param token_user_id [String]
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/llm_token_gateway/token_key_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module LlmTokenGateway
+      # @see Telnyx::Resources::LlmTokenGateway::TokenKeys#create
+      class TokenKeyResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Telnyx::Models::LlmTokenGateway::TokenKey]
+        required :data, -> { Telnyx::LlmTokenGateway::TokenKey }
+
+        # @!method initialize(data:)
+        #   @param data [Telnyx::Models::LlmTokenGateway::TokenKey]
+      end
+    end
+  end
+end

data/lib/telnyx/models/llm_token_gateway/token_key_retrieve_params.rb

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

data/lib/telnyx/models/llm_token_gateway/token_key_update_params.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module LlmTokenGateway
+      # @see Telnyx::Resources::LlmTokenGateway::TokenKeys#update
+      class TokenKeyUpdateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String]
+        required :idempotency_key, String
+
+        # @!attribute if_match
+        #
+        #   @return [String]
+        required :if_match, String
+
+        # @!attribute allowed_models
+        #
+        #   @return [Array<String>, nil]
+        optional :allowed_models, Telnyx::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!attribute blocked
+        #
+        #   @return [Boolean, nil]
+        optional :blocked, Telnyx::Internal::Type::Boolean
+
+        # @!attribute budget_duration
+        #
+        #   @return [Symbol, Telnyx::Models::LlmTokenGateway::BudgetDuration, nil]
+        optional :budget_duration, enum: -> { Telnyx::LlmTokenGateway::BudgetDuration }, nil?: true
+
+        # @!attribute expires_at
+        #
+        #   @return [Time, nil]
+        optional :expires_at, Time, nil?: true
+
+        # @!attribute max_budget
+        #   USD, decimal precision at most 6 places; parse exactly to integer micro-USD,
+        #   never binary float accounting.
+        #
+        #   @return [Float, nil]
+        optional :max_budget, Float, nil?: true
+
+        # @!attribute max_parallel_requests
+        #   Optional maximum concurrent reserved/dispatched cache misses across replicas.
+        #   Null means no concurrency cap. Cache hits do not consume slots; unknown usage
+        #   retains its budget hold without a slot.
+        #
+        #   @return [Integer, nil]
+        optional :max_parallel_requests, Integer, nil?: true
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute required_end_user_id
+        #   Require a nonempty caller-asserted end-user ID; not proof of identity. Omission
+        #   preserves the current requirement.
+        #
+        #   @return [Boolean, nil]
+        optional :required_end_user_id, Telnyx::Internal::Type::Boolean
+
+        # @!attribute rpm_limit
+        #   Omitted or null defaults to the maximum (6000) (on a blocked key, null is kept
+        #   until the key is unblocked); a value below the minimum (1) or above the maximum
+        #   is rejected with 400 limit_out_of_range; a malformed value (negative, wrong type
+        #   or precision) is 400 invalid_request. Block the key (blocked: true) to deny it;
+        #   blocking is always accepted.
+        #
+        #   @return [Integer, nil]
+        optional :rpm_limit, Integer, nil?: true
+
+        # @!attribute tpm_limit
+        #   Omitted or null defaults to the maximum (10000000) (on a blocked key, null is
+        #   kept until the key is unblocked); a value below the minimum (1) or above the
+        #   maximum is rejected with 400 limit_out_of_range; a malformed value (negative,
+        #   wrong type or precision) is 400 invalid_request. Block the key (blocked: true)
+        #   to deny it; blocking is always accepted.
+        #
+        #   @return [Integer, nil]
+        optional :tpm_limit, Integer, nil?: true
+
+        # @!method initialize(id:, idempotency_key:, if_match:, allowed_models: nil, blocked: nil, budget_duration: nil, expires_at: nil, max_budget: nil, max_parallel_requests: nil, name: nil, required_end_user_id: nil, rpm_limit: nil, tpm_limit: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::LlmTokenGateway::TokenKeyUpdateParams} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param idempotency_key [String]
+        #
+        #   @param if_match [String]
+        #
+        #   @param allowed_models [Array<String>, nil]
+        #
+        #   @param blocked [Boolean]
+        #
+        #   @param budget_duration [Symbol, Telnyx::Models::LlmTokenGateway::BudgetDuration, nil]
+        #
+        #   @param expires_at [Time, nil]
+        #
+        #   @param max_budget [Float, nil] USD, decimal precision at most 6 places; parse exactly to integer micro-USD, nev
+        #
+        #   @param max_parallel_requests [Integer, nil] Optional maximum concurrent reserved/dispatched cache misses across replicas. Nu
+        #
+        #   @param name [String]
+        #
+        #   @param required_end_user_id [Boolean] Require a nonempty caller-asserted end-user ID; not proof of identity. Omission
+        #
+        #   @param rpm_limit [Integer, nil] Omitted or null defaults to the maximum (6000) (on a blocked key, null is kept u
+        #
+        #   @param tpm_limit [Integer, nil] Omitted or null defaults to the maximum (10000000) (on a blocked key, null is ke
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/llm_token_gateway/usage_retrieve_export_params.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module LlmTokenGateway
+      # @see Telnyx::Resources::LlmTokenGateway::Usage#retrieve_export
+      class UsageRetrieveExportParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute cursor
+        #   Opaque next_cursor from a previous page; not combinable with start_time. Bound
+        #   to the requested types; the account always comes from the credential.
+        #
+        #   @return [String, nil]
+        optional :cursor, String
+
+        # @!attribute limit
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!attribute start_time
+        #   First page only: RFC 3339 with offset, at most 30 days ago and not in the
+        #   future; default now - 24h.
+        #
+        #   @return [Time, nil]
+        optional :start_time, Time
+
+        # @!attribute types
+        #   Comma-separated subset of inference.request,guardrail.evaluation; default both.
+        #
+        #   @return [String, nil]
+        optional :types, String
+
+        # @!method initialize(cursor: nil, limit: nil, start_time: nil, types: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::LlmTokenGateway::UsageRetrieveExportParams} for more details.
+        #
+        #   @param cursor [String] Opaque next_cursor from a previous page; not combinable with start_time. Bound t
+        #
+        #   @param limit [Integer]
+        #
+        #   @param start_time [Time] First page only: RFC 3339 with offset, at most 30 days ago and not in the future
+        #
+        #   @param types [String] Comma-separated subset of inference.request,guardrail.evaluation; default both.
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end