Class: ModernTreasury::Models::CounterpartyCreateParams::LegalEntity

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ModernTreasury::Models::CounterpartyCreateParams::LegalEntity

Defined in:

lib/modern_treasury/models/counterparty_create_params.rb

Defined Under Namespace

Modules: LegalEntityType, LegalStructure, RiskRating Classes: LegalEntityAssociation, PhoneNumber

Instance Attribute Summary

• #addresses ⇒ Array<ModernTreasury::Models::LegalEntityAddressCreateRequest>^?

  A list of addresses for the entity.

• #bank_settings ⇒ ModernTreasury::Models::LegalEntityBankSettings^?
• #business_name ⇒ String^?

  The business’s legal business name.

• #citizenship_country ⇒ String^?

  The country of citizenship for an individual.

• #compliance_details ⇒ ModernTreasury::Models::LegalEntityComplianceDetail^?
• #date_formed ⇒ Date^?

  A business’s formation date (YYYY-MM-DD).

• #date_of_birth ⇒ Date^?

  An individual’s date of birth (YYYY-MM-DD).

• #doing_business_as_names ⇒ Array<String>^?
• #email ⇒ String^?

  The entity’s primary email.

• #first_name ⇒ String^?

  An individual’s first name.

• #identifications ⇒ Array<ModernTreasury::Models::IdentificationCreateRequest>^?

  A list of identifications for the legal entity.

• #industry_classifications ⇒ Array<ModernTreasury::Models::LegalEntityIndustryClassification>^?

  A list of industry classifications for the legal entity.

• #last_name ⇒ String^?

  An individual’s last name.

• #legal_entity_associations ⇒ Array<ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation>^?

  The legal entity associations and its child legal entities.

• #legal_entity_type ⇒ Symbol, ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityType

  The type of legal entity.

• #legal_structure ⇒ Symbol, ...

  The business’s legal structure.

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

  Additional data represented as key-value pairs.

• #middle_name ⇒ String^?

  An individual’s middle name.

• #phone_numbers ⇒ Array<ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::PhoneNumber>^?
• #politically_exposed_person ⇒ Boolean^?

  Whether the individual is a politically exposed person.

• #preferred_name ⇒ String^?

  An individual’s preferred name.

• #prefix ⇒ String^?

  An individual’s prefix.

• #risk_rating ⇒ Symbol, ...

  The risk rating of the legal entity.

• #suffix ⇒ String^?

  An individual’s suffix.

• #wealth_and_employment_details ⇒ ModernTreasury::Models::LegalEntityWealthEmploymentDetail^?
• #website ⇒ String^?

  The entity’s primary website URL.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(phone_number: nil) ⇒ Object constructor

  A list of phone numbers in E.164 format.

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(phone_number: nil) ⇒ Object

A list of phone numbers in E.164 format.

Parameters:

• phone_number (String) (defaults to: nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 601

Instance Attribute Details

#addresses ⇒ Array<ModernTreasury::Models::LegalEntityAddressCreateRequest>^?

A list of addresses for the entity.

Returns:

• (Array<ModernTreasury::Models::LegalEntityAddressCreateRequest>, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 445

optional :addresses,
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntityAddressCreateRequest] }

#bank_settings ⇒ ModernTreasury::Models::LegalEntityBankSettings^?

Returns:

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

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 451

optional :bank_settings, -> { ModernTreasury::LegalEntityBankSettings }, nil?: true

#business_name ⇒ String^?

The business’s legal business name.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 457

optional :business_name, String, nil?: true

#citizenship_country ⇒ String^?

The country of citizenship for an individual.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 463

optional :citizenship_country, String, nil?: true

#compliance_details ⇒ ModernTreasury::Models::LegalEntityComplianceDetail^?

Returns:

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

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 468

optional :compliance_details, -> { ModernTreasury::LegalEntityComplianceDetail }, nil?: true

#date_formed ⇒ Date^?

A business’s formation date (YYYY-MM-DD).

Returns:

