Class: Orb::Models::Customers::Credits::DecrementLedgerEntry

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

Defined Under Namespace

Modules: EntryStatus, EntryType

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:, amount:, created_at:, credit_block:, currency:, customer:, description:, ending_balance:, entry_status:, entry_type:, ledger_sequence_number:, metadata:, starting_balance:, event_id: nil, invoice_id: nil, price_id: nil) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::Customers::Credits::DecrementLedgerEntry for more details.

Parameters:




# File 'lib/orb/models/customers/credits/decrement_ledger_entry.rb', line 96

Instance Attribute Details

#amount ⇒ Float

Parameters:

  • value (Float)

Returns:

  • (Float) 


16
 
# File 'lib/orb/models/customers/credits/decrement_ledger_entry.rb', line 16

required :amount, Float

#created_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


21
 
# File 'lib/orb/models/customers/credits/decrement_ledger_entry.rb', line 21

required :created_at, Time

#credit_block ⇒ Orb::Models::Customers::Credits::AffectedBlock

Parameters:

  • value (Orb::Customers::Credits::AffectedBlock)

Returns:



26
 
# File 'lib/orb/models/customers/credits/decrement_ledger_entry.rb', line 26

required :credit_block, -> { Orb::Customers::Credits::AffectedBlock }

#currency ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


31
 
# File 'lib/orb/models/customers/credits/decrement_ledger_entry.rb', line 31

required :currency, String

#customer ⇒ Orb::Models::CustomerMinified

Parameters:

Returns:



36
 
# File 'lib/orb/models/customers/credits/decrement_ledger_entry.rb', line 36

required :customer, -> { Orb::CustomerMinified }

#description ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


41
 
# File 'lib/orb/models/customers/credits/decrement_ledger_entry.rb', line 41

required :description, String, nil?: true

#ending_balance ⇒ Float

Parameters:

  • value (Float)

Returns:

  • (Float) 


46
 
# File 'lib/orb/models/customers/credits/decrement_ledger_entry.rb', line 46

required :ending_balance, Float

#entry_status ⇒ Symbol, Orb::Models::Customers::Credits::DecrementLedgerEntry::EntryStatus

Parameters:

  • value (Orb::Models::Customers::Credits::DecrementLedgerEntry::entry_status)

Returns:



51
 
# File 'lib/orb/models/customers/credits/decrement_ledger_entry.rb', line 51

required :entry_status, enum: -> { Orb::Customers::Credits::DecrementLedgerEntry::EntryStatus }

#entry_type ⇒ Symbol, Orb::Models::Customers::Credits::DecrementLedgerEntry::EntryType

Parameters:

  • value (Orb::Models::Customers::Credits::DecrementLedgerEntry::entry_type)

Returns:



56
 
# File 'lib/orb/models/customers/credits/decrement_ledger_entry.rb', line 56

required :entry_type, enum: -> { Orb::Customers::Credits::DecrementLedgerEntry::EntryType }

#event_id ⇒ String?

Deprecated.

This field is deprecated and will always be null. Decrements are not associated with individual events.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


84
 
# File 'lib/orb/models/customers/credits/decrement_ledger_entry.rb', line 84

optional :event_id, String, nil?: true

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/orb/models/customers/credits/decrement_ledger_entry.rb', line 11

required :id, String

#invoice_id ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


89
 
# File 'lib/orb/models/customers/credits/decrement_ledger_entry.rb', line 89

optional :invoice_id, String, nil?: true

#ledger_sequence_number ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


61
 
# File 'lib/orb/models/customers/credits/decrement_ledger_entry.rb', line 61

required :ledger_sequence_number, Integer

#metadata ⇒ Hash{Symbol=>String}

User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to null, and the entire metadata mapping can be cleared by setting metadata to null.

Parameters:

  • value (::Hash[Symbol, String])

Returns:

  • (Hash{Symbol=>String}) 


70
 
# File 'lib/orb/models/customers/credits/decrement_ledger_entry.rb', line 70

required :metadata, Orb::Internal::Type::HashOf[String]

#price_id ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


94
 
# File 'lib/orb/models/customers/credits/decrement_ledger_entry.rb', line 94

optional :price_id, String, nil?: true

#starting_balance ⇒ Float

Parameters:

  • value (Float)

Returns:

  • (Float) 


75
 
# File 'lib/orb/models/customers/credits/decrement_ledger_entry.rb', line 75

required :starting_balance, Float

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/orb/models/customers/credits/decrement_ledger_entry.rb', line 139

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


77
 
# File 'sig/orb/models/customers/credits/decrement_ledger_entry.rbs', line 77

def to_hash: -> {