Class: Orb::Models::Customers::Credits::VoidLedgerEntry

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Orb::Models::Customers::Credits::VoidLedgerEntry

Defined in:

lib/orb/models/customers/credits/void_ledger_entry.rb

Defined Under Namespace

Modules: EntryStatus, EntryType

Instance Attribute Summary

• #amount ⇒ Float
• #created_at ⇒ Time
• #credit_block ⇒ Orb::Models::Customers::Credits::AffectedBlock
• #currency ⇒ String
• #customer ⇒ Orb::Models::CustomerMinified
• #description ⇒ String^?
• #ending_balance ⇒ Float
• #entry_status ⇒ Symbol, Orb::Models::Customers::Credits::VoidLedgerEntry::EntryStatus
• #entry_type ⇒ Symbol, Orb::Models::Customers::Credits::VoidLedgerEntry::EntryType
• #id ⇒ String
• #ledger_sequence_number ⇒ Integer
• #metadata ⇒ Hash{Symbol=>String}

  User specified key-value pairs for the resource.

• #starting_balance ⇒ Float
• #void_amount ⇒ Float
• #void_reason ⇒ String^?

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(id: , amount: , created_at: , credit_block: , currency: , customer: , description: , ending_balance: , entry_status: , entry_type: , ledger_sequence_number: , metadata: , starting_balance: , void_amount: , void_reason: ) ⇒ Object constructor

  Some parameter documentations has been truncated, see VoidLedgerEntry 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: , amount: , created_at: , credit_block: , currency: , customer: , description: , ending_balance: , entry_status: , entry_type: , ledger_sequence_number: , metadata: , starting_balance: , void_amount: , void_reason: ) ⇒ Object

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

Parameters:

• id (String) (defaults to: )
• amount (Float) (defaults to: )
• created_at (Time) (defaults to: )
• credit_block (Orb::Models::Customers::Credits::AffectedBlock) (defaults to: )
• currency (String) (defaults to: )
• customer (Orb::Models::CustomerMinified) (defaults to: )
• description (String, nil) (defaults to: )
• ending_balance (Float) (defaults to: )
• entry_status (Symbol, Orb::Models::Customers::Credits::VoidLedgerEntry::EntryStatus) (defaults to: )
• entry_type (Symbol, Orb::Models::Customers::Credits::VoidLedgerEntry::EntryType) (defaults to: )
• ledger_sequence_number (Integer) (defaults to: )
• metadata (Hash{Symbol=>String}) (defaults to: ) —

  User specified key-value pairs for the resource. If not present, this defaults t

• starting_balance (Float) (defaults to: )
• void_amount (Float) (defaults to: )
• void_reason (String, nil) (defaults to: )

# File 'lib/orb/models/customers/credits/void_ledger_entry.rb', line 87

Instance Attribute Details

#amount ⇒ Float

Returns:

• (Float)

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

required :amount, Float

#created_at ⇒ Time

Returns:

• (Time)

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

required :created_at, Time

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

Returns:

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

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

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

#currency ⇒ String

Returns:

• (String)

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

required :currency, String

#customer ⇒ Orb::Models::CustomerMinified

Returns:

• (Orb::Models::CustomerMinified)

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

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

#description ⇒ String^?

Returns:

• (String, nil)

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

required :description, String, nil?: true

#ending_balance ⇒ Float

Returns:

• (Float)

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

required :ending_balance, Float

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

Returns:

• (Symbol, Orb::Models::Customers::Credits::VoidLedgerEntry::EntryStatus)

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

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

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

Returns:

• (Symbol, Orb::Models::Customers::Credits::VoidLedgerEntry::EntryType)

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

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

#id ⇒ String

Returns:

• (String)

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

required :id, String

#ledger_sequence_number ⇒ Integer

Returns:

• (Integer)

# File 'lib/orb/models/customers/credits/void_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`.

Returns:

• (Hash{Symbol=>String})

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

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

#starting_balance ⇒ Float

Returns:

• (Float)

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

required :starting_balance, Float

#void_amount ⇒ Float

Returns:

• (Float)

# File 'lib/orb/models/customers/credits/void_ledger_entry.rb', line 80

required :void_amount, Float

#void_reason ⇒ String^?

Returns:

• (String, nil)

# File 'lib/orb/models/customers/credits/void_ledger_entry.rb', line 85

required :void_reason, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/orb/models/customers/credits/void_ledger_entry.rb', line 128