Class: Dodopayments::Models::BalanceLedgerEntry

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

Overview

See Also:

  • Dodopayments::Resources::Balances#retrieve_ledger

Defined Under Namespace

Modules: EventType

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(id:, amount:, business_id:, created_at:, currency:, event_type:, is_credit:, usd_equivalent_amount:, after_balance: nil, before_balance: nil, description: nil, reference_object_id: nil) ⇒ Object

Parameters:

  • id (String)
  • amount (Integer)
  • business_id (String)
  • created_at (Time)
  • currency (Symbol, Dodopayments::Models::Currency)
  • event_type (Symbol, Dodopayments::Models::BalanceLedgerEntry::EventType)
  • is_credit (Boolean)
  • usd_equivalent_amount (Integer)
  • after_balance (Integer, nil) (defaults to: nil)
  • before_balance (Integer, nil) (defaults to: nil)
  • description (String, nil) (defaults to: nil)
  • reference_object_id (String, nil) (defaults to: nil) 



# File 'lib/dodopayments/models/balance_ledger_entry.rb', line 67

Instance Attribute Details

#after_balance ⇒ Integer?

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


50
 
# File 'lib/dodopayments/models/balance_ledger_entry.rb', line 50

optional :after_balance, Integer, nil?: true

#amount ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


15
 
# File 'lib/dodopayments/models/balance_ledger_entry.rb', line 15

required :amount, Integer

#before_balance ⇒ Integer?

Parameters:

  • value (Integer, nil)

Returns:

  • (Integer, nil) 


55
 
# File 'lib/dodopayments/models/balance_ledger_entry.rb', line 55

optional :before_balance, Integer, nil?: true

#business_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


20
 
# File 'lib/dodopayments/models/balance_ledger_entry.rb', line 20

required :business_id, String

#created_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


25
 
# File 'lib/dodopayments/models/balance_ledger_entry.rb', line 25

required :created_at, Time

#currency ⇒ Symbol, Dodopayments::Models::Currency

Parameters:

  • value (Dodopayments::Models::currency)

Returns:



30
 
# File 'lib/dodopayments/models/balance_ledger_entry.rb', line 30

required :currency, enum: -> { Dodopayments::Currency }

#description ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


60
 
# File 'lib/dodopayments/models/balance_ledger_entry.rb', line 60

optional :description, String, nil?: true

#event_type ⇒ Symbol, Dodopayments::Models::BalanceLedgerEntry::EventType

Parameters:

  • value (Dodopayments::Models::BalanceLedgerEntry::event_type)

Returns:



35
 
# File 'lib/dodopayments/models/balance_ledger_entry.rb', line 35

required :event_type, enum: -> { Dodopayments::BalanceLedgerEntry::EventType }

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


10
 
# File 'lib/dodopayments/models/balance_ledger_entry.rb', line 10

required :id, String

#is_credit ⇒ Boolean

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


40
 
# File 'lib/dodopayments/models/balance_ledger_entry.rb', line 40

required :is_credit, Dodopayments::Internal::Type::Boolean

#reference_object_id ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


65
 
# File 'lib/dodopayments/models/balance_ledger_entry.rb', line 65

optional :reference_object_id, String, nil?: true

#usd_equivalent_amount ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


45
 
# File 'lib/dodopayments/models/balance_ledger_entry.rb', line 45

required :usd_equivalent_amount, Integer

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


59
 
# File 'sig/dodopayments/models/balance_ledger_entry.rbs', line 59

def to_hash: -> {