Class: ModernTreasury::Models::LegalEntityCreateParams

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

Overview

See Also:

Defined Under Namespace

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

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

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(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/legal_entity_create_params.rb', line 174

Instance Attribute Details

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

A list of addresses for the entity.

Returns:



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

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

#bank_settings ⇒ ModernTreasury::Models::LegalEntityBankSettings?

Returns:



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

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

#business_name ⇒ String?

The business’s legal business name.

Returns:

  • (String, nil) 


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

optional :business_name, String, nil?: true

#citizenship_country ⇒ String?

The country of citizenship for an individual.

Returns:

  • (String, nil) 


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

optional :citizenship_country, String, nil?: true

#compliance_details ⇒ ModernTreasury::Models::LegalEntityComplianceDetail?

Returns:



43
 
# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 43

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

#date_formed ⇒ Date?

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

Returns:

  • (Date, nil) 


49
 
# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 49

optional :date_formed, Date, nil?: true

#date_of_birth ⇒ Date?

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

Returns:

  • (Date, nil) 


55
 
# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 55

optional :date_of_birth, Date, nil?: true

#doing_business_as_names ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


60
 
# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 60

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

#email ⇒ String?

The entity’s primary email.

Returns:

  • (String, nil) 


66
 
# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 66

optional :email, String, nil?: true

#first_name ⇒ String?

An individual’s first name.

Returns:

  • (String, nil) 


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

optional :first_name, String, nil?: true

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

A list of identifications for the legal entity.

Returns:



78
79
 
# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 78

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

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

A list of industry classifications for the legal entity.

Returns:



85
86
 
# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 85

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

#last_name ⇒ String?

An individual’s last name.

Returns:

  • (String, nil) 


92
 
# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 92

optional :last_name, String, nil?: true

#legal_entity_associations ⇒ Array<ModernTreasury::Models::LegalEntityCreateParams::LegalEntityAssociation>?

The legal entity associations and its child legal entities.

Returns:



98
99
100
101
102
 
# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 98

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

#legal_entity_type ⇒ Symbol, ModernTreasury::Models::LegalEntityCreateParams::LegalEntityType

The type of legal entity.

Returns:



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

required :legal_entity_type, enum: -> { ModernTreasury::LegalEntityCreateParams::LegalEntityType }

#legal_structure ⇒ Symbol, ...

The business’s legal structure.

Returns:



108
109
110
 
# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 108

optional :legal_structure,
enum: -> { ModernTreasury::LegalEntityCreateParams::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) 


117
 
# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 117

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

#middle_name ⇒ String?

An individual’s middle name.

Returns:

  • (String, nil) 


123
 
# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 123

optional :middle_name, String, nil?: true

#phone_numbers ⇒ Array<ModernTreasury::Models::LegalEntityCreateParams::PhoneNumber>?

Returns:



128
129
 
# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 128

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

#politically_exposed_person ⇒ Boolean?

Whether the individual is a politically exposed person.

Returns:

  • (Boolean, nil) 


135
 
# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 135

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

#preferred_name ⇒ String?

An individual’s preferred name.

Returns:

  • (String, nil) 


141
 
# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 141

optional :preferred_name, String, nil?: true

#prefix ⇒ String?

An individual’s prefix.

Returns:

  • (String, nil) 


147
 
# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 147

optional :prefix, String, nil?: true

#risk_rating ⇒ Symbol, ...

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

Returns:



153
 
# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 153

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

#suffix ⇒ String?

An individual’s suffix.

Returns:

  • (String, nil) 


159
 
# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 159

optional :suffix, String, nil?: true

#wealth_and_employment_details ⇒ ModernTreasury::Models::LegalEntityWealthEmploymentDetail?

Returns:



164
165
166
 
# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 164

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

#website ⇒ String?

The entity’s primary website URL.

Returns:

  • (String, nil) 


172
 
# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 172

optional :website, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/modern_treasury/models/legal_entity_create_params.rb', line 239