Class: Orb::Models::Price::Package

Inherits:

Internal::Type::BaseModel

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

Defined in:

lib/orb/models/price.rb

Defined Under Namespace

Modules: Cadence, ConversionRateConfig, PriceType

Instance Attribute Summary

• #billable_metric ⇒ Orb::Models::BillableMetricTiny^?
• #billing_cycle_configuration ⇒ Orb::Models::BillingCycleConfiguration
• #cadence ⇒ Symbol, Orb::Models::Price::Package::Cadence
• #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
• #invoicing_cycle_configuration ⇒ Orb::Models::BillingCycleConfiguration^?
• #item ⇒ Orb::Models::ItemSlim
• #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, :package
• #name ⇒ String
• #package_config ⇒ Orb::Models::PackageConfig
• #plan_phase_order ⇒ Integer^?
• #price_type ⇒ Symbol, Orb::Models::Price::Package::PriceType
• #replaces_price_id ⇒ String^?

  The price id this price replaces.

Class Method Summary

• .values ⇒ Array<Symbol>
• .variants ⇒ Array(Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig)

Instance Method Summary

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

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

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: , cadence: , conversion_rate: , conversion_rate_config: , created_at: , credit_allocation: , currency: , discount: , external_price_id: , fixed_price_quantity: , invoicing_cycle_configuration: , item: , maximum: , maximum_amount: , metadata: , minimum: , minimum_amount: , name: , package_config: , plan_phase_order: , price_type: , replaces_price_id: , dimensional_price_configuration: nil, model_type: :package) ⇒ Object

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

Parameters:

• id (String) (defaults to: )
• billable_metric (Orb::Models::BillableMetricTiny, nil) (defaults to: )
• billing_cycle_configuration (Orb::Models::BillingCycleConfiguration) (defaults to: )
• cadence (Symbol, Orb::Models::Price::Package::Cadence) (defaults to: )
• conversion_rate (Float, nil) (defaults to: )
• conversion_rate_config (Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil) (defaults to: )
• created_at (Time) (defaults to: )
• credit_allocation (Orb::Models::Allocation, nil) (defaults to: )
• currency (String) (defaults to: )
• discount (Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil) (defaults to: )
• external_price_id (String, nil) (defaults to: )
• fixed_price_quantity (Float, nil) (defaults to: )
• invoicing_cycle_configuration (Orb::Models::BillingCycleConfiguration, nil) (defaults to: )
• item (Orb::Models::ItemSlim) (defaults to: )
• maximum (Orb::Models::Maximum, nil) (defaults to: )
• maximum_amount (String, nil) (defaults to: )
• metadata (Hash{Symbol=>String}) (defaults to: ) —

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

• minimum (Orb::Models::Minimum, nil) (defaults to: )
• minimum_amount (String, nil) (defaults to: )
• name (String) (defaults to: )
• package_config (Orb::Models::PackageConfig) (defaults to: )
• plan_phase_order (Integer, nil) (defaults to: )
• price_type (Symbol, Orb::Models::Price::Package::PriceType) (defaults to: )
• replaces_price_id (String, nil) (defaults to: ) —

  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)
• model_type (Symbol, :package) (defaults to: :package)

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

Instance Attribute Details

#billable_metric ⇒ Orb::Models::BillableMetricTiny^?

Returns:

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

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

required :billable_metric, -> { Orb::BillableMetricTiny }, nil?: true

#billing_cycle_configuration ⇒ Orb::Models::BillingCycleConfiguration

Returns:

• (Orb::Models::BillingCycleConfiguration)

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

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

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

Returns:

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

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

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

#conversion_rate ⇒ Float^?

Returns:

• (Float, nil)

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

required :conversion_rate, Float, nil?: true

#conversion_rate_config ⇒ Orb::Models::UnitConversionRateConfig, ...

Returns:

• (Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig, nil)

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

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

#created_at ⇒ Time

Returns:

• (Time)

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

required :created_at, Time

#credit_allocation ⇒ Orb::Models::Allocation^?

Returns:

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

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

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

#currency ⇒ String

Returns:

• (String)

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

required :currency, String

#dimensional_price_configuration ⇒ Orb::Models::DimensionalPriceConfiguration^?

Returns:

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

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

optional :dimensional_price_configuration, -> { Orb::DimensionalPriceConfiguration }, nil?: true

#discount ⇒ Orb::Models::PercentageDiscount, ...

Deprecated.

Returns:

• (Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, nil)

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

required :discount, union: -> { Orb::Discount }, nil?: true

#external_price_id ⇒ String^?

Returns:

• (String, nil)

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

required :external_price_id, String, nil?: true

#fixed_price_quantity ⇒ Float^?

Returns:

• (Float, nil)

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

required :fixed_price_quantity, Float, nil?: true

#id ⇒ String

Returns:

• (String)

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

required :id, String

#invoicing_cycle_configuration ⇒ Orb::Models::BillingCycleConfiguration^?

Returns:

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

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

required :invoicing_cycle_configuration, -> { Orb::BillingCycleConfiguration }, nil?: true

#item ⇒ Orb::Models::ItemSlim

Returns:

• (Orb::Models::ItemSlim)

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

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

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

Deprecated.

Returns:

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

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

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

#maximum_amount ⇒ String^?

Deprecated.

Returns:

• (String, nil)

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

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`.

Returns:

• (Hash{Symbol=>String})

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

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

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

Deprecated.

Returns:

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

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

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

#minimum_amount ⇒ String^?

Deprecated.

Returns:

• (String, nil)

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

required :minimum_amount, String, nil?: true

#model_type ⇒ Symbol, :package

Returns:

• (Symbol, :package)

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

required :model_type, const: :package

#name ⇒ String

Returns:

• (String)

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

required :name, String

#package_config ⇒ Orb::Models::PackageConfig

Returns:

• (Orb::Models::PackageConfig)

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

required :package_config, -> { Orb::PackageConfig }

#plan_phase_order ⇒ Integer^?

Returns:

• (Integer, nil)

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

required :plan_phase_order, Integer, nil?: true

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

Returns:

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

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

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

Returns:

• (String, nil)

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

required :replaces_price_id, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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

.variants ⇒ Array(Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig)

Returns:

• (Array(Orb::Models::UnitConversionRateConfig, Orb::Models::TieredConversionRateConfig))

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