Class: ModernTreasury::Models::Ledger

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/modern_treasury/models/ledger.rb

Overview

See Also:

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: , created_at: , description: , discarded_at: , live_mode: , metadata: , name: , object: , updated_at: ) ⇒ Object

Some parameter documentations has been truncated, see ModernTreasury::Models::Ledger for more details.

Parameters:

  • id (String) (defaults to: )
  • created_at (Time) (defaults to: )
  • description (String, nil) (defaults to: ) —

    An optional free-form description for internal use.

  • discarded_at (Time, nil) (defaults to: )
  • live_mode (Boolean) (defaults to: ) —

    This field will be true if this object exists in the live environment or false i

  • metadata (Hash{Symbol=>String}) (defaults to: ) —

    Additional data represented as key-value pairs. Both the key and value must be s

  • name (String) (defaults to: ) —

    The name of the ledger.

  • object (String) (defaults to: )
  • updated_at (Time) (defaults to: ) 



# File 'lib/modern_treasury/models/ledger.rb', line 58

Instance Attribute Details

#created_at ⇒ Time

Returns:

  • (Time) 


15
 
# File 'lib/modern_treasury/models/ledger.rb', line 15

required :created_at, Time

#description ⇒ String?

An optional free-form description for internal use.

Returns:

  • (String, nil) 


21
 
# File 'lib/modern_treasury/models/ledger.rb', line 21

required :description, String, nil?: true

#discarded_at ⇒ Time?

Returns:

  • (Time, nil) 


26
 
# File 'lib/modern_treasury/models/ledger.rb', line 26

required :discarded_at, Time, nil?: true

#id ⇒ String

Returns:

  • (String) 


10
 
# File 'lib/modern_treasury/models/ledger.rb', line 10

required :id, String

#live_mode ⇒ Boolean

This field will be true if this object exists in the live environment or false if it exists in the test environment.

Returns:

  • (Boolean) 


33
 
# File 'lib/modern_treasury/models/ledger.rb', line 33

required :live_mode, ModernTreasury::Internal::Type::Boolean

#metadata ⇒ Hash{Symbol=>String}

Additional data represented as key-value pairs. Both the key and value must be strings.

Returns:

  • (Hash{Symbol=>String}) 


40
 
# File 'lib/modern_treasury/models/ledger.rb', line 40

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

#name ⇒ String

The name of the ledger.

Returns:

  • (String) 


46
 
# File 'lib/modern_treasury/models/ledger.rb', line 46

required :name, String

#object ⇒ String

Returns:

  • (String) 


51
 
# File 'lib/modern_treasury/models/ledger.rb', line 51

required :object, String

#updated_at ⇒ Time

Returns:

  • (Time) 


56
 
# File 'lib/modern_treasury/models/ledger.rb', line 56

required :updated_at, Time