Class: Orb::Models::Price::MeteredAllowance

Inherits:

Internal::Type::BaseModel

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

Defined in:

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

Defined Under Namespace

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

Instance Attribute Summary

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

• #metered_allowance_config ⇒ Orb::Models::Price::MeteredAllowance::MeteredAllowanceConfig

  Configuration for metered_allowance pricing.

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

  The pricing model type.

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

  The price id this price replaces.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(allowance_grouping_value:, consumption_grouping_value:, grouping_key:, unit_amount:, allowance_display_name: nil, consumption_display_name: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see MeteredAllowanceConfig 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(allowance_grouping_value:, consumption_grouping_value:, grouping_key:, unit_amount:, allowance_display_name: nil, consumption_display_name: nil) ⇒ Object

Some parameter documentations has been truncated, see MeteredAllowanceConfig for more details.

Configuration for metered_allowance pricing

Parameters:

• allowance_grouping_value (String) —

  The grouping_key value whose summed quantity represents the allowance for this p

• consumption_grouping_value (String) —

  The grouping_key value whose summed quantity represents consumption (e.g. 'downl

• grouping_key (String) —

  Event property used to partition the metric into consumption and allowance quant

• unit_amount (String) —

  Per-unit price applied to gross consumption and to the allowance credit.

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

  Sub-line label for the credit row (e.g. 'Up to 3x free egress').

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

  Sub-line label for the gross consumption row (e.g. 'bytes gotten').

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

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 13258

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 13263

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

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

Parameters:

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

Returns:

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

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

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

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

Parameters:

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

Returns:

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

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

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

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

Parameters:

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

Returns:

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

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

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

#conversion_rate ⇒ Float^?

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

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

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 13290

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

#created_at ⇒ Time

Parameters:

• value (Time)

Returns:

• (Time)

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

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 13300

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

#currency ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

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 13410

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 13311

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 13316

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 13321

required :fixed_price_quantity, Float, nil?: true

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :id, String

#invoice_grouping_key ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

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 13331

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 13338

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

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

Returns:

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

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

optional :license_type, -> { Orb::Price::MeteredAllowance::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 13344

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

#maximum_amount ⇒ String^?

Deprecated.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

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 13359

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

#metered_allowance_config ⇒ Orb::Models::Price::MeteredAllowance::MeteredAllowanceConfig

Configuration for metered_allowance pricing

Parameters:

• value (Orb::Price::MeteredAllowance::MeteredAllowanceConfig)

Returns:

• (Orb::Models::Price::MeteredAllowance::MeteredAllowanceConfig)

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

required :metered_allowance_config, -> { Orb::Price::MeteredAllowance::MeteredAllowanceConfig }

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

Deprecated.

Parameters:

• value (Orb::Minimum, nil)

Returns:

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

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

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

#minimum_amount ⇒ String^?

Deprecated.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

required :minimum_amount, String, nil?: true

#model_type ⇒ Symbol, :metered_allowance

The pricing model type

Parameters:

• value (:metered_allowance)

Returns:

• (Symbol, :metered_allowance)

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

required :model_type, const: :metered_allowance

#name ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :name, String

#plan_phase_order ⇒ Integer^?

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

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

required :plan_phase_order, Integer, nil?: true

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

Parameters:

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

Returns:

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

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

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

required :replaces_price_id, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

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

def to_hash: -> {