Class: Orb::Models::AmountDiscountInterval

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/orb/models/amount_discount_interval.rb,
sig/orb/models/amount_discount_interval.rbs

Defined Under Namespace

Modules: DiscountType Classes: Filter

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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(amount_discount:, applies_to_price_interval_ids:, discount_type:, end_date:, filters:, start_date:) ⇒ Object

Parameters:

  • amount_discount (String) —

    Only available if discount_type is amount.

  • applies_to_price_interval_ids (Array<String>) —

    The price interval ids that this discount interval applies to.

  • discount_type (Symbol, Orb::Models::AmountDiscountInterval::DiscountType)
  • end_date (Time, nil) —

    The end date of the discount interval.

  • filters (Array<Orb::Models::AmountDiscountInterval::Filter>) —

    The filters that determine which prices this discount interval applies to.

  • start_date (Time) —

    The start date of the discount interval.




# File 'lib/orb/models/amount_discount_interval.rb', line 41

Instance Attribute Details

#amount_discount ⇒ String

Only available if discount_type is amount.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :amount_discount, String

#applies_to_price_interval_ids ⇒ Array<String>

The price interval ids that this discount interval applies to.

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


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

required :applies_to_price_interval_ids, Orb::Internal::Type::ArrayOf[String]

#discount_type ⇒ Symbol, Orb::Models::AmountDiscountInterval::DiscountType

Parameters:

  • value (Orb::Models::AmountDiscountInterval::discount_type)

Returns:



21
 
# File 'lib/orb/models/amount_discount_interval.rb', line 21

required :discount_type, enum: -> { Orb::AmountDiscountInterval::DiscountType }

#end_date ⇒ Time?

The end date of the discount interval.

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


27
 
# File 'lib/orb/models/amount_discount_interval.rb', line 27

required :end_date, Time, nil?: true

#filters ⇒ Array<Orb::Models::AmountDiscountInterval::Filter>

The filters that determine which prices this discount interval applies to.

Parameters:

  • value (::Array[Orb::AmountDiscountInterval::Filter])

Returns:



33
 
# File 'lib/orb/models/amount_discount_interval.rb', line 33

required :filters, -> { Orb::Internal::Type::ArrayOf[Orb::AmountDiscountInterval::Filter] }

#start_date ⇒ Time

The start date of the discount interval.

Parameters:

  • value (Time)

Returns:

  • (Time) 


39
 
# File 'lib/orb/models/amount_discount_interval.rb', line 39

required :start_date, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/orb/models/amount_discount_interval.rb', line 60

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


35
 
# File 'sig/orb/models/amount_discount_interval.rbs', line 35

def to_hash: -> {