• (Date, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 474

optional :date_formed, Date, nil?: true

#date_of_birth ⇒ Date^?

An individual’s date of birth (YYYY-MM-DD).

Returns:

• (Date, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 480

optional :date_of_birth, Date, nil?: true

#doing_business_as_names ⇒ Array<String>^?

Returns:

• (Array<String>, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 485

optional :doing_business_as_names, ModernTreasury::Internal::Type::ArrayOf[String]

#email ⇒ String^?

The entity’s primary email.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 491

optional :email, String, nil?: true

#first_name ⇒ String^?

An individual’s first name.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 497

optional :first_name, String, nil?: true

#identifications ⇒ Array<ModernTreasury::Models::IdentificationCreateRequest>^?

A list of identifications for the legal entity.

Returns:

• (Array<ModernTreasury::Models::IdentificationCreateRequest>, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 503

optional :identifications,
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::IdentificationCreateRequest] }

#industry_classifications ⇒ Array<ModernTreasury::Models::LegalEntityIndustryClassification>^?

A list of industry classifications for the legal entity.

Returns:

• (Array<ModernTreasury::Models::LegalEntityIndustryClassification>, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 510

optional :industry_classifications,
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntityIndustryClassification] }

#last_name ⇒ String^?

An individual’s last name.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 517

optional :last_name, String, nil?: true

#legal_entity_associations ⇒ Array<ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation>^?

The legal entity associations and its child legal entities.

Returns:

• (Array<ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation>, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 523

optional :legal_entity_associations,
-> {
  ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::CounterpartyCreateParams::LegalEntity::LegalEntityAssociation]
},
nil?: true

#legal_entity_type ⇒ Symbol, ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityType

The type of legal entity.

Returns:

• (Symbol, ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalEntityType)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 438

required :legal_entity_type,
enum: -> { ModernTreasury::CounterpartyCreateParams::LegalEntity::LegalEntityType }

#legal_structure ⇒ Symbol, ...

The business’s legal structure.

Returns:

• (Symbol, ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::LegalStructure, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 533

optional :legal_structure,
enum: -> { ModernTreasury::CounterpartyCreateParams::LegalEntity::LegalStructure },
nil?: true

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

Additional data represented as key-value pairs. Both the key and value must be strings.

Returns:

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

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 542

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

#middle_name ⇒ String^?

An individual’s middle name.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 548

optional :middle_name, String, nil?: true

#phone_numbers ⇒ Array<ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::PhoneNumber>^?

Returns:

• (Array<ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::PhoneNumber>, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 553

optional :phone_numbers,
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::CounterpartyCreateParams::LegalEntity::PhoneNumber] }

#politically_exposed_person ⇒ Boolean^?

Whether the individual is a politically exposed person.

Returns:

• (Boolean, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 560

optional :politically_exposed_person, ModernTreasury::Internal::Type::Boolean, nil?: true

#preferred_name ⇒ String^?

An individual’s preferred name.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 566

optional :preferred_name, String, nil?: true

#prefix ⇒ String^?

An individual’s prefix.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 572

optional :prefix, String, nil?: true

#risk_rating ⇒ Symbol, ...

The risk rating of the legal entity. One of low, medium, high.

Returns:

• (Symbol, ModernTreasury::Models::CounterpartyCreateParams::LegalEntity::RiskRating, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 578

optional :risk_rating,
enum: -> { ModernTreasury::CounterpartyCreateParams::LegalEntity::RiskRating },
nil?: true

#suffix ⇒ String^?

An individual’s suffix.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 586

optional :suffix, String, nil?: true

#wealth_and_employment_details ⇒ ModernTreasury::Models::LegalEntityWealthEmploymentDetail^?

Returns:

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

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 591

optional :wealth_and_employment_details,
-> { ModernTreasury::LegalEntityWealthEmploymentDetail },
nil?: true

#website ⇒ String^?

The entity’s primary website URL.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 599

optional :website, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/modern_treasury/models/counterparty_create_params.rb', line 667