Class: ModernTreasury::Models::Counterparty

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

Overview

See Also:

Defined Under Namespace

Classes: Account

Instance Attribute Summary collapse

Method Summary

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

#accounts ⇒ Array<ModernTreasury::Models::Counterparty::Account>

The accounts for this counterparty.

Returns:



16
 
# File 'lib/modern_treasury/models/counterparty.rb', line 16

required :accounts, -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Counterparty::] }

#created_at ⇒ Time

Returns:

  • (Time) 


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

required :created_at, Time

#discarded_at ⇒ Time?

Returns:

  • (Time, nil) 


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

required :discarded_at, Time, nil?: true

#email ⇒ String?

The counterparty’s email.

Returns:

  • (String, nil) 


32
 
# File 'lib/modern_treasury/models/counterparty.rb', line 32

required :email, String, nil?: true

#external_id ⇒ String?

An optional user-defined 180 character unique identifier.

Returns:

  • (String, nil) 


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

required :external_id, String, nil?: true

#id ⇒ String

Returns:

  • (String) 


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

required :id, String

#legal_entity_id ⇒ String?

The id of the legal entity.

Returns:

  • (String, nil) 


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

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) 


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

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


58
 
# File 'lib/modern_treasury/models/counterparty.rb', line 58

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

#name ⇒ String?

A human friendly name for this counterparty.

Returns:

  • (String, nil) 


64
 
# File 'lib/modern_treasury/models/counterparty.rb', line 64

required :name, String, nil?: true

#object ⇒ String

Returns:

  • (String) 


69
 
# File 'lib/modern_treasury/models/counterparty.rb', line 69

required :object, String

#send_remittance_advice ⇒ Boolean

Send an email to the counterparty whenever an associated payment order is sent to the bank.

Returns:

  • (Boolean) 


76
 
# File 'lib/modern_treasury/models/counterparty.rb', line 76

required :send_remittance_advice, ModernTreasury::Internal::Type::Boolean

#updated_at ⇒ Time

Returns:

  • (Time) 


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

required :updated_at, Time

#verification_status ⇒ String

Deprecated.

The verification status of the counterparty.

Returns:

  • (String) 


89
 
# File 'lib/modern_treasury/models/counterparty.rb', line 89

required :verification_status, String