Class: Orb::Models::Invoice::CreditNote

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

Instance Attribute 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 ⇒ Object 



282
 
# File 'sig/orb/models/invoice.rbs', line 282

def initialize: (

Instance Attribute Details

#credit_note_number ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


571
 
# File 'lib/orb/models/invoice.rb', line 571

required :credit_note_number, String

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


566
 
# File 'lib/orb/models/invoice.rb', line 566

required :id, String

#memo ⇒ String?

An optional memo supplied on the credit note.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


577
 
# File 'lib/orb/models/invoice.rb', line 577

required :memo, String, nil?: true

#reason ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


582
 
# File 'lib/orb/models/invoice.rb', line 582

required :reason, String

#total ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


587
 
# File 'lib/orb/models/invoice.rb', line 587

required :total, String

#type ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


592
 
# File 'lib/orb/models/invoice.rb', line 592

required :type, String

#voided_at ⇒ Time?

If the credit note has a status of void, this gives a timestamp when the credit note was voided.

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


599
 
# File 'lib/orb/models/invoice.rb', line 599

required :voided_at, Time, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


292
 
# File 'sig/orb/models/invoice.rbs', line 292

def to_hash: -> {