Class: Orb::Models::CreditNote::MaximumAmountAdjustment

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/orb/models/credit_note.rb

Overview

See Also:

Defined Under Namespace

Modules: DiscountType Classes: AppliesToPrice

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_applied: , discount_type: , percentage_discount: , applies_to_prices: nil, reason: nil) ⇒ Object

The maximum amount applied on the original invoice

Parameters:




# File 'lib/orb/models/credit_note.rb', line 306

Instance Attribute Details

#amount_applied ⇒ String

Returns:

  • (String) 


280
 
# File 'lib/orb/models/credit_note.rb', line 280

required :amount_applied, String

#applies_to_prices ⇒ Array<Orb::Models::CreditNote::MaximumAmountAdjustment::AppliesToPrice>?

Returns:



295
296
297
298
299
 
# File 'lib/orb/models/credit_note.rb', line 295

optional :applies_to_prices,
-> {
  Orb::Internal::Type::ArrayOf[Orb::CreditNote::MaximumAmountAdjustment::AppliesToPrice]
},
nil?: true

#discount_type ⇒ Symbol, Orb::Models::CreditNote::MaximumAmountAdjustment::DiscountType

Returns:



285
 
# File 'lib/orb/models/credit_note.rb', line 285

required :discount_type, enum: -> { Orb::CreditNote::MaximumAmountAdjustment::DiscountType }

#percentage_discount ⇒ Float

Returns:

  • (Float) 


290
 
# File 'lib/orb/models/credit_note.rb', line 290

required :percentage_discount, Float

#reason ⇒ String?

Returns:

  • (String, nil) 


304
 
# File 'lib/orb/models/credit_note.rb', line 304

optional :reason, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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