Class: Orb::Models::Price::TieredMatrixWithAllocation

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Orb::Models::Price::TieredMatrixWithAllocation

Defined in:

lib/orb/models/price.rb,
sig/orb/models/price.rbs

Defined Under Namespace

Modules: BillingMode, Cadence, PriceType Classes: CompositePriceFilter, LicenseType, TieredMatrixWithAllocationConfig

Instance Attribute Summary

• #billable_metric ⇒ Orb::Models::BillableMetricTiny^?
• #billing_cycle_configuration ⇒ Orb::Models::BillingCycleConfiguration
• #billing_mode ⇒ Symbol, Orb::Models::Price::TieredMatrixWithAllocation::BillingMode
• #cadence ⇒ Symbol, Orb::Models::Price::TieredMatrixWithAllocation::Cadence
• #composite_price_filters ⇒ Array<Orb::Models::Price::TieredMatrixWithAllocation::CompositePriceFilter>^?
• #conversion_rate ⇒ Float^?
• #conversion_rate_config ⇒ Orb::Models::UnitConversionRateConfig, ...
• #created_at ⇒ Time
• #credit_allocation ⇒ Orb::Models::Allocation^?
• #currency ⇒ String
• #dimensional_price_configuration ⇒ Orb::Models::DimensionalPriceConfiguration^?
• #discount ⇒ Orb::Models::PercentageDiscount, ... deprecated Deprecated.
• #external_price_id ⇒ String^?
• #fixed_price_quantity ⇒ Float^?
• #id ⇒ String
• #invoice_grouping_key ⇒ String^?
• #invoicing_cycle_configuration ⇒ Orb::Models::BillingCycleConfiguration^?
• #item ⇒ Orb::Models::ItemSlim

  A minimal representation of an Item containing only the essential identifying information.

• #license_type ⇒ Orb::Models::Price::TieredMatrixWithAllocation::LicenseType^?

  The LicenseType resource represents a type of license that can be assigned to users.

• #maximum ⇒ Orb::Models::Maximum^? deprecated Deprecated.
• #maximum_amount ⇒ String^? deprecated Deprecated.
• #metadata ⇒ Hash{Symbol=>String}

  User specified key-value pairs for the resource.

• #minimum ⇒ Orb::Models::Minimum^? deprecated Deprecated.
• #minimum_amount ⇒ String^? deprecated Deprecated.
• #model_type ⇒ Symbol, :tiered_matrix_with_allocation

  The pricing model type.

• #name ⇒ String
• #plan_phase_order ⇒ Integer^?
• #price_type ⇒ Symbol, Orb::Models::Price::TieredMatrixWithAllocation::PriceType
• #replaces_price_id ⇒ String^?

  The price id this price replaces.

• #tiered_matrix_with_allocation_config ⇒ Orb::Models::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig

  Configuration for tiered_matrix_with_allocation pricing.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(dimension_values:, tier_lower_bound:, unit_amount:) ⇒ Object constructor

  Some parameter documentations has been truncated, see TieredMatrixWithAllocationConfig::Tier for more details.

• #to_hash ⇒ {

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(dimension_values:, tier_lower_bound:, unit_amount:) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig::Tier for more details.

Configuration for a single tier scoped to one matrix cell

Parameters:

• dimension_values (Array<String>) —

  The matrix cell this tier applies to, as one or two dimension values

• tier_lower_bound (String) —

  Exclusive tier starting value. The tier runs up to and including the next bound

• unit_amount (String) —

  Per unit amount

# File 'lib/orb/models/price.rb', line 6193

Instance Attribute Details

#billable_metric ⇒ Orb::Models::BillableMetricTiny^?

Parameters:

• value (Orb::BillableMetricTiny, nil)

Returns:

• (Orb::Models::BillableMetricTiny, nil)

# File 'lib/orb/models/price.rb', line 6028

required :billable_metric, -> { Orb::BillableMetricTiny }, nil?: true

#billing_cycle_configuration ⇒ Orb::Models::BillingCycleConfiguration

Parameters:

• value (Orb::BillingCycleConfiguration)

Returns:

• (Orb::Models::BillingCycleConfiguration)

