Class: ModernTreasury::Models::ExternalAccountUpdateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/modern_treasury/models/external_account_update_params.rb

Overview

See Also:

• Resources::ExternalAccounts#update

Defined Under Namespace

Modules: PartyType

Instance Attribute Summary

• #account_type ⇒ Symbol, ...

  Can be ‘checking`, `savings` or `other`.

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

  Additional data in the form of key-value pairs.

• #name ⇒ String^?

  A nickname for the external account.

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

  If this value isn’t provided, it will be inherited from the counterparty’s name.

• #party_type ⇒ Symbol, ...

  Either ‘individual` or `business`.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(account_type: nil, counterparty_id: nil, metadata: nil, name: nil, party_address: nil, party_name: nil, party_type: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see ExternalAccountUpdateParams 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(account_type: nil, counterparty_id: nil, metadata: nil, name: nil, party_address: nil, party_name: nil, party_type: nil, request_options: {}) ⇒ Object

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

Parameters:

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

  Can be ‘checking`, `savings` or `other`.

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

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

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

  A nickname for the external account. This is only for internal usage and won’t a

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

  If this value isn’t provided, it will be inherited from the counterparty’s name.

• party_type (Symbol, ModernTreasury::Models::ExternalAccountUpdateParams::PartyType, nil) (defaults to: nil) —

  Either ‘individual` or `business`.

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

# File 'lib/modern_treasury/models/external_account_update_params.rb', line 52

Instance Attribute Details

#account_type ⇒ Symbol, ...

Can be ‘checking`, `savings` or `other`.

Returns:

• (Symbol, ModernTreasury::Models::ExternalAccountType, nil)

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

optional :account_type, enum: -> { ModernTreasury::ExternalAccountType }

#counterparty_id ⇒ String^?

Returns:

• (String, nil)

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

optional :counterparty_id, String, nil?: true

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

Returns:

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

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

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

#name ⇒ String^?

A nickname for the external account. This is only for internal usage and won’t affect any payments

Returns:

• (String, nil)

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

optional :name, String, nil?: true

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

Returns:

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

# File 'lib/modern_treasury/models/external_account_update_params.rb', line 38

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

#party_name ⇒ String^?

If this value isn’t provided, it will be inherited from the counterparty’s name.

Returns:

• (String, nil)

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

optional :party_name, String

#party_type ⇒ Symbol, ...

Either ‘individual` or `business`.

Returns:

• (Symbol, ModernTreasury::Models::ExternalAccountUpdateParams::PartyType, nil)

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

optional :party_type, enum: -> { ModernTreasury::ExternalAccountUpdateParams::PartyType }, nil?: true