Class: ModernTreasury::Models::InternalAccountCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ModernTreasury::Models::InternalAccountCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/modern_treasury/models/internal_account_create_params.rb

Overview

See Also:

• Resources::InternalAccounts#create

Defined Under Namespace

Modules: AccountType, Currency Classes: AccountCapability, PartyAddress

Instance Attribute Summary

• #account_capabilities ⇒ Array<ModernTreasury::Models::InternalAccountCreateParams::AccountCapability>^?

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

• #account_type ⇒ Symbol, ...

  The account type, used to provision the appropriate account at the financial institution.

• #connection_id ⇒ String

  The identifier of the financial institution the account belongs to.

• #counterparty_id ⇒ String^?

  The Counterparty associated to this account.

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

  Either “USD” or “CAD”.

• #legal_entity_id ⇒ String^?

  The LegalEntity associated to this account.

• #name ⇒ String

  The nickname of the account.

• #parent_account_id ⇒ String^?

  The parent internal account of this new account.

• #party_address ⇒ ModernTreasury::Models::InternalAccountCreateParams::PartyAddress^?

  The address associated with the owner or null.

• #party_name ⇒ String

  The legal name of the entity which owns the account.

• #vendor_attributes ⇒ Hash{Symbol=>String}^?

  A hash of vendor specific attributes that will be used when creating the account at the vendor specified by the given connection.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(connection_id: , currency: , name: , party_name: , account_capabilities: nil, account_type: nil, counterparty_id: nil, legal_entity_id: nil, parent_account_id: nil, party_address: nil, vendor_attributes: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see InternalAccountCreateParams for more details.

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(connection_id: , currency: , name: , party_name: , account_capabilities: nil, account_type: nil, counterparty_id: nil, legal_entity_id: nil, parent_account_id: nil, party_address: nil, vendor_attributes: nil, request_options: {}) ⇒ Object

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

Parameters:

• connection_id (String) (defaults to: ) —

  The identifier of the financial institution the account belongs to.

• currency (Symbol, ModernTreasury::Models::InternalAccountCreateParams::Currency) (defaults to: ) —

  Either “USD” or “CAD”. Internal accounts created at Increase only supports “USD”

• name (String) (defaults to: ) —

  The nickname of the account.

• party_name (String) (defaults to: ) —

  The legal name of the entity which owns the account.

• account_capabilities (Array<ModernTreasury::Models::InternalAccountCreateParams::AccountCapability>) (defaults to: nil) —

  An array of AccountCapability objects that list the originating abilities of the

• account_type (Symbol, ModernTreasury::Models::InternalAccountCreateParams::AccountType) (defaults to: nil) —

  The account type, used to provision the appropriate account at the financial ins

• counterparty_id (String) (defaults to: nil) —

  The Counterparty associated to this account.

• legal_entity_id (String) (defaults to: nil) —

  The LegalEntity associated to this account.

• parent_account_id (String) (defaults to: nil) —

  The parent internal account of this new account.

• party_address (ModernTreasury::Models::InternalAccountCreateParams::PartyAddress) (defaults to: nil) —

  The address associated with the owner or null.

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

  A hash of vendor specific attributes that will be used when creating the account

• request_options (ModernTreasury::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/modern_treasury/models/internal_account_create_params.rb', line 81

Instance Attribute Details

#account_capabilities ⇒ Array<ModernTreasury::Models::InternalAccountCreateParams::AccountCapability>^?

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

Returns:

• (Array<ModernTreasury::Models::InternalAccountCreateParams::AccountCapability>, nil)

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

optional :account_capabilities,
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::InternalAccountCreateParams::AccountCapability] }

#account_type ⇒ Symbol, ...

The account type, used to provision the appropriate account at the financial institution.

Returns:

• (Symbol, ModernTreasury::Models::InternalAccountCreateParams::AccountType, nil)

# File 'lib/modern_treasury/models/internal_account_create_params.rb', line 48

optional :account_type, enum: -> { ModernTreasury::InternalAccountCreateParams::AccountType }

#connection_id ⇒ String

The identifier of the financial institution the account belongs to.

Returns:

• (String)

# File 'lib/modern_treasury/models/internal_account_create_params.rb', line 14

required :connection_id, String

#counterparty_id ⇒ String^?

The Counterparty associated to this account.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/internal_account_create_params.rb', line 54

optional :counterparty_id, String

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

Either “USD” or “CAD”. Internal accounts created at Increase only supports “USD”.

Returns:

• (Symbol, ModernTreasury::Models::InternalAccountCreateParams::Currency)

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

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

#legal_entity_id ⇒ String^?

The LegalEntity associated to this account.

Returns:

• (String, nil)

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

optional :legal_entity_id, String

#name ⇒ String

The nickname of the account.

Returns:

• (String)

# File 'lib/modern_treasury/models/internal_account_create_params.rb', line 27

required :name, String

#parent_account_id ⇒ String^?

The parent internal account of this new account.

Returns:

• (String, nil)

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

optional :parent_account_id, String

#party_address ⇒ ModernTreasury::Models::InternalAccountCreateParams::PartyAddress^?

The address associated with the owner or null.

Returns:

• (ModernTreasury::Models::InternalAccountCreateParams::PartyAddress, nil)

# File 'lib/modern_treasury/models/internal_account_create_params.rb', line 72

optional :party_address, -> { ModernTreasury::InternalAccountCreateParams::PartyAddress }

#party_name ⇒ String

The legal name of the entity which owns the account.

Returns:

• (String)

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

required :party_name, String

#vendor_attributes ⇒ Hash{Symbol=>String}^?

A hash of vendor specific attributes that will be used when creating the account at the vendor specified by the given connection.

Returns:

• (Hash{Symbol=>String}, nil)

# File 'lib/modern_treasury/models/internal_account_create_params.rb', line 79

optional :vendor_attributes, ModernTreasury::Internal::Type::HashOf[String]

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/modern_treasury/models/internal_account_create_params.rb', line 117