Class: Orb::Models::Invoice::CustomerBalanceTransaction

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

Defined Under Namespace

Modules: Action, Type

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(id: , action: , amount: , created_at: , credit_note: , description: , ending_balance: , invoice: , starting_balance: , type: ) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::Invoice::CustomerBalanceTransaction for more details.

Parameters:

  • id (String) (defaults to: ) —

    A unique id for this transaction.

  • action (Symbol, Orb::Models::Invoice::CustomerBalanceTransaction::Action) (defaults to: )
  • amount (String) (defaults to: ) —

    The value of the amount changed in the transaction.

  • created_at (Time) (defaults to: ) —

    The creation time of this transaction.

  • credit_note (Orb::Models::CreditNoteTiny, nil) (defaults to: )
  • description (String, nil) (defaults to: ) —

    An optional description provided for manual customer balance adjustments.

  • ending_balance (String) (defaults to: ) —

    The new value of the customer’s balance prior to the transaction, in the custome

  • invoice (Orb::Models::InvoiceTiny, nil) (defaults to: )
  • starting_balance (String) (defaults to: ) —

    The original value of the customer’s balance prior to the transaction, in the cu

  • type (Symbol, Orb::Models::Invoice::CustomerBalanceTransaction::Type) (defaults to: ) 



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

Instance Attribute Details

#action ⇒ Symbol, Orb::Models::Invoice::CustomerBalanceTransaction::Action

Returns:



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

required :action, enum: -> { Orb::Invoice::CustomerBalanceTransaction::Action }

#amount ⇒ String

The value of the amount changed in the transaction.

Returns:

  • (String) 


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

required :amount, String

#created_at ⇒ Time

The creation time of this transaction.

Returns:

  • (Time) 


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

required :created_at, Time

#credit_note ⇒ Orb::Models::CreditNoteTiny?

Returns:



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

required :credit_note, -> { Orb::CreditNoteTiny }, nil?: true

#description ⇒ String?

An optional description provided for manual customer balance adjustments.

Returns:

  • (String, nil) 


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

required :description, String, nil?: true

#ending_balance ⇒ String

The new value of the customer’s balance prior to the transaction, in the customer’s currency.

Returns:

  • (String) 


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

required :ending_balance, String

#id ⇒ String

A unique id for this transaction.

Returns:

  • (String) 


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

required :id, String

#invoice ⇒ Orb::Models::InvoiceTiny?

Returns:



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

required :invoice, -> { Orb::InvoiceTiny }, nil?: true

#starting_balance ⇒ String

The original value of the customer’s balance prior to the transaction, in the customer’s currency.

Returns:

  • (String) 


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

required :starting_balance, String

#type ⇒ Symbol, Orb::Models::Invoice::CustomerBalanceTransaction::Type

Returns:



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

required :type, enum: -> { Orb::Invoice::CustomerBalanceTransaction::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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