telnyx 5.170.0 → 5.171.0

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

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module LlmTokenGateway
+      # @see Telnyx::Resources::LlmTokenGateway::Spend#retrieve_events
+      class SpendRetrieveEventsParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute end_date
+        #
+        #   @return [Date, nil]
+        optional :end_date, Date
+
+        # @!attribute end_user_id
+        #
+        #   @return [String, nil]
+        optional :end_user_id, String
+
+        # @!attribute metadata
+        #   Request tag filters as metadata[<key>]=<value>, at most 5, combined with AND. A
+        #   value matches the tag's text form exactly (booleans as true/false, integers in
+        #   decimal), so metadata[flag]=true matches both boolean true and the string
+        #   "true". Keys are case-sensitive; reserved-prefix keys are rejected. Unindexed:
+        #   bounded by the account, the date range and the report timeout.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :metadata, Telnyx::Internal::Type::HashOf[String]
+
+        # @!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 start_date
+        #
+        #   @return [Date, nil]
+        optional :start_date, Date
+
+        # @!attribute token_group_id
+        #
+        #   @return [String, nil]
+        optional :token_group_id, String
+
+        # @!attribute token_key_id
+        #
+        #   @return [String, nil]
+        optional :token_key_id, String
+
+        # @!attribute token_user_id
+        #
+        #   @return [String, nil]
+        optional :token_user_id, String
+
+        # @!method initialize(end_date: nil, end_user_id: nil, metadata: nil, page_number: nil, page_size: nil, page_snapshot: nil, start_date: nil, token_group_id: nil, token_key_id: nil, token_user_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::LlmTokenGateway::SpendRetrieveEventsParams} for more details.
+        #
+        #   @param end_date [Date]
+        #
+        #   @param end_user_id [String]
+        #
+        #   @param metadata [Hash{Symbol=>String}] Request tag filters as metadata[<key>]=<value>, at most 5, combined with AND. A
+        #
+        #   @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 start_date [Date]
+        #
+        #   @param token_group_id [String]
+        #
+        #   @param token_key_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/spend_retrieve_events_response.rb

