Class: Dodopayments::Models::CreditEntitlements::BalanceCreateLedgerEntryResponse

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

Overview

See Also:

  • Dodopayments::Resources::CreditEntitlements::Balances#create_ledger_entry

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:, balance_after:, balance_before:, created_at:, credit_entitlement_id:, customer_id:, entry_type:, is_credit:, metadata:, overage_after:, overage_before:, grant_id: nil, reason: nil) ⇒ Object

Response for creating a ledger entry

Parameters:

  • id (String)
  • amount (String)
  • balance_after (String)
  • balance_before (String)
  • created_at (Time)
  • credit_entitlement_id (String)
  • customer_id (String)
  • entry_type (Symbol, Dodopayments::Models::CreditEntitlements::LedgerEntryType)
  • is_credit (Boolean)
  • metadata (Hash{Symbol=>String, Float, Boolean}) —

    Metadata stored on this entry.

  • overage_after (String)
  • overage_before (String)
  • grant_id (String, nil) (defaults to: nil)
  • reason (String, nil) (defaults to: nil) 



# File 'lib/dodopayments/models/credit_entitlements/balance_create_ledger_entry_response.rb', line 79

Instance Attribute Details

#amount ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


16
 
# File 'lib/dodopayments/models/credit_entitlements/balance_create_ledger_entry_response.rb', line 16

required :amount, String

#balance_after ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


21
 
# File 'lib/dodopayments/models/credit_entitlements/balance_create_ledger_entry_response.rb', line 21

required :balance_after, String

#balance_before ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


26
 
# File 'lib/dodopayments/models/credit_entitlements/balance_create_ledger_entry_response.rb', line 26

required :balance_before, String

#created_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


31
 
# File 'lib/dodopayments/models/credit_entitlements/balance_create_ledger_entry_response.rb', line 31

required :created_at, Time

#credit_entitlement_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


36
 
# File 'lib/dodopayments/models/credit_entitlements/balance_create_ledger_entry_response.rb', line 36

required :credit_entitlement_id, String

#customer_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


41
 
# File 'lib/dodopayments/models/credit_entitlements/balance_create_ledger_entry_response.rb', line 41

required :customer_id, String

#entry_type ⇒ Symbol, Dodopayments::Models::CreditEntitlements::LedgerEntryType

Parameters:

  • value (Dodopayments::Models::CreditEntitlements::ledger_entry_type)

Returns:



46
 
# File 'lib/dodopayments/models/credit_entitlements/balance_create_ledger_entry_response.rb', line 46

required :entry_type, enum: -> { Dodopayments::CreditEntitlements::LedgerEntryType }

#grant_id ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


72
 
# File 'lib/dodopayments/models/credit_entitlements/balance_create_ledger_entry_response.rb', line 72

optional :grant_id, String, nil?: true

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/dodopayments/models/credit_entitlements/balance_create_ledger_entry_response.rb', line 11

required :id, String

#is_credit ⇒ Boolean

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


51
 
# File 'lib/dodopayments/models/credit_entitlements/balance_create_ledger_entry_response.rb', line 51

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

#metadata ⇒ Hash{Symbol=>String, Float, Boolean}

Metadata stored on this entry.

Parameters:

  • value (Dodopayments::Models::metadata)

Returns:

  • (Hash{Symbol=>String, Float, Boolean}) 


57
 
# File 'lib/dodopayments/models/credit_entitlements/balance_create_ledger_entry_response.rb', line 57

required :metadata, -> { Dodopayments::Internal::Type::HashOf[union: Dodopayments::MetadataItem] }

#overage_after ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


62
 
# File 'lib/dodopayments/models/credit_entitlements/balance_create_ledger_entry_response.rb', line 62

required :overage_after, String

#overage_before ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :overage_before, String

#reason ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


77
 
# File 'lib/dodopayments/models/credit_entitlements/balance_create_ledger_entry_response.rb', line 77

optional :reason, String, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


68
 
# File 'sig/dodopayments/models/credit_entitlements/balance_create_ledger_entry_response.rbs', line 68

def to_hash: -> {