Class: Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction

Defined in:

lib/orb/models/invoice_fetch_upcoming_response.rb

Defined Under Namespace

Modules: Action, Type

Instance Attribute Summary

• #action ⇒ Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Action
• #amount ⇒ String

  The value of the amount changed in the transaction.

• #created_at ⇒ Time

  The creation time of this transaction.

• #credit_note ⇒ Orb::Models::CreditNoteTiny^?
• #description ⇒ String^?

  An optional description provided for manual customer balance adjustments.

• #ending_balance ⇒ String

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

• #id ⇒ String

  A unique id for this transaction.

• #invoice ⇒ Orb::Models::InvoiceTiny^?
• #starting_balance ⇒ String

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

• #type ⇒ Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Type

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(id: , action: , amount: , created_at: , credit_note: , description: , ending_balance: , invoice: , starting_balance: , type: ) ⇒ Object constructor

  Some parameter documentations has been truncated, see CustomerBalanceTransaction for more details.

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

Parameters:

• id (String) (defaults to: ) —

  A unique id for this transaction.

• action (Symbol, Orb::Models::InvoiceFetchUpcomingResponse::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::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Type) (defaults to: )

# File 'lib/orb/models/invoice_fetch_upcoming_response.rb', line 661

Instance Attribute Details

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

Returns:

• (Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Action)

# File 'lib/orb/models/invoice_fetch_upcoming_response.rb', line 611

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

#amount ⇒ String

The value of the amount changed in the transaction.

Returns:

• (String)

# File 'lib/orb/models/invoice_fetch_upcoming_response.rb', line 618

required :amount, String

#created_at ⇒ Time

The creation time of this transaction.

Returns:

• (Time)

# File 'lib/orb/models/invoice_fetch_upcoming_response.rb', line 624

required :created_at, Time

#credit_note ⇒ Orb::Models::CreditNoteTiny^?

Returns:

• (Orb::Models::CreditNoteTiny, nil)

# File 'lib/orb/models/invoice_fetch_upcoming_response.rb', line 629

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

#description ⇒ String^?

An optional description provided for manual customer balance adjustments.

Returns:

• (String, nil)

# File 'lib/orb/models/invoice_fetch_upcoming_response.rb', line 635

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)

# File 'lib/orb/models/invoice_fetch_upcoming_response.rb', line 642

required :ending_balance, String

#id ⇒ String

A unique id for this transaction.

Returns:

• (String)

# File 'lib/orb/models/invoice_fetch_upcoming_response.rb', line 606

required :id, String

#invoice ⇒ Orb::Models::InvoiceTiny^?

Returns:

• (Orb::Models::InvoiceTiny, nil)

# File 'lib/orb/models/invoice_fetch_upcoming_response.rb', line 647

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)

# File 'lib/orb/models/invoice_fetch_upcoming_response.rb', line 654

required :starting_balance, String

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

Returns:

• (Symbol, Orb::Models::InvoiceFetchUpcomingResponse::CustomerBalanceTransaction::Type)

# File 'lib/orb/models/invoice_fetch_upcoming_response.rb', line 659

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

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