@@ -0,0 +1,282 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module LlmTokenGateway
+      # @see Telnyx::Resources::LlmTokenGateway::Spend#retrieve_events
+      class SpendRetrieveEventsResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Array<Telnyx::Models::LlmTokenGateway::SpendRetrieveEventsResponse::Data>]
+        required :data,
+                 -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::LlmTokenGateway::SpendRetrieveEventsResponse::Data] }
+
+        # @!attribute meta
+        #
+        #   @return [Telnyx::Models::LlmTokenGateway::SpendRetrieveEventsResponse::Meta]
+        required :meta, -> { Telnyx::Models::LlmTokenGateway::SpendRetrieveEventsResponse::Meta }
+
+        # @!method initialize(data:, meta:)
+        #   @param data [Array<Telnyx::Models::LlmTokenGateway::SpendRetrieveEventsResponse::Data>]
+        #   @param meta [Telnyx::Models::LlmTokenGateway::SpendRetrieveEventsResponse::Meta]
+
+        class Data < Telnyx::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute attempts
+          #   Provider attempts begun for the request (fallbacks included); 0 for a cache hit.
+          #   Token and cost totals sum every attempt.
+          #
+          #   @return [Integer]
+          required :attempts, Integer
+
+          # @!attribute biller
+          #
+          #   @return [Symbol, Telnyx::Models::LlmTokenGateway::SpendRetrieveEventsResponse::Data::Biller]
+          required :biller, enum: -> { Telnyx::Models::LlmTokenGateway::SpendRetrieveEventsResponse::Data::Biller }
+
+          # @!attribute cache_hit
+          #
+          #   @return [Boolean]
+          required :cache_hit, Telnyx::Internal::Type::Boolean
+
+          # @!attribute configuration_version
+          #
+          #   @return [Integer]
+          required :configuration_version, Integer
+
+          # @!attribute cost
+          #   USD, decimal precision at most 6 places; parse exactly to integer micro-USD,
+          #   never binary float accounting.
+          #
+          #   @return [Float, nil]
+          required :cost, Float, nil?: true
+
+          # @!attribute created_at
+          #
+          #   @return [Time]
+          required :created_at, Time
+
+          # @!attribute end_user_id
+          #
+          #   @return [String, nil]
+          required :end_user_id, String, nil?: true
+
+          # @!attribute input_tokens
+          #
+          #   @return [Integer, nil]
+          required :input_tokens, Integer, nil?: true
+
+          # @!attribute metadata
+          #   Customer request tags from the x-ltg-metadata header: up to 5 entries. Keys are
+          #   case-sensitive; keys starting with ltg*, telnyx*, litellm* or cf* (any case) are
+          #   reserved. Values are strings (1-256 characters, no control or format
+          #   characters), integers within +/-9007199254740991, or booleans; floats, null,
+          #   objects and arrays are rejected. Values that look like credentials are rejected.
+          #   Tags are attribution only: never forwarded upstream, never part of the response
+          #   cache key, never used for budgets or routing. An untagged request reports {}.
+          #
+          #   @return [Hash{Symbol=>String, Integer, Boolean}]
+          required :metadata,
+                   -> { Telnyx::Internal::Type::HashOf[union: Telnyx::Models::LlmTokenGateway::SpendRetrieveEventsResponse::Data::Metadata] }
+
+          # @!attribute model
+          #   Public alias that served (the last attempt); rate_version, biller and
+          #   provider_key_id follow it.
+          #
+          #   @return [String]
+          required :model, String
+
+          # @!attribute output_tokens
+          #
+          #   @return [Integer, nil]
+          required :output_tokens, Integer, nil?: true
+
+          # @!attribute provider_key_id
+          #
+          #   @return [String, nil]
+          required :provider_key_id, String, nil?: true
+
+          # @!attribute rate_version
+          #
+          #   @return [String]
+          required :rate_version, String
+
+          # @!attribute request_id
+          #
+          #   @return [String]
+          required :request_id, String
+
+          # @!attribute requested_model
+          #   Public alias the caller requested; differs from model only when a group fallback
+          #   served.
+          #
+          #   @return [String]
+          required :requested_model, String
+
+          # @!attribute reservation_micro_usd
+          #
+          #   @return [Integer]
+          required :reservation_micro_usd, Integer
+
+          # @!attribute status
+          #
+          #   @return [Symbol, Telnyx::Models::LlmTokenGateway::SpendRetrieveEventsResponse::Data::Status]
+          required :status, enum: -> { Telnyx::Models::LlmTokenGateway::SpendRetrieveEventsResponse::Data::Status }
+
+          # @!attribute token_group_id
+          #
+          #   @return [String]
+          required :token_group_id, String
+
+          # @!attribute token_key_id
+          #
+          #   @return [String]
+          required :token_key_id, String
+
+          # @!attribute token_user_id
+          #
+          #   @return [String, nil]
+          required :token_user_id, String, nil?: true
+
+          # @!attribute usage_status
+          #
+          #   @return [Symbol, Telnyx::Models::LlmTokenGateway::SpendRetrieveEventsResponse::Data::UsageStatus]
+          required :usage_status,
+                   enum: -> { Telnyx::Models::LlmTokenGateway::SpendRetrieveEventsResponse::Data::UsageStatus }
+
+          # @!method initialize(id:, attempts:, biller:, cache_hit:, configuration_version:, cost:, created_at:, end_user_id:, input_tokens:, metadata:, model:, output_tokens:, provider_key_id:, rate_version:, request_id:, requested_model:, reservation_micro_usd:, status:, token_group_id:, token_key_id:, token_user_id:, usage_status:)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::LlmTokenGateway::SpendRetrieveEventsResponse::Data} for more
+          #   details.
+          #
+          #   @param id [String]
+          #
+          #   @param attempts [Integer] Provider attempts begun for the request (fallbacks included); 0 for a cache hit.
+          #
+          #   @param biller [Symbol, Telnyx::Models::LlmTokenGateway::SpendRetrieveEventsResponse::Data::Biller]
+          #
+          #   @param cache_hit [Boolean]
+          #
+          #   @param configuration_version [Integer]
+          #
+          #   @param cost [Float, nil] USD, decimal precision at most 6 places; parse exactly to integer micro-USD, nev
+          #
+          #   @param created_at [Time]
+          #
+          #   @param end_user_id [String, nil]
+          #
+          #   @param input_tokens [Integer, nil]
+          #
+          #   @param metadata [Hash{Symbol=>String, Integer, Boolean}] Customer request tags from the x-ltg-metadata header: up to 5 entries. Keys are
+          #
+          #   @param model [String] Public alias that served (the last attempt); rate_version, biller and provider_k
+          #
+          #   @param output_tokens [Integer, nil]
+          #
+          #   @param provider_key_id [String, nil]
+          #
+          #   @param rate_version [String]
+          #
+          #   @param request_id [String]
+          #
+          #   @param requested_model [String] Public alias the caller requested; differs from model only when a group fallback
+          #
+          #   @param reservation_micro_usd [Integer]
+          #
+          #   @param status [Symbol, Telnyx::Models::LlmTokenGateway::SpendRetrieveEventsResponse::Data::Status]
+          #
+          #   @param token_group_id [String]
+          #
+          #   @param token_key_id [String]
+          #
+          #   @param token_user_id [String, nil]
+          #
+          #   @param usage_status [Symbol, Telnyx::Models::LlmTokenGateway::SpendRetrieveEventsResponse::Data::UsageStatus]
+
+          # @see Telnyx::Models::LlmTokenGateway::SpendRetrieveEventsResponse::Data#biller
+          module Biller
+            extend Telnyx::Internal::Type::Enum
+
+            TELNYX = :telnyx
+            PROVIDER = :provider
+            NONE = :none
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          module Metadata
+            extend Telnyx::Internal::Type::Union
+
+            variant String
+
+            variant Integer
+
+            variant Telnyx::Internal::Type::Boolean
+
+            # @!method self.variants
+            #   @return [Array(String, Integer, Boolean)]
+          end
+
+          # @see Telnyx::Models::LlmTokenGateway::SpendRetrieveEventsResponse::Data#status
+          module Status
+            extend Telnyx::Internal::Type::Enum
+
+            SUCCEEDED = :succeeded
+            FAILED = :failed
+            PARTIAL = :partial
+            UNKNOWN = :unknown
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see Telnyx::Models::LlmTokenGateway::SpendRetrieveEventsResponse::Data#usage_status
+          module UsageStatus
+            extend Telnyx::Internal::Type::Enum
+
+            KNOWN = :known
+            UNKNOWN = :unknown
+            RECONCILED = :reconciled
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        # @see Telnyx::Models::LlmTokenGateway::SpendRetrieveEventsResponse#meta
+        class Meta < Telnyx::Internal::Type::BaseModel
+          # @!attribute has_more
+          #
+          #   @return [Boolean]
+          required :has_more, Telnyx::Internal::Type::Boolean
+
+          # @!attribute page_number
+          #
+          #   @return [Integer]
+          required :page_number, Integer
+
+          # @!attribute page_size
+          #
+          #   @return [Integer]
+          required :page_size, Integer
+
+          # @!attribute snapshot
+          #
+          #   @return [String]
+          required :snapshot, String
+
+          # @!method initialize(has_more:, page_number:, page_size:, snapshot:)
+          #   @param has_more [Boolean]
+          #   @param page_number [Integer]
+          #   @param page_size [Integer]
+          #   @param snapshot [String]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module LlmTokenGateway
+      # @see Telnyx::Resources::LlmTokenGateway::Spend#retrieve_summary
+      class SpendRetrieveSummaryParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute end_date
+        #
+        #   @return [Date]
+        required :end_date, Date
+
+        # @!attribute group_by
+        #   A scope, or metadata:<key> to group by one request tag's text-form value;
+        #   requests without the key form one group with a null dimension_id.
+        #
+        #   @return [Symbol, String, Telnyx::Models::LlmTokenGateway::SpendGroupBy]
+        required :group_by, union: -> { Telnyx::LlmTokenGateway::SpendGroupBy }
+
+        # @!attribute start_date
+        #
+        #   @return [Date]
+        required :start_date, Date
+
+        # @!attribute end_user_id
+        #
+        #   @return [String, nil]
+        optional :end_user_id, String
+
+        # @!attribute metadata
+        #   Request tag filters as metadata[<key>]=<value>, at most 5, combined with AND. A
+        #   value matches the tag's text form exactly (booleans as true/false, integers in
+        #   decimal), so metadata[flag]=true matches both boolean true and the string
+        #   "true". Keys are case-sensitive; reserved-prefix keys are rejected. Unindexed:
+        #   bounded by the account, the date range and the report timeout.
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :metadata, Telnyx::Internal::Type::HashOf[String]
+
+        # @!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_key_id
+        #
+        #   @return [String, nil]
+        optional :token_key_id, String
+
+        # @!attribute token_user_id
+        #
+        #   @return [String, nil]
+        optional :token_user_id, String
+
+        # @!method initialize(end_date:, group_by:, start_date:, end_user_id: nil, metadata: nil, page_number: nil, page_size: nil, page_snapshot: nil, token_group_id: nil, token_key_id: nil, token_user_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::LlmTokenGateway::SpendRetrieveSummaryParams} for more details.
+        #
+        #   @param end_date [Date]
+        #
+        #   @param group_by [Symbol, String, Telnyx::Models::LlmTokenGateway::SpendGroupBy] A scope, or metadata:<key> to group by one request tag's text-form value; reques
+        #
+        #   @param start_date [Date]
+        #
+        #   @param end_user_id [String]
+        #
+        #   @param metadata [Hash{Symbol=>String}] Request tag filters as metadata[<key>]=<value>, at most 5, combined with AND. A
+        #
+        #   @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_key_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/spend_retrieve_summary_response.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module LlmTokenGateway
+      # @see Telnyx::Resources::LlmTokenGateway::Spend#retrieve_summary
+      class SpendRetrieveSummaryResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Array<Telnyx::Models::LlmTokenGateway::SpendRetrieveSummaryResponse::Data>]
+        required :data,
+                 -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::LlmTokenGateway::SpendRetrieveSummaryResponse::Data] }
+
+        # @!attribute meta
+        #
+        #   @return [Telnyx::Models::LlmTokenGateway::SpendRetrieveSummaryResponse::Meta]
+        required :meta, -> { Telnyx::Models::LlmTokenGateway::SpendRetrieveSummaryResponse::Meta }
+
+        # @!method initialize(data:, meta:)
+        #   @param data [Array<Telnyx::Models::LlmTokenGateway::SpendRetrieveSummaryResponse::Data>]
+        #   @param meta [Telnyx::Models::LlmTokenGateway::SpendRetrieveSummaryResponse::Meta]
+
+        class Data < Telnyx::Internal::Type::BaseModel
+          # @!attribute dimension_id
+          #
+          #   @return [String, nil]
+          required :dimension_id, String, nil?: true
+
+          # @!attribute input_tokens
+          #
+          #   @return [Integer]
+          required :input_tokens, Integer
+
+          # @!attribute name
+          #
+          #   @return [String, nil]
+          required :name, String, nil?: true
+
+          # @!attribute output_tokens
+          #
+          #   @return [Integer]
+          required :output_tokens, Integer
+
+          # @!attribute requests
+          #
+          #   @return [Integer]
+          required :requests, Integer
+
+          # @!attribute reserved_spend
+          #   USD, decimal precision at most 6 places; parse exactly to integer micro-USD,
+          #   never binary float accounting.
+          #
+          #   @return [Float]
+          required :reserved_spend, Float
+
+          # @!attribute spend
+          #   USD, decimal precision at most 6 places; parse exactly to integer micro-USD,
+          #   never binary float accounting.
+          #
+          #   @return [Float]
+          required :spend, Float
+
+          # @!attribute unknown_requests
+          #
+          #   @return [Integer]
+          required :unknown_requests, Integer
+
+          # @!attribute end_user_id
+          #
+          #   @return [String, nil]
+          optional :end_user_id, String, nil?: true
+
+          # @!attribute metadata_key
+          #   Present only for group_by=metadata:<key>: the tag key. dimension_id is then the
+          #   tag value in text form (booleans as true/false, integers in decimal), or null
+          #   for requests without the key; name is null.
+          #
+          #   @return [String, nil]
+          optional :metadata_key, String
+
+          # @!attribute token_group_id
+          #
+          #   @return [String, nil]
+          optional :token_group_id, String, nil?: true
+
+          # @!attribute token_key_id
+          #
+          #   @return [String, nil]
+          optional :token_key_id, String, nil?: true
+
+          # @!attribute token_user_id
+          #
+          #   @return [String, nil]
+          optional :token_user_id, String, nil?: true
+
+          # @!method initialize(dimension_id:, input_tokens:, name:, output_tokens:, requests:, reserved_spend:, spend:, unknown_requests:, end_user_id: nil, metadata_key: nil, token_group_id: nil, token_key_id: nil, token_user_id: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::LlmTokenGateway::SpendRetrieveSummaryResponse::Data} for more
+          #   details.
+          #
+          #   @param dimension_id [String, nil]
+          #
+          #   @param input_tokens [Integer]
+          #
+          #   @param name [String, nil]
+          #
+          #   @param output_tokens [Integer]
+          #
+          #   @param requests [Integer]
+          #
+          #   @param reserved_spend [Float] USD, decimal precision at most 6 places; parse exactly to integer micro-USD, nev
+          #
+          #   @param spend [Float] USD, decimal precision at most 6 places; parse exactly to integer micro-USD, nev
+          #
+          #   @param unknown_requests [Integer]
+          #
+          #   @param end_user_id [String, nil]
+          #
+          #   @param metadata_key [String] Present only for group_by=metadata:<key>: the tag key. dimension_id is then the
+          #
+          #   @param token_group_id [String, nil]
+          #
+          #   @param token_key_id [String, nil]
+          #
+          #   @param token_user_id [String, nil]
+        end
+
+        # @see Telnyx::Models::LlmTokenGateway::SpendRetrieveSummaryResponse#meta
+        class Meta < Telnyx::Internal::Type::BaseModel
+          # @!attribute end_date
+          #
+          #   @return [Date]
+          required :end_date, Date
+
+          # @!attribute group_by
+          #   Group by one request tag key. Keys starting with ltg*, telnyx*, litellm* or cf*
+          #   (any case) are rejected.
+          #
+          #   @return [Symbol, String, Telnyx::Models::LlmTokenGateway::SpendGroupBy]
+          required :group_by, union: -> { Telnyx::LlmTokenGateway::SpendGroupBy }
+
+          # @!attribute has_more
+          #
+          #   @return [Boolean]
+          required :has_more, Telnyx::Internal::Type::Boolean
+
+          # @!attribute page_number
+          #
+          #   @return [Integer]
+          required :page_number, Integer
+
+          # @!attribute page_size
+          #
+          #   @return [Integer]
+          required :page_size, Integer
+
+          # @!attribute snapshot
+          #
+          #   @return [String]
+          required :snapshot, String
+
+          # @!attribute start_date
+          #
+          #   @return [Date]
+          required :start_date, Date
+
+          # @!method initialize(end_date:, group_by:, has_more:, page_number:, page_size:, snapshot:, start_date:)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::LlmTokenGateway::SpendRetrieveSummaryResponse::Meta} for more
+          #   details.
+          #
+          #   @param end_date [Date]
+          #
+          #   @param group_by [Symbol, String, Telnyx::Models::LlmTokenGateway::SpendGroupBy] Group by one request tag key. Keys starting with ltg*, telnyx*, litellm* or cf*
+          #
+          #   @param has_more [Boolean]
+          #
+          #   @param page_number [Integer]
+          #
+          #   @param page_size [Integer]
+          #
+          #   @param snapshot [String]
+          #
+          #   @param start_date [Date]
+        end
+      end
+    end
+  end
+end