Class: Orb::Models::PerPriceCost

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Orb::Models::PerPriceCost

Defined in:

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

Instance Attribute Summary

• #price ⇒ Orb::Models::Price::Unit, ...

  The price object.

• #price_id ⇒ String

  The price the cost is associated with.

• #quantity ⇒ Float^?

  The price's quantity for the timeframe.

• #subtotal ⇒ String

  Price's contributions for the timeframe, excluding any minimums and discounts.

• #total ⇒ String

  Price's contributions for the timeframe, including minimums and discounts.

Instance Method Summary

• #initialize(price:, price_id:, subtotal:, total:, quantity: nil) ⇒ Object constructor
• #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(price:, price_id:, subtotal:, total:, quantity: nil) ⇒ Object

Parameters:

• price (Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput) —

  The price object

• price_id (String) —

  The price the cost is associated with

• subtotal (String) —

  Price's contributions for the timeframe, excluding any minimums and discounts.

• total (String) —

  Price's contributions for the timeframe, including minimums and discounts.

• quantity (Float, nil) (defaults to: nil) —

  The price's quantity for the timeframe

# File 'lib/orb/models/per_price_cost.rb', line 36

Instance Attribute Details

#price ⇒ Orb::Models::Price::Unit, ...

The price object

Parameters:

• value (Orb::Models::price)

Returns:

• (Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput)

# File 'lib/orb/models/per_price_cost.rb', line 10

required :price, union: -> { Orb::Price }

#price_id ⇒ String

The price the cost is associated with

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/orb/models/per_price_cost.rb', line 16

required :price_id, String

#quantity ⇒ Float^?

The price's quantity for the timeframe

Parameters:

• value (Float, nil)

Returns:

• (Float, nil)

# File 'lib/orb/models/per_price_cost.rb', line 34

optional :quantity, Float, nil?: true

#subtotal ⇒ String

Price's contributions for the timeframe, excluding any minimums and discounts.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/orb/models/per_price_cost.rb', line 22

required :subtotal, String

#total ⇒ String

Price's contributions for the timeframe, including minimums and discounts.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/orb/models/per_price_cost.rb', line 28

required :total, String

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/orb/models/per_price_cost.rbs', line 31

def to_hash: -> {