Class: ModernTreasury::Models::InternalAccountUpdateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/modern_treasury/models/internal_account_update_params.rb,
sig/modern_treasury/models/internal_account_update_params.rbs

Overview

See Also:

• ModernTreasury::Resources::InternalAccounts#update

Defined Under Namespace

Modules: Status

Constant Summary

ModernTreasury =

Returns:

• (:AddressRequest)

Instance Attribute Summary

• #contra_ledger_account_id ⇒ String^?

  The Contra Ledger Account associated to this account.

• #counterparty_id ⇒ String^?

  The Counterparty associated to this account.

• #external_id ⇒ String^?

  An optional user-defined 180 character unique identifier.

• #id ⇒ String
• #ledger_account_id ⇒ String^?

  The Ledger Account associated to this account.

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

  Additional data in the form of key-value pairs.

• #name ⇒ String^?

  The nickname for the internal account.

• #parent_account_id ⇒ String^?

  The parent internal account for this account.

• #party_address ⇒ ModernTreasury::Models::AddressRequest^?

  The address associated with the owner of the internal account.

• #status ⇒ Symbol, ...

  Requests closure of the internal account.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(id:, contra_ledger_account_id: nil, counterparty_id: nil, external_id: nil, ledger_account_id: nil, metadata: nil, name: nil, parent_account_id: nil, party_address: nil, status: nil, request_options: {}) ⇒ Object constructor

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

• #to_hash ⇒ {

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(id:, contra_ledger_account_id: nil, counterparty_id: nil, external_id: nil, ledger_account_id: nil, metadata: nil, name: nil, parent_account_id: nil, party_address: nil, status: nil, request_options: {}) ⇒ Object

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

Parameters:

• id (String)
• contra_ledger_account_id (String) (defaults to: nil) —

  The Contra Ledger Account associated to this account.

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

  The Counterparty associated to this account.

• external_id (String, nil) (defaults to: nil) —

  An optional user-defined 180 character unique identifier.

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

  The Ledger Account associated to this account.

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

  Additional data in the form of key-value pairs. Pairs can be removed by passing

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

  The nickname for the internal account.

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

  The parent internal account for this account.

• party_address (ModernTreasury::Models::AddressRequest) (defaults to: nil) —

  The address associated with the owner of the internal account. Updating this val

• status (Symbol, ModernTreasury::Models::InternalAccountUpdateParams::Status) (defaults to: nil) —

  Requests closure of the internal account. The resulting status may be closed f

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

# File 'lib/modern_treasury/models/internal_account_update_params.rb', line 74

Instance Attribute Details

#contra_ledger_account_id ⇒ String^?

The Contra Ledger Account associated to this account.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/internal_account_update_params.rb', line 19

optional :contra_ledger_account_id, String

#counterparty_id ⇒ String^?

The Counterparty associated to this account.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/internal_account_update_params.rb', line 25

optional :counterparty_id, String

#external_id ⇒ String^?

An optional user-defined 180 character unique identifier.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/internal_account_update_params.rb', line 31

optional :external_id, String, nil?: true

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/modern_treasury/models/internal_account_update_params.rb', line 13

required :id, String

#ledger_account_id ⇒ String^?

The Ledger Account associated to this account.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/internal_account_update_params.rb', line 37

optional :ledger_account_id, String

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

Additional data in the form of key-value pairs. Pairs can be removed by passing an empty string or null as the value.

Parameters:

• (::Hash[Symbol, String])

Returns:

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

# File 'lib/modern_treasury/models/internal_account_update_params.rb', line 44

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

#name ⇒ String^?

The nickname for the internal account.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/internal_account_update_params.rb', line 50

optional :name, String

#parent_account_id ⇒ String^?

The parent internal account for this account.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :parent_account_id, String

#party_address ⇒ ModernTreasury::Models::AddressRequest^?

The address associated with the owner of the internal account. Updating this value does not guarantee that the new address matches the address on record with the account's bank; you are responsible for verifying that the address is accurate.

Returns:

• (ModernTreasury::Models::AddressRequest, nil)

# File 'lib/modern_treasury/models/internal_account_update_params.rb', line 65

optional :party_address, -> { ModernTreasury::AddressRequest }

#status ⇒ Symbol, ...

Requests closure of the internal account. The resulting status may be closed for vendors that close synchronously.

Returns:

• (Symbol, ModernTreasury::Models::InternalAccountUpdateParams::Status, nil)

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

optional :status, enum: -> { ModernTreasury::InternalAccountUpdateParams::Status }

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/modern_treasury/models/internal_account_update_params.rbs', line 76

def to_hash: -> {