Class: ModernTreasury::Models::CounterpartyUpdateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/modern_treasury/models/counterparty_update_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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:, email: nil, external_id: nil, legal_entity_id: nil, metadata: nil, name: nil, send_remittance_advice: nil, taxpayer_identifier: nil, request_options: {}) ⇒ Object

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

Parameters:

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

    A new email for the counterparty.

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

    An optional user-defined 180 character unique identifier.

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

    The id of the legal entity.

  • 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) —

    A new name for the counterparty. Will only update if passed.

  • send_remittance_advice (Boolean) (defaults to: nil) —

    If this is ‘true`, Modern Treasury will send an email to the counterparty whenev

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

    Either a valid SSN or EIN.

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



# File 'lib/modern_treasury/models/counterparty_update_params.rb', line 59

Instance Attribute Details

#email ⇒ String?

A new email for the counterparty.

Returns:

  • (String, nil) 


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

optional :email, String

#external_id ⇒ String?

An optional user-defined 180 character unique identifier.

Returns:

  • (String, nil) 


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

optional :external_id, String, nil?: true

#id ⇒ String

Returns:

  • (String) 


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

required :id, String

#legal_entity_id ⇒ String?

The id of the legal entity.

Returns:

  • (String, nil) 


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

optional :legal_entity_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) 


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

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

#name ⇒ String?

A new name for the counterparty. Will only update if passed.

Returns:

  • (String, nil) 


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

optional :name, String

#send_remittance_advice ⇒ Boolean?

If this is ‘true`, Modern Treasury will send an email to the counterparty whenever an associated payment order is sent to the bank.

Returns:

  • (Boolean, nil) 


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

optional :send_remittance_advice, ModernTreasury::Internal::Type::Boolean

#taxpayer_identifier ⇒ String?

Either a valid SSN or EIN.

Returns:

  • (String, nil) 


57
 
# File 'lib/modern_treasury/models/counterparty_update_params.rb', line 57

optional :taxpayer_identifier, String