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

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

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::InvoiceIssuedSummaryWebhookEvent::Invoice::CustomerBalanceTransaction for more details.

Parameters:




# File 'lib/orb/models/invoice_issued_summary_webhook_event.rb', line 652

Instance Attribute Details

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

Parameters:

  • value (Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::CustomerBalanceTransaction::action)

Returns:



601
602
 
# File 'lib/orb/models/invoice_issued_summary_webhook_event.rb', line 601

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

#amount ⇒ String

The value of the amount changed in the transaction.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :amount, String

#created_at ⇒ Time

The creation time of this transaction.

Parameters:

  • value (Time)

Returns:

  • (Time) 


614
 
# File 'lib/orb/models/invoice_issued_summary_webhook_event.rb', line 614

required :created_at, Time

#credit_note ⇒ Orb::Models::CreditNoteTiny?

Parameters:

Returns:



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

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

#description ⇒ String?

An optional description provided for manual customer balance adjustments.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

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.

Parameters:

  • value (String)

Returns:

  • (String) 


632
 
# File 'lib/orb/models/invoice_issued_summary_webhook_event.rb', line 632

required :ending_balance, String

#id ⇒ String

A unique id for this transaction.

Parameters:

  • value (String)

Returns:

  • (String) 


596
 
# File 'lib/orb/models/invoice_issued_summary_webhook_event.rb', line 596

required :id, String

#invoice ⇒ Orb::Models::InvoiceTiny?

Parameters:

Returns:



637
 
# File 'lib/orb/models/invoice_issued_summary_webhook_event.rb', line 637

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.

Parameters:

  • value (String)

Returns:

  • (String) 


644
 
# File 'lib/orb/models/invoice_issued_summary_webhook_event.rb', line 644

required :starting_balance, String

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

Parameters:

  • value (Orb::Models::InvoiceIssuedSummaryWebhookEvent::Invoice::CustomerBalanceTransaction::type_)

Returns:



649
650
 
# File 'lib/orb/models/invoice_issued_summary_webhook_event.rb', line 649

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/orb/models/invoice_issued_summary_webhook_event.rb', line 693

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


342
 
# File 'sig/orb/models/invoice_issued_summary_webhook_event.rbs', line 342

def to_hash: -> {