Class: Orb::Models::Plan::PlanPhase

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Orb::Models::Plan::PlanPhase

Defined in:

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

Defined Under Namespace

Modules: DurationUnit

Instance Attribute Summary

• #description ⇒ String^?
• #discount ⇒ Orb::Models::PercentageDiscount, ...
• #duration ⇒ Integer^?

  How many terms of length duration_unit this phase is active for.

• #duration_unit ⇒ Symbol, ...
• #id ⇒ String
• #maximum ⇒ Orb::Models::Maximum^?
• #maximum_amount ⇒ String^?
• #minimum ⇒ Orb::Models::Minimum^?
• #minimum_amount ⇒ String^?
• #name ⇒ String
• #order ⇒ Integer

  Determines the ordering of the phase in a plan's lifecycle.

Instance Method Summary

• #initialize(id:, description:, discount:, duration:, duration_unit:, maximum:, maximum_amount:, minimum:, minimum_amount:, name:, order:) ⇒ Object constructor

  Some parameter documentations has been truncated, see PlanPhase 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(id:, description:, discount:, duration:, duration_unit:, maximum:, maximum_amount:, minimum:, minimum_amount:, name:, order:) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::Plan::PlanPhase for more details.

Parameters:

• id (String)
• description (String, nil)
• discount (Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount, Orb::Models::Discount::TieredPercentage, nil)
• duration (Integer, nil) —

  How many terms of length duration_unit this phase is active for. If null, this

• duration_unit (Symbol, Orb::Models::Plan::PlanPhase::DurationUnit, nil)
• maximum (Orb::Models::Maximum, nil)
• maximum_amount (String, nil)
• minimum (Orb::Models::Minimum, nil)
• minimum_amount (String, nil)
• name (String)
• order (Integer) —

  Determines the ordering of the phase in a plan's lifecycle. 1 = first phase.

# File 'lib/orb/models/plan.rb', line 515

Instance Attribute Details

#description ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/orb/models/plan.rb', line 465

required :description, String, nil?: true

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

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/plan.rb', line 470

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

#duration ⇒ Integer^?

How many terms of length duration_unit this phase is active for. If null, this phase is evergreen and active indefinitely

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

# File 'lib/orb/models/plan.rb', line 477

required :duration, Integer, nil?: true

#duration_unit ⇒ Symbol, ...

Parameters:

• value (Orb::Models::Plan::PlanPhase::duration_unit, nil)

Returns:

• (Symbol, Orb::Models::Plan::PlanPhase::DurationUnit, nil)

# File 'lib/orb/models/plan.rb', line 482

required :duration_unit, enum: -> { Orb::Plan::PlanPhase::DurationUnit }, nil?: true

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/orb/models/plan.rb', line 460

required :id, String

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

Parameters:

• value (Orb::Maximum, nil)

Returns:

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

# File 'lib/orb/models/plan.rb', line 487

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

#maximum_amount ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/orb/models/plan.rb', line 492

required :maximum_amount, String, nil?: true

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

Parameters:

• value (Orb::Minimum, nil)

Returns:

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

# File 'lib/orb/models/plan.rb', line 497

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

#minimum_amount ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/orb/models/plan.rb', line 502

required :minimum_amount, String, nil?: true

#name ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/orb/models/plan.rb', line 507

required :name, String

#order ⇒ Integer

Determines the ordering of the phase in a plan's lifecycle. 1 = first phase.

Parameters:

• value (Integer)

Returns:

• (Integer)

# File 'lib/orb/models/plan.rb', line 513

required :order, Integer

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/orb/models/plan.rbs', line 355

def to_hash: -> {