Class: Orb::Models::Price::MatrixWithAllocation

Inherits:

Internal::Type::BaseModel

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

Defined in:

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

Defined Under Namespace

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

Instance Attribute Summary

• #billable_metric ⇒ Orb::Models::BillableMetricTiny^?
• #billing_cycle_configuration ⇒ Orb::Models::BillingCycleConfiguration
• #billing_mode ⇒ Symbol, Orb::Models::Price::MatrixWithAllocation::BillingMode
• #cadence ⇒ Symbol, Orb::Models::Price::MatrixWithAllocation::Cadence
• #composite_price_filters ⇒ Array<Orb::Models::Price::MatrixWithAllocation::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::MatrixWithAllocation::LicenseType^?

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

• #matrix_with_allocation_config ⇒ Orb::Models::MatrixWithAllocationConfig

  Configuration for matrix_with_allocation pricing.

• #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, :matrix_with_allocation

  The pricing model type.

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

  The price id this price replaces.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, matrix_with_allocation_config:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :matrix_with_allocation) ⇒ Object constructor

  Some parameter documentations has been truncated, see MatrixWithAllocation 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(id:, billable_metric:, billing_cycle_configuration:, billing_mode:, cadence:, composite_price_filters:, conversion_rate:, conversion_rate_config:, created_at:, credit_allocation:, currency:, discount:, external_price_id:, fixed_price_quantity:, invoice_grouping_key:, invoicing_cycle_configuration:, item:, matrix_with_allocation_config:, maximum:, maximum_amount:, metadata:, minimum:, minimum_amount:, name:, plan_phase_order:, price_type:, replaces_price_id:, dimensional_price_configuration: nil, license_type: nil, model_type: :matrix_with_allocation) ⇒ Object

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

Parameters:

• id (String)
• billable_metric (Orb::Models::BillableMetricTiny, nil)
• billing_cycle_configuration (Orb::Models::BillingCycleConfiguration)
• billing_mode (Symbol, Orb::Models::Price::MatrixWithAllocation::BillingMode)
• cadence (Symbol, Orb::Models::Price::MatrixWithAllocation::Cadence)
• composite_price_filters (Array<Orb::Models::Price::MatrixWithAllocation::CompositePriceFilter>, nil)
• conversion_rate (Float, nil)
• conversion_rate_config (Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil)
• created_at (Time)
• credit_allocation (Orb::Models::Allocation, nil)
• currency (String)
• discount (Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, Orb::Models::Discount::TieredPercentage, nil)
• external_price_id (String, nil)
• fixed_price_quantity (Float, nil)
• invoice_grouping_key (String, nil)
• invoicing_cycle_configuration (Orb::Models::BillingCycleConfiguration, nil)
• item (Orb::Models::ItemSlim) —

  A minimal representation of an Item containing only the essential identifying in

• matrix_with_allocation_config (Orb::Models::MatrixWithAllocationConfig) —

  Configuration for matrix_with_allocation pricing

• maximum (Orb::Models::Maximum, nil)
• maximum_amount (String, nil)
• metadata (Hash{Symbol=>String}) —

  User specified key-value pairs for the resource. If not present, this defaults t

• minimum (Orb::Models::Minimum, nil)
• minimum_amount (String, nil)
• name (String)
• plan_phase_order (Integer, nil)
• price_type (Symbol, Orb::Models::Price::MatrixWithAllocation::PriceType)
• replaces_price_id (String, nil) —

  The price id this price replaces. This price will take the place of the replaced

• dimensional_price_configuration (Orb::Models::DimensionalPriceConfiguration, nil) (defaults to: nil)
• license_type (Orb::Models::Price::MatrixWithAllocation::LicenseType, nil) (defaults to: nil) —

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

• model_type (Symbol, :matrix_with_allocation) (defaults to: :matrix_with_allocation) —

  The pricing model type

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

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 5228

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 5233

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

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

Parameters:

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

Returns:

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

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

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

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

Parameters:

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

Returns:

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

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

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

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

Parameters:

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

Returns:

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

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

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

#conversion_rate ⇒ Float^?

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

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

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 5260

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

#created_at ⇒ Time

Parameters:

• value (Time)

Returns:

• (Time)

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

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 5270

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

#currency ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

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 5380

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 5281

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 5286

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 5291

required :fixed_price_quantity, Float, nil?: true

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :id, String

#invoice_grouping_key ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

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 5301

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 5308

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

#license_type ⇒ Orb::Models::Price::MatrixWithAllocation::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::MatrixWithAllocation::LicenseType, nil)

Returns:

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

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

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

#matrix_with_allocation_config ⇒ Orb::Models::MatrixWithAllocationConfig

Configuration for matrix_with_allocation pricing

Parameters:

• value (Orb::MatrixWithAllocationConfig)

Returns:

• (Orb::Models::MatrixWithAllocationConfig)

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

required :matrix_with_allocation_config, -> { Orb::MatrixWithAllocationConfig }

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

Deprecated.

Parameters:

• value (Orb::Maximum, nil)

Returns:

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

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

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

#maximum_amount ⇒ String^?

Deprecated.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

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 5335

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 5341

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

#minimum_amount ⇒ String^?

Deprecated.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

required :minimum_amount, String, nil?: true

#model_type ⇒ Symbol, :matrix_with_allocation

The pricing model type

Parameters:

• value (:matrix_with_allocation)

Returns:

• (Symbol, :matrix_with_allocation)

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

required :model_type, const: :matrix_with_allocation

#name ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :name, String

#plan_phase_order ⇒ Integer^?

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

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

required :plan_phase_order, Integer, nil?: true

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

Parameters:

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

Returns:

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

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

required :price_type, enum: -> { Orb::Price::MatrixWithAllocation::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 5375

required :replaces_price_id, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

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

def to_hash: -> {