# File 'lib/orb/models/price.rb', line 6033

required :billing_cycle_configuration, -> { Orb::BillingCycleConfiguration }

#billing_mode ⇒ Symbol, Orb::Models::Price::TieredMatrixWithAllocation::BillingMode

Parameters:

• value (Orb::Models::Price::TieredMatrixWithAllocation::billing_mode)

Returns:

• (Symbol, Orb::Models::Price::TieredMatrixWithAllocation::BillingMode)

# File 'lib/orb/models/price.rb', line 6038

required :billing_mode, enum: -> { Orb::Price::TieredMatrixWithAllocation::BillingMode }

#cadence ⇒ Symbol, Orb::Models::Price::TieredMatrixWithAllocation::Cadence

Parameters:

• value (Orb::Models::Price::TieredMatrixWithAllocation::cadence)

Returns:

• (Symbol, Orb::Models::Price::TieredMatrixWithAllocation::Cadence)

# File 'lib/orb/models/price.rb', line 6043

required :cadence, enum: -> { Orb::Price::TieredMatrixWithAllocation::Cadence }

#composite_price_filters ⇒ Array<Orb::Models::Price::TieredMatrixWithAllocation::CompositePriceFilter>^?

Parameters:

• value (::Array[Orb::Price::TieredMatrixWithAllocation::CompositePriceFilter], nil)

Returns:

• (Array<Orb::Models::Price::TieredMatrixWithAllocation::CompositePriceFilter>, nil)

# File 'lib/orb/models/price.rb', line 6048

required :composite_price_filters,
-> {
  Orb::Internal::Type::ArrayOf[Orb::Price::TieredMatrixWithAllocation::CompositePriceFilter]
},
nil?: true

#conversion_rate ⇒ Float^?

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

# File 'lib/orb/models/price.rb', line 6057

required :conversion_rate, Float, nil?: true

#conversion_rate_config ⇒ Orb::Models::UnitConversionRateConfig, ...

Parameters:

• value (Orb::Models::conversion_rate_config, nil)

Returns:

• (Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil)

# File 'lib/orb/models/price.rb', line 6062

required :conversion_rate_config, union: -> { Orb::ConversionRateConfig }, nil?: true

#created_at ⇒ Time

Parameters:

• value (Time)

Returns:

• (Time)

# File 'lib/orb/models/price.rb', line 6067

required :created_at, Time

#credit_allocation ⇒ Orb::Models::Allocation^?

Parameters:

• value (Orb::Allocation, nil)

Returns:

• (Orb::Models::Allocation, nil)

# File 'lib/orb/models/price.rb', line 6072

required :credit_allocation, -> { Orb::Allocation }, nil?: true

#currency ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/orb/models/price.rb', line 6077

required :currency, String

#dimensional_price_configuration ⇒ Orb::Models::DimensionalPriceConfiguration^?

Parameters:

• value (Orb::DimensionalPriceConfiguration, nil)

Returns:

• (Orb::Models::DimensionalPriceConfiguration, nil)

# File 'lib/orb/models/price.rb', line 6183

optional :dimensional_price_configuration, -> { Orb::DimensionalPriceConfiguration }, nil?: true

#discount ⇒ Orb::Models::PercentageDiscount, ...

Deprecated.

Parameters:

• value (Orb::Models::discount, nil)

Returns:

• (Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, Orb::Models::Discount::TieredPercentage, nil)

# File 'lib/orb/models/price.rb', line 6083

required :discount, union: -> { Orb::Discount }, nil?: true

#external_price_id ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/orb/models/price.rb', line 6088

required :external_price_id, String, nil?: true

#fixed_price_quantity ⇒ Float^?

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

# File 'lib/orb/models/price.rb', line 6093

required :fixed_price_quantity, Float, nil?: true

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/orb/models/price.rb', line 6023

required :id, String

#invoice_grouping_key ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/orb/models/price.rb', line 6098

required :invoice_grouping_key, String, nil?: true

#invoicing_cycle_configuration ⇒ Orb::Models::BillingCycleConfiguration^?

Parameters:

• value (Orb::BillingCycleConfiguration, nil)

Returns:

• (Orb::Models::BillingCycleConfiguration, nil)

# File 'lib/orb/models/price.rb', line 6103

required :invoicing_cycle_configuration, -> { Orb::BillingCycleConfiguration }, nil?: true

#item ⇒ Orb::Models::ItemSlim

A minimal representation of an Item containing only the essential identifying information.

Parameters:

• value (Orb::ItemSlim)

Returns:

• (Orb::Models::ItemSlim)

# File 'lib/orb/models/price.rb', line 6110

required :item, -> { Orb::ItemSlim }

#license_type ⇒ Orb::Models::Price::TieredMatrixWithAllocation::LicenseType^?

The LicenseType resource represents a type of license that can be assigned to users. License types are used during billing by grouping metrics on the configured grouping key.

Parameters:

• value (Orb::Price::TieredMatrixWithAllocation::LicenseType, nil)

Returns:

• (Orb::Models::Price::TieredMatrixWithAllocation::LicenseType, nil)

# File 'lib/orb/models/price.rb', line 6191

optional :license_type, -> { Orb::Price::TieredMatrixWithAllocation::LicenseType }, nil?: true

#maximum ⇒ Orb::Models::Maximum^?

Deprecated.

Parameters:

• value (Orb::Maximum, nil)

Returns:

• (Orb::Models::Maximum, nil)

# File 'lib/orb/models/price.rb', line 6116

required :maximum, -> { Orb::Maximum }, nil?: true

#maximum_amount ⇒ String^?

Deprecated.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/orb/models/price.rb', line 6122

required :maximum_amount, String, nil?: true

#metadata ⇒ Hash{Symbol=>String}

User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to null, and the entire metadata mapping can be cleared by setting metadata to null.

Parameters:

• value (::Hash[Symbol, String])

Returns:

• (Hash{Symbol=>String})

# File 'lib/orb/models/price.rb', line 6131

required :metadata, Orb::Internal::Type::HashOf[String]

#minimum ⇒ Orb::Models::Minimum^?

Deprecated.

Parameters:

• value (Orb::Minimum, nil)

Returns:

• (Orb::Models::Minimum, nil)

# File 'lib/orb/models/price.rb', line 6137

required :minimum, -> { Orb::Minimum }, nil?: true

#minimum_amount ⇒ String^?

Deprecated.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/orb/models/price.rb', line 6143

required :minimum_amount, String, nil?: true

#model_type ⇒ Symbol, :tiered_matrix_with_allocation

The pricing model type

Parameters:

• value (:tiered_matrix_with_allocation)

Returns:

• (Symbol, :tiered_matrix_with_allocation)

# File 'lib/orb/models/price.rb', line 6149

required :model_type, const: :tiered_matrix_with_allocation

#name ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/orb/models/price.rb', line 6154

required :name, String

#plan_phase_order ⇒ Integer^?

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

# File 'lib/orb/models/price.rb', line 6159

required :plan_phase_order, Integer, nil?: true

#price_type ⇒ Symbol, Orb::Models::Price::TieredMatrixWithAllocation::PriceType

Parameters:

• value (Orb::Models::Price::TieredMatrixWithAllocation::price_type)

Returns:

• (Symbol, Orb::Models::Price::TieredMatrixWithAllocation::PriceType)

# File 'lib/orb/models/price.rb', line 6164

required :price_type, enum: -> { Orb::Price::TieredMatrixWithAllocation::PriceType }

#replaces_price_id ⇒ String^?

The price id this price replaces. This price will take the place of the replaced price in plan version migrations.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/orb/models/price.rb', line 6171

required :replaces_price_id, String, nil?: true

#tiered_matrix_with_allocation_config ⇒ Orb::Models::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig

Configuration for tiered_matrix_with_allocation pricing

Parameters:

• value (Orb::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig)

Returns:

• (Orb::Models::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig)

# File 'lib/orb/models/price.rb', line 6177

required :tiered_matrix_with_allocation_config,
-> { Orb::Price::TieredMatrixWithAllocation::TieredMatrixWithAllocationConfig }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/orb/models/price.rb', line 6264

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/orb/models/price.rbs', line 4605

def to_hash: -> {