Class: Orb::Models::Price::CumulativeGroupedBulk

Inherits:

Internal::Type::BaseModel

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

Defined in:

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

Defined Under Namespace

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

Instance Attribute Summary

• #billable_metric ⇒ Orb::Models::BillableMetricTiny^?
• #billing_cycle_configuration ⇒ Orb::Models::BillingCycleConfiguration
• #billing_mode ⇒ Symbol, Orb::Models::Price::CumulativeGroupedBulk::BillingMode
• #cadence ⇒ Symbol, Orb::Models::Price::CumulativeGroupedBulk::Cadence
• #composite_price_filters ⇒ Array<Orb::Models::Price::CumulativeGroupedBulk::CompositePriceFilter>^?
• #conversion_rate ⇒ Float^?
• #conversion_rate_config ⇒ Orb::Models::UnitConversionRateConfig, ...
• #created_at ⇒ Time
• #credit_allocation ⇒ Orb::Models::Allocation^?
• #cumulative_grouped_bulk_config ⇒ Orb::Models::Price::CumulativeGroupedBulk::CumulativeGroupedBulkConfig

  Configuration for cumulative_grouped_bulk pricing.

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

  The pricing model type.

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

  The price id this price replaces.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

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

  Configuration for a dimension value entry.

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

Configuration for a dimension value entry

Parameters:

• grouping_key (String) —

  Grouping key value

• tier_lower_bound (String) —

  Tier lower bound

• unit_amount (String) —

  Unit amount for this combination

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

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 11104

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 11109

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

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

Parameters:

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

Returns:

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

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

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

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

Parameters:

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

Returns:

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

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

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

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

Parameters:

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

Returns:

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

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

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

#conversion_rate ⇒ Float^?

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

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

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 11136

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

#created_at ⇒ Time

Parameters:

• value (Time)

Returns:

• (Time)

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

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 11146

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

#cumulative_grouped_bulk_config ⇒ Orb::Models::Price::CumulativeGroupedBulk::CumulativeGroupedBulkConfig

Configuration for cumulative_grouped_bulk pricing

Parameters:

• value (Orb::Price::CumulativeGroupedBulk::CumulativeGroupedBulkConfig)

Returns:

• (Orb::Models::Price::CumulativeGroupedBulk::CumulativeGroupedBulkConfig)

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

required :cumulative_grouped_bulk_config,
-> { Orb::Price::CumulativeGroupedBulk::CumulativeGroupedBulkConfig }

#currency ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

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 11257

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 11164

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 11169

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 11174

required :fixed_price_quantity, Float, nil?: true

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :id, String

#invoice_grouping_key ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

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 11184

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 11191

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

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

Returns:

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

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

optional :license_type, -> { Orb::Price::CumulativeGroupedBulk::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 11197

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

#maximum_amount ⇒ String^?

Deprecated.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

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 11212

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 11218

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

#minimum_amount ⇒ String^?

Deprecated.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

required :minimum_amount, String, nil?: true

#model_type ⇒ Symbol, :cumulative_grouped_bulk

The pricing model type

Parameters:

• value (:cumulative_grouped_bulk)

Returns:

• (Symbol, :cumulative_grouped_bulk)

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

required :model_type, const: :cumulative_grouped_bulk

#name ⇒ String

Parameters:

• value (String)

Returns:

• (String)

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

required :name, String

#plan_phase_order ⇒ Integer^?

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

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

required :plan_phase_order, Integer, nil?: true

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

Parameters:

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

Returns:

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

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

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

required :replaces_price_id, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

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

def to_hash: -> {