Class: ModernTreasury::Models::InternalAccount

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

Overview

See Also:

Defined Under Namespace

Modules: AccountType, PartyType, Status Classes: AccountCapability

Instance Attribute Summary collapse

Class Method Summary collapse

Methods inherited from Internal::Type::BaseModel

#==, ==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from ModernTreasury::Internal::Type::BaseModel

Instance Attribute Details

#account_capabilities ⇒ Array<ModernTreasury::Models::InternalAccount::AccountCapability>

An array of AccountCapability objects that list the originating abilities of the internal account and any relevant information for them.

Returns:



17
18
 
# File 'lib/modern_treasury/models/internal_account.rb', line 17

required :account_capabilities,
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::InternalAccount::AccountCapability] }

#account_details ⇒ Array<ModernTreasury::Models::AccountDetail>

An array of account detail objects.

Returns:



24
 
# File 'lib/modern_treasury/models/internal_account.rb', line 24

required :account_details, -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::AccountDetail] }

#account_type ⇒ Symbol, ...

Can be checking, savings or other.

Returns:



30
 
# File 'lib/modern_treasury/models/internal_account.rb', line 30

required :account_type, enum: -> { ModernTreasury::InternalAccount::AccountType }, nil?: true

#connection ⇒ ModernTreasury::Models::Connection

Specifies which financial institution the accounts belong to.

Returns:



36
 
# File 'lib/modern_treasury/models/internal_account.rb', line 36

required :connection, -> { ModernTreasury::Connection }

#counterparty_id ⇒ String?

The Counterparty associated to this account.

Returns:

  • (String, nil) 


42
 
# File 'lib/modern_treasury/models/internal_account.rb', line 42

required :counterparty_id, String, nil?: true

#created_at ⇒ Time

Returns:

  • (Time) 


47
 
# File 'lib/modern_treasury/models/internal_account.rb', line 47

required :created_at, Time

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

The currency of the account.

Returns:



53
 
# File 'lib/modern_treasury/models/internal_account.rb', line 53

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

#id ⇒ String

Returns:

  • (String) 


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

required :id, String

#ledger_account_id ⇒ String?

If the internal account links to a ledger account in Modern Treasury, the id of the ledger account will be populated here.

Returns:

  • (String, nil) 


60
 
# File 'lib/modern_treasury/models/internal_account.rb', line 60

required :ledger_account_id, String, nil?: true

#legal_entity_id ⇒ String?

The Legal Entity associated to this account.

Returns:

  • (String, nil) 


66
 
# File 'lib/modern_treasury/models/internal_account.rb', line 66

required :legal_entity_id, String, nil?: true

#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) 


73
 
# File 'lib/modern_treasury/models/internal_account.rb', line 73

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}) 


80
 
# File 'lib/modern_treasury/models/internal_account.rb', line 80

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

#name ⇒ String?

A nickname for the account.

Returns:

  • (String, nil) 


86
 
# File 'lib/modern_treasury/models/internal_account.rb', line 86

required :name, String, nil?: true

#object ⇒ String

Returns:

  • (String) 


91
 
# File 'lib/modern_treasury/models/internal_account.rb', line 91

required :object, String

#parent_account_id ⇒ String?

The parent InternalAccount of this account.

Returns:

  • (String, nil) 


97
 
# File 'lib/modern_treasury/models/internal_account.rb', line 97

required :parent_account_id, String, nil?: true

#party_address ⇒ ModernTreasury::Models::Address?

The address associated with the owner or null.

Returns:



103
 
# File 'lib/modern_treasury/models/internal_account.rb', line 103

required :party_address, -> { ModernTreasury::Address }, nil?: true

#party_name ⇒ String

The legal name of the entity which owns the account.

Returns:

  • (String) 


109
 
# File 'lib/modern_treasury/models/internal_account.rb', line 109

required :party_name, String

#party_type ⇒ Symbol, ...

Either individual or business.

Returns:



115
 
# File 'lib/modern_treasury/models/internal_account.rb', line 115

required :party_type, enum: -> { ModernTreasury::InternalAccount::PartyType }, nil?: true

#routing_details ⇒ Array<ModernTreasury::Models::RoutingDetail>

An array of routing detail objects.

Returns:



121
 
# File 'lib/modern_treasury/models/internal_account.rb', line 121

required :routing_details, -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::RoutingDetail] }

#status ⇒ Symbol, ...

The internal account status.

Returns:



127
 
# File 'lib/modern_treasury/models/internal_account.rb', line 127

required :status, enum: -> { ModernTreasury::InternalAccount::Status }, nil?: true

#updated_at ⇒ Time

Returns:

  • (Time) 


132
 
# File 'lib/modern_treasury/models/internal_account.rb', line 132

required :updated_at, Time

#vendor_id ⇒ String?

The vendor ID associated with this account.

Returns:

  • (String, nil) 


138
 
# File 'lib/modern_treasury/models/internal_account.rb', line 138

required :vendor_id, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/modern_treasury/models/internal_account.rb', line 307