Module: Stigg::Models::V1::Credits::ConsumptionConsumeParams::Dimension

Extended by:
Internal::Type::Union
Defined in:
lib/stigg/models/v1/credits/consumption_consume_params.rb,
sig/stigg/models/v1/credits/consumption_consume_params.rbs

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Internal::Type::Union

==, ===, coerce, derefed_variants, dump, hash, inspect, to_sorbet_type, variants

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Class Method Details

.variants ⇒ Array(String, Float, Boolean)

Returns:

  • (Array(String, Float, Boolean)) 



# File 'lib/stigg/models/v1/credits/consumption_consume_params.rb', line 95

Instance Method Details

#initialize(amount:, currency_id:, customer_id:, idempotency_key:, created_at: nil, dimensions: nil, resource_id: nil, x_account_id: nil, x_environment_id: nil, request_options: {}) ⇒ Object

Parameters:

  • amount (Float) —

    The amount of credits to consume

  • currency_id (String) —

    The credit currency to consume from (required)

  • customer_id (String) —

    The customer to consume credits from (required)

  • idempotency_key (String) —

    A unique key used to deduplicate the consumption (required)

  • created_at (Time) (defaults to: nil) —

    Optional timestamp the consumption is attributed to

  • dimensions (Hash{Symbol=>String, Float, Boolean}) (defaults to: nil) —

    Optional dimensions describing the consumption

  • resource_id (String) (defaults to: nil) —

    Optional resource the consumption is attributed to

  • x_account_id (String) (defaults to: nil)
  • x_environment_id (String) (defaults to: nil)
  • request_options (Stigg::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 


86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/stigg/models/v1/credits/consumption_consume_params.rb', line 86

module Dimension
  extend Stigg::Internal::Type::Union

  variant String

  variant Float

  variant Stigg::Internal::Type::Boolean

  # @!method self.variants
  #   @return [Array(String, Float, Boolean)]
end

#self?.variants ⇒ ::Array[Stigg::Models::V1::Credits::ConsumptionConsumeParams::dimension]

Returns:

  • (::Array[Stigg::Models::V1::Credits::ConsumptionConsumeParams::dimension]) 


84
 
# File 'sig/stigg/models/v1/credits/consumption_consume_params.rbs', line 84

def self?.variants: -> ::Array[Stigg::Models::V1::Credits::ConsumptionConsumeParams::dimension]