Class: Orb::Models::Price::ScalableMatrixWithUnitPricing

Inherits:

Internal::Type::BaseModel

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

Defined in:

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

Defined Under Namespace

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

Instance Attribute Summary

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

  The pricing model type.

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

  The price id this price replaces.

• #scalable_matrix_with_unit_pricing_config ⇒ Orb::Models::Price::ScalableMatrixWithUnitPricing::ScalableMatrixWithUnitPricingConfig

  Configuration for scalable_matrix_with_unit_pricing pricing.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(first_dimension_value:, scaling_factor:, second_dimension_value: nil) ⇒ Object constructor

  Configuration for a single matrix scaling factor.

• #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(first_dimension_value:, scaling_factor:, second_dimension_value: nil) ⇒ Object

Configuration for a single matrix scaling factor

Parameters:

• first_dimension_value (String)
• scaling_factor (String)
• second_dimension_value (String, nil) (defaults to: nil)

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

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 10635

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 10640

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

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

Parameters:

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

Returns:

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

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

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

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

Parameters:

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

Returns:

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

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

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

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

Parameters:

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

Returns:

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

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

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

#conversion_rate ⇒ Float^?

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

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

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 10669

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

#created_at ⇒ Time

Parameters:

• value (Time)

Returns:

• (Time)

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

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 10679

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

#currency ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

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 10790

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 10690

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 10695

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 10700

required :fixed_price_quantity, Float, nil?: true

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :id, String

#invoice_grouping_key ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

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 10710

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 10717

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

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

Returns:

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

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

optional :license_type, -> { Orb::Price::ScalableMatrixWithUnitPricing::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 10723

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

#maximum_amount ⇒ String^?

Deprecated.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

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 10738

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 10744

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

#minimum_amount ⇒ String^?

Deprecated.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

required :minimum_amount, String, nil?: true

#model_type ⇒ Symbol, :scalable_matrix_with_unit_pricing

The pricing model type

Parameters:

• value (:scalable_matrix_with_unit_pricing)

Returns:

• (Symbol, :scalable_matrix_with_unit_pricing)

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

required :model_type, const: :scalable_matrix_with_unit_pricing

#name ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :name, String

#plan_phase_order ⇒ Integer^?

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

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

required :plan_phase_order, Integer, nil?: true

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

Parameters:

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

Returns:

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

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

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

required :replaces_price_id, String, nil?: true

#scalable_matrix_with_unit_pricing_config ⇒ Orb::Models::Price::ScalableMatrixWithUnitPricing::ScalableMatrixWithUnitPricingConfig

Configuration for scalable_matrix_with_unit_pricing pricing

Parameters:

• value (Orb::Price::ScalableMatrixWithUnitPricing::ScalableMatrixWithUnitPricingConfig)

Returns:

• (Orb::Models::Price::ScalableMatrixWithUnitPricing::ScalableMatrixWithUnitPricingConfig)

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

required :scalable_matrix_with_unit_pricing_config,
-> { Orb::Price::ScalableMatrixWithUnitPricing::ScalableMatrixWithUnitPricingConfig }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

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

def to_hash: -> {