Class: Orb::Models::NewPlanGroupedWithMeteredMinimumPrice::GroupedWithMeteredMinimumConfig

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/orb/models/new_plan_grouped_with_metered_minimum_price.rb,
sig/orb/models/new_plan_grouped_with_metered_minimum_price.rbs

Overview

See Also:

  • Orb::Models::NewPlanGroupedWithMeteredMinimumPrice#grouped_with_metered_minimum_config

Defined Under Namespace

Classes: ScalingFactor, UnitAmount

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

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

Methods included from Internal::Util::SorbetRuntimeSupport

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

Constructor Details

#initialize(scaling_factor:, scaling_value:) ⇒ Object

Configuration for a scaling factor

Parameters:

  • scaling_factor (String)
  • scaling_value (String) 



# File 'lib/orb/models/new_plan_grouped_with_metered_minimum_price.rb', line 261

Instance Attribute Details

#grouping_key ⇒ String

Used to partition the usage into groups. The minimum amount is applied to each group.

Parameters:

  • value (String)

Returns:

  • (String) 


196
 
# File 'lib/orb/models/new_plan_grouped_with_metered_minimum_price.rb', line 196

required :grouping_key, String

#minimum_unit_amount ⇒ String

The minimum amount to charge per group per unit

Parameters:

  • value (String)

Returns:

  • (String) 


202
 
# File 'lib/orb/models/new_plan_grouped_with_metered_minimum_price.rb', line 202

required :minimum_unit_amount, String

#pricing_key ⇒ String

Used to determine the unit rate

Parameters:

  • value (String)

Returns:

  • (String) 


208
 
# File 'lib/orb/models/new_plan_grouped_with_metered_minimum_price.rb', line 208

required :pricing_key, String

#scaling_factors ⇒ Array<Orb::Models::NewPlanGroupedWithMeteredMinimumPrice::GroupedWithMeteredMinimumConfig::ScalingFactor>

Scale the unit rates by the scaling factor.

Parameters:

  • value (::Array[Orb::NewPlanGroupedWithMeteredMinimumPrice::GroupedWithMeteredMinimumConfig::ScalingFactor])

Returns:



214
215
 
# File 'lib/orb/models/new_plan_grouped_with_metered_minimum_price.rb', line 214

required :scaling_factors,
-> { Orb::Internal::Type::ArrayOf[Orb::NewPlanGroupedWithMeteredMinimumPrice::GroupedWithMeteredMinimumConfig::ScalingFactor] }

#scaling_key ⇒ String

Used to determine the unit rate scaling factor

Parameters:

  • value (String)

Returns:

  • (String) 


221
 
# File 'lib/orb/models/new_plan_grouped_with_metered_minimum_price.rb', line 221

required :scaling_key, String

#unit_amounts ⇒ Array<Orb::Models::NewPlanGroupedWithMeteredMinimumPrice::GroupedWithMeteredMinimumConfig::UnitAmount>

Apply per unit pricing to each pricing value. The minimum amount is applied any unmatched usage.

Parameters:

  • value (::Array[Orb::NewPlanGroupedWithMeteredMinimumPrice::GroupedWithMeteredMinimumConfig::UnitAmount])

Returns:



228
229
 
# File 'lib/orb/models/new_plan_grouped_with_metered_minimum_price.rb', line 228

required :unit_amounts,
-> { Orb::Internal::Type::ArrayOf[Orb::NewPlanGroupedWithMeteredMinimumPrice::GroupedWithMeteredMinimumConfig::UnitAmount] }

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


157
 
# File 'sig/orb/models/new_plan_grouped_with_metered_minimum_price.rbs', line 157

def to_hash: -> {