telnyx 5.170.0 → 5.171.0

data/sig/telnyx/models/llm_token_gateway/spend_retrieve_summary_params.rbs

@@ -0,0 +1,94 @@
+module Telnyx
+  module Models
+    module LlmTokenGateway
+      type spend_retrieve_summary_params =
+        {
+          end_date: Date,
+          group_by: Telnyx::Models::LlmTokenGateway::spend_group_by,
+          start_date: Date,
+          end_user_id: String,
+          metadata: ::Hash[Symbol, String],
+          page_number: Integer,
+          page_size: Integer,
+          page_snapshot: String,
+          token_group_id: String,
+          token_key_id: String,
+          token_user_id: String
+        }
+        & Telnyx::Internal::Type::request_parameters
+
+      class SpendRetrieveSummaryParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        attr_accessor end_date: Date
+
+        attr_accessor group_by: Telnyx::Models::LlmTokenGateway::spend_group_by
+
+        attr_accessor start_date: Date
+
+        attr_reader end_user_id: String?
+
+        def end_user_id=: (String) -> String
+
+        attr_reader metadata: ::Hash[Symbol, String]?
+
+        def metadata=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
+
+        attr_reader page_number: Integer?
+
+        def page_number=: (Integer) -> Integer
+
+        attr_reader page_size: Integer?
+
+        def page_size=: (Integer) -> Integer
+
+        attr_reader page_snapshot: String?
+
+        def page_snapshot=: (String) -> String
+
+        attr_reader token_group_id: String?
+
+        def token_group_id=: (String) -> String
+
+        attr_reader token_key_id: String?
+
+        def token_key_id=: (String) -> String
+
+        attr_reader token_user_id: String?
+
+        def token_user_id=: (String) -> String
+
+        def initialize: (
+          end_date: Date,
+          group_by: Telnyx::Models::LlmTokenGateway::spend_group_by,
+          start_date: Date,
+          ?end_user_id: String,
+          ?metadata: ::Hash[Symbol, String],
+          ?page_number: Integer,
+          ?page_size: Integer,
+          ?page_snapshot: String,
+          ?token_group_id: String,
+          ?token_key_id: String,
+          ?token_user_id: String,
+          ?request_options: Telnyx::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          end_date: Date,
+          group_by: Telnyx::Models::LlmTokenGateway::spend_group_by,
+          start_date: Date,
+          end_user_id: String,
+          metadata: ::Hash[Symbol, String],
+          page_number: Integer,
+          page_size: Integer,
+          page_snapshot: String,
+          token_group_id: String,
+          token_key_id: String,
+          token_user_id: String,
+          request_options: Telnyx::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/telnyx/models/llm_token_gateway/spend_retrieve_summary_response.rbs

@@ -0,0 +1,153 @@
+module Telnyx
+  module Models
+    module LlmTokenGateway
+      type spend_retrieve_summary_response =
+        {
+          data: ::Array[Telnyx::Models::LlmTokenGateway::SpendRetrieveSummaryResponse::Data],
+          meta: Telnyx::Models::LlmTokenGateway::SpendRetrieveSummaryResponse::Meta
+        }
+
+      class SpendRetrieveSummaryResponse < Telnyx::Internal::Type::BaseModel
+        attr_accessor data: ::Array[Telnyx::Models::LlmTokenGateway::SpendRetrieveSummaryResponse::Data]
+
+        attr_accessor meta: Telnyx::Models::LlmTokenGateway::SpendRetrieveSummaryResponse::Meta
+
+        def initialize: (
+          data: ::Array[Telnyx::Models::LlmTokenGateway::SpendRetrieveSummaryResponse::Data],
+          meta: Telnyx::Models::LlmTokenGateway::SpendRetrieveSummaryResponse::Meta
+        ) -> void
+
+        def to_hash: -> {
+          data: ::Array[Telnyx::Models::LlmTokenGateway::SpendRetrieveSummaryResponse::Data],
+          meta: Telnyx::Models::LlmTokenGateway::SpendRetrieveSummaryResponse::Meta
+        }
+
+        type data =
+          {
+            dimension_id: String?,
+            input_tokens: Integer,
+            name: String?,
+            output_tokens: Integer,
+            requests: Integer,
+            reserved_spend: Float,
+            spend: Float,
+            unknown_requests: Integer,
+            end_user_id: String?,
+            metadata_key: String,
+            token_group_id: String?,
+            token_key_id: String?,
+            token_user_id: String?
+          }
+
+        class Data < Telnyx::Internal::Type::BaseModel
+          attr_accessor dimension_id: String?
+
+          attr_accessor input_tokens: Integer
+
+          attr_accessor name: String?
+
+          attr_accessor output_tokens: Integer
+
+          attr_accessor requests: Integer
+
+          attr_accessor reserved_spend: Float
+
+          attr_accessor spend: Float
+
+          attr_accessor unknown_requests: Integer
+
+          attr_accessor end_user_id: String?
+
+          attr_reader metadata_key: String?
+
+          def metadata_key=: (String) -> String
+
+          attr_accessor token_group_id: String?
+
+          attr_accessor token_key_id: String?
+
+          attr_accessor token_user_id: String?
+
+          def initialize: (
+            dimension_id: String?,
+            input_tokens: Integer,
+            name: String?,
+            output_tokens: Integer,
+            requests: Integer,
+            reserved_spend: Float,
+            spend: Float,
+            unknown_requests: Integer,
+            ?end_user_id: String?,
+            ?metadata_key: String,
+            ?token_group_id: String?,
+            ?token_key_id: String?,
+            ?token_user_id: String?
+          ) -> void
+
+          def to_hash: -> {
+            dimension_id: String?,
+            input_tokens: Integer,
+            name: String?,
+            output_tokens: Integer,
+            requests: Integer,
+            reserved_spend: Float,
+            spend: Float,
+            unknown_requests: Integer,
+            end_user_id: String?,
+            metadata_key: String,
+            token_group_id: String?,
+            token_key_id: String?,
+            token_user_id: String?
+          }
+        end
+
+        type meta =
+          {
+            end_date: Date,
+            group_by: Telnyx::Models::LlmTokenGateway::spend_group_by,
+            has_more: bool,
+            page_number: Integer,
+            page_size: Integer,
+            snapshot: String,
+            start_date: Date
+          }
+
+        class Meta < Telnyx::Internal::Type::BaseModel
+          attr_accessor end_date: Date
+
+          attr_accessor group_by: Telnyx::Models::LlmTokenGateway::spend_group_by
+
+          attr_accessor has_more: bool
+
+          attr_accessor page_number: Integer
+
+          attr_accessor page_size: Integer
+
+          attr_accessor snapshot: String
+
+          attr_accessor start_date: Date
+
+          def initialize: (
+            end_date: Date,
+            group_by: Telnyx::Models::LlmTokenGateway::spend_group_by,
+            has_more: bool,
+            page_number: Integer,
+            page_size: Integer,
+            snapshot: String,
+            start_date: Date
+          ) -> void
+
+          def to_hash: -> {
+            end_date: Date,
+            group_by: Telnyx::Models::LlmTokenGateway::spend_group_by,
+            has_more: bool,
+            page_number: Integer,
+            page_size: Integer,
+            snapshot: String,
+            start_date: Date
+          }
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/models/llm_token_gateway/token_group.rbs

@@ -0,0 +1,356 @@
+module Telnyx
+  module Models
+    module LlmTokenGateway
+      type token_group =
+        {
+          id: String,
+          allowed_models: ::Array[String],
+          blocked: bool,
+          budget_duration: Telnyx::Models::LlmTokenGateway::budget_duration?,
+          budget_started_at: Time?,
+          cache_ttl: Integer?,
+          created_at: Time,
+          fallbacks: ::Hash[Symbol, ::Array[String]]?,
+          guardrails: Telnyx::LlmTokenGateway::TokenGroup::Guardrails?,
+          max_budget: Float?,
+          name: String,
+          provider_key_ids: ::Array[String],
+          record_type: :token_group,
+          reserved_spend: Float,
+          resets_at: Time?,
+          retries: Telnyx::LlmTokenGateway::TokenGroup::Retries?,
+          rpm_limit: Integer?,
+          spend: Float,
+          tpm_limit: Integer?,
+          updated_at: Time,
+          version: Integer,
+          max_parallel_requests: Integer?
+        }
+
+      class TokenGroup < Telnyx::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor allowed_models: ::Array[String]
+
+        attr_accessor blocked: bool
+
+        attr_accessor budget_duration: Telnyx::Models::LlmTokenGateway::budget_duration?
+
+        attr_accessor budget_started_at: Time?
+
+        attr_accessor cache_ttl: Integer?
+
+        attr_accessor created_at: Time
+
+        attr_accessor fallbacks: ::Hash[Symbol, ::Array[String]]?
+
+        attr_accessor guardrails: Telnyx::LlmTokenGateway::TokenGroup::Guardrails?
+
+        attr_accessor max_budget: Float?
+
+        attr_accessor name: String
+
+        attr_accessor provider_key_ids: ::Array[String]
+
+        attr_accessor record_type: :token_group
+
+        attr_accessor reserved_spend: Float
+
+        attr_accessor resets_at: Time?
+
+        attr_accessor retries: Telnyx::LlmTokenGateway::TokenGroup::Retries?
+
+        attr_accessor rpm_limit: Integer?
+
+        attr_accessor spend: Float
+
+        attr_accessor tpm_limit: Integer?
+
+        attr_accessor updated_at: Time
+
+        attr_accessor version: Integer
+
+        attr_accessor max_parallel_requests: Integer?
+
+        def initialize: (
+          id: String,
+          allowed_models: ::Array[String],
+          blocked: bool,
+          budget_duration: Telnyx::Models::LlmTokenGateway::budget_duration?,
+          budget_started_at: Time?,
+          cache_ttl: Integer?,
+          created_at: Time,
+          fallbacks: ::Hash[Symbol, ::Array[String]]?,
+          guardrails: Telnyx::LlmTokenGateway::TokenGroup::Guardrails?,
+          max_budget: Float?,
+          name: String,
+          provider_key_ids: ::Array[String],
+          reserved_spend: Float,
+          resets_at: Time?,
+          retries: Telnyx::LlmTokenGateway::TokenGroup::Retries?,
+          rpm_limit: Integer?,
+          spend: Float,
+          tpm_limit: Integer?,
+          updated_at: Time,
+          version: Integer,
+          ?max_parallel_requests: Integer?,
+          ?record_type: :token_group
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          allowed_models: ::Array[String],
+          blocked: bool,
+          budget_duration: Telnyx::Models::LlmTokenGateway::budget_duration?,
+          budget_started_at: Time?,
+          cache_ttl: Integer?,
+          created_at: Time,
+          fallbacks: ::Hash[Symbol, ::Array[String]]?,
+          guardrails: Telnyx::LlmTokenGateway::TokenGroup::Guardrails?,
+          max_budget: Float?,
+          name: String,
+          provider_key_ids: ::Array[String],
+          record_type: :token_group,
+          reserved_spend: Float,
+          resets_at: Time?,
+          retries: Telnyx::LlmTokenGateway::TokenGroup::Retries?,
+          rpm_limit: Integer?,
+          spend: Float,
+          tpm_limit: Integer?,
+          updated_at: Time,
+          version: Integer,
+          max_parallel_requests: Integer?
+        }
+
+        type guardrails =
+          {
+            dlp: Telnyx::LlmTokenGateway::TokenGroup::Guardrails::Dlp,
+            secrets: Telnyx::LlmTokenGateway::TokenGroup::Guardrails::Secrets,
+            streaming: Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::streaming
+          }
+
+        class Guardrails < Telnyx::Internal::Type::BaseModel
+          attr_reader dlp: Telnyx::LlmTokenGateway::TokenGroup::Guardrails::Dlp?
+
+          def dlp=: (
+            Telnyx::LlmTokenGateway::TokenGroup::Guardrails::Dlp
+          ) -> Telnyx::LlmTokenGateway::TokenGroup::Guardrails::Dlp
+
+          attr_reader secrets: Telnyx::LlmTokenGateway::TokenGroup::Guardrails::Secrets?
+
+          def secrets=: (
+            Telnyx::LlmTokenGateway::TokenGroup::Guardrails::Secrets
+          ) -> Telnyx::LlmTokenGateway::TokenGroup::Guardrails::Secrets
+
+          attr_reader streaming: Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::streaming?
+
+          def streaming=: (
+            Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::streaming
+          ) -> Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::streaming
+
+          def initialize: (
+            ?dlp: Telnyx::LlmTokenGateway::TokenGroup::Guardrails::Dlp,
+            ?secrets: Telnyx::LlmTokenGateway::TokenGroup::Guardrails::Secrets,
+            ?streaming: Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::streaming
+          ) -> void
+
+          def to_hash: -> {
+            dlp: Telnyx::LlmTokenGateway::TokenGroup::Guardrails::Dlp,
+            secrets: Telnyx::LlmTokenGateway::TokenGroup::Guardrails::Secrets,
+            streaming: Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::streaming
+          }
+
+          type dlp =
+            {
+              profiles: ::Array[Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp::profile],
+              prompt: Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp::prompt,
+              response: Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp::response
+            }
+
+          class Dlp < Telnyx::Internal::Type::BaseModel
+            attr_reader profiles: ::Array[Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp::profile]?
+
+            def profiles=: (
+              ::Array[Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp::profile]
+            ) -> ::Array[Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp::profile]
+
+            attr_reader prompt: Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp::prompt?
+
+            def prompt=: (
+              Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp::prompt
+            ) -> Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp::prompt
+
+            attr_reader response: Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp::response?
+
+            def response=: (
+              Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp::response
+            ) -> Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp::response
+
+            def initialize: (
+              ?profiles: ::Array[Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp::profile],
+              ?prompt: Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp::prompt,
+              ?response: Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp::response
+            ) -> void
+
+            def to_hash: -> {
+              profiles: ::Array[Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp::profile],
+              prompt: Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp::prompt,
+              response: Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp::response
+            }
+
+            type profile = :financial | :government_id | :contact
+
+            module Profile
+              extend Telnyx::Internal::Type::Enum
+
+              FINANCIAL: :financial
+              GOVERNMENT_ID: :government_id
+              CONTACT: :contact
+
+              def self?.values: -> ::Array[Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp::profile]
+            end
+
+            type prompt = :ignore | :flag | :block
+
+            module Prompt
+              extend Telnyx::Internal::Type::Enum
+
+              IGNORE: :ignore
+              FLAG: :flag
+              BLOCK: :block
+
+              def self?.values: -> ::Array[Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp::prompt]
+            end
+
+            type response = :ignore | :flag | :block
+
+            module Response
+              extend Telnyx::Internal::Type::Enum
+
+              IGNORE: :ignore
+              FLAG: :flag
+              BLOCK: :block
+
+              def self?.values: -> ::Array[Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Dlp::response]
+            end
+          end
+
+          type secrets =
+            {
+              prompt: Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Secrets::prompt,
+              response: Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Secrets::response
+            }
+
+          class Secrets < Telnyx::Internal::Type::BaseModel
+            attr_reader prompt: Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Secrets::prompt?
+
+            def prompt=: (
+              Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Secrets::prompt
+            ) -> Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Secrets::prompt
+
+            attr_reader response: Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Secrets::response?
+
+            def response=: (
+              Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Secrets::response
+            ) -> Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Secrets::response
+
+            def initialize: (
+              ?prompt: Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Secrets::prompt,
+              ?response: Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Secrets::response
+            ) -> void
+
+            def to_hash: -> {
+              prompt: Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Secrets::prompt,
+              response: Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Secrets::response
+            }
+
+            type prompt = :ignore | :flag | :block
+
+            module Prompt
+              extend Telnyx::Internal::Type::Enum
+
+              IGNORE: :ignore
+              FLAG: :flag
+              BLOCK: :block
+
+              def self?.values: -> ::Array[Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Secrets::prompt]
+            end
+
+            type response = :ignore | :flag | :block
+
+            module Response
+              extend Telnyx::Internal::Type::Enum
+
+              IGNORE: :ignore
+              FLAG: :flag
+              BLOCK: :block
+
+              def self?.values: -> ::Array[Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::Secrets::response]
+            end
+          end
+
+          type streaming = :buffered | :passthrough
+
+          module Streaming
+            extend Telnyx::Internal::Type::Enum
+
+            BUFFERED: :buffered
+            PASSTHROUGH: :passthrough
+
+            def self?.values: -> ::Array[Telnyx::Models::LlmTokenGateway::TokenGroup::Guardrails::streaming]
+          end
+        end
+
+        type retries =
+          {
+            max_attempts: Integer,
+            backoff: Telnyx::Models::LlmTokenGateway::TokenGroup::Retries::backoff,
+            request_timeout_ms: Integer?,
+            retry_delay_ms: Integer
+          }
+
+        class Retries < Telnyx::Internal::Type::BaseModel
+          attr_accessor max_attempts: Integer
+
+          attr_reader backoff: Telnyx::Models::LlmTokenGateway::TokenGroup::Retries::backoff?
+
+          def backoff=: (
+            Telnyx::Models::LlmTokenGateway::TokenGroup::Retries::backoff
+          ) -> Telnyx::Models::LlmTokenGateway::TokenGroup::Retries::backoff
+
+          attr_accessor request_timeout_ms: Integer?
+
+          attr_reader retry_delay_ms: Integer?
+
+          def retry_delay_ms=: (Integer) -> Integer
+
+          def initialize: (
+            max_attempts: Integer,
+            ?backoff: Telnyx::Models::LlmTokenGateway::TokenGroup::Retries::backoff,
+            ?request_timeout_ms: Integer?,
+            ?retry_delay_ms: Integer
+          ) -> void
+
+          def to_hash: -> {
+            max_attempts: Integer,
+            backoff: Telnyx::Models::LlmTokenGateway::TokenGroup::Retries::backoff,
+            request_timeout_ms: Integer?,
+            retry_delay_ms: Integer
+          }
+
+          type backoff = :constant | :linear | :exponential
+
+          module Backoff
+            extend Telnyx::Internal::Type::Enum
+
+            CONSTANT: :constant
+            LINEAR: :linear
+            EXPONENTIAL: :exponential
+
+            def self?.values: -> ::Array[Telnyx::Models::LlmTokenGateway::TokenGroup::Retries::backoff]
+          end
+        end
+      end
+    end
+  end
+end