Class: ModernTreasury::Models::LegalEntity::Address

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

Defined Under Namespace

Modules: AddressType

Instance Attribute Summary collapse

Instance Method Summary collapse

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: , addresses: , bank_settings: , business_name: , citizenship_country: , compliance_details: , created_at: , date_formed: , date_of_birth: , discarded_at: , doing_business_as_names: , email: , first_name: , identifications: , industry_classifications: , last_name: , legal_entity_associations: , legal_entity_type: , legal_structure: , live_mode: , metadata: , middle_name: , object: , phone_numbers: , politically_exposed_person: , preferred_name: , prefix: , risk_rating: , suffix: , updated_at: , wealth_and_employment_details: , website: ) ⇒ Object

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

Parameters:

  • id (String) (defaults to: )
  • addresses (Array<ModernTreasury::Models::LegalEntity::Address>) (defaults to: ) —

    A list of addresses for the entity.

  • bank_settings (ModernTreasury::Models::LegalEntityBankSettings, nil) (defaults to: )
  • business_name (String, nil) (defaults to: ) —

    The business’s legal business name.

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

    The country of citizenship for an individual.

  • compliance_details (ModernTreasury::Models::LegalEntityComplianceDetail, nil) (defaults to: )
  • created_at (Time) (defaults to: )
  • date_formed (Date, nil) (defaults to: ) —

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

  • date_of_birth (Date, nil) (defaults to: ) —

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

  • discarded_at (Time, nil) (defaults to: )
  • doing_business_as_names (Array<String>) (defaults to: )
  • email (String, nil) (defaults to: ) —

    The entity’s primary email.

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

    An individual’s first name.

  • identifications (Array<ModernTreasury::Models::LegalEntity::Identification>) (defaults to: ) —

    A list of identifications for the legal entity.

  • industry_classifications (Array<ModernTreasury::Models::LegalEntityIndustryClassification>) (defaults to: ) —

    A list of industry classifications for the legal entity.

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

    An individual’s last name.

  • legal_entity_associations (Array<ModernTreasury::Models::LegalEntityAssociation>, nil) (defaults to: ) —

    The legal entity associations and its child legal entities.

  • legal_entity_type (Symbol, ModernTreasury::Models::LegalEntity::LegalEntityType) (defaults to: ) —

    The type of legal entity.

  • legal_structure (Symbol, ModernTreasury::Models::LegalEntity::LegalStructure, nil) (defaults to: ) —

    The business’s legal structure.

  • live_mode (Boolean) (defaults to: ) —

    This field will be true if this object exists in the live environment or false i

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

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

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

    An individual’s middle name.

  • object (String) (defaults to: )
  • phone_numbers (Array<ModernTreasury::Models::LegalEntity::PhoneNumber>) (defaults to: )
  • politically_exposed_person (Boolean, nil) (defaults to: ) —

    Whether the individual is a politically exposed person.

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

    An individual’s preferred name.

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

    An individual’s prefix.

  • risk_rating (Symbol, ModernTreasury::Models::LegalEntity::RiskRating, nil) (defaults to: ) —

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

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

    An individual’s suffix.

  • updated_at (Time) (defaults to: )
  • wealth_and_employment_details (ModernTreasury::Models::LegalEntityWealthEmploymentDetail, nil) (defaults to: )
  • website (String, nil) (defaults to: ) —

    The entity’s primary website URL.



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/modern_treasury/models/legal_entity.rb', line 266

class Address < ModernTreasury::Internal::Type::BaseModel
  # @!attribute id
  #
  #   @return [String]
  required :id, String

  # @!attribute address_types
  #   The types of this address.
  #
  #   @return [Array<Symbol, ModernTreasury::Models::LegalEntity::Address::AddressType>]
  required :address_types,
           -> { ModernTreasury::Internal::Type::ArrayOf[enum: ModernTreasury::LegalEntity::Address::AddressType] }

  # @!attribute country
  #   Country code conforms to [ISO 3166-1 alpha-2]
  #
  #   @return [String, nil]
  required :country, String, nil?: true

  # @!attribute created_at
  #
  #   @return [Time]
  required :created_at, Time

  # @!attribute discarded_at
  #
  #   @return [Time, nil]
  required :discarded_at, Time, nil?: true

  # @!attribute line1
  #
  #   @return [String, nil]
  required :line1, String, nil?: true

  # @!attribute line2
  #
  #   @return [String, nil]
  required :line2, String, nil?: true

  # @!attribute live_mode
  #   This field will be true if this object exists in the live environment or false
  #   if it exists in the test environment.
  #
  #   @return [Boolean]
  required :live_mode, ModernTreasury::Internal::Type::Boolean

  # @!attribute locality
  #   Locality or City.
  #
  #   @return [String, nil]
  required :locality, String, nil?: true

  # @!attribute object
  #
  #   @return [String]
  required :object, String

  # @!attribute postal_code
  #   The postal code of the address.
  #
  #   @return [String, nil]
  required :postal_code, String, nil?: true

  # @!attribute region
  #   Region or State.
  #
  #   @return [String, nil]
  required :region, String, nil?: true

  # @!attribute updated_at
  #
  #   @return [Time]
  required :updated_at, Time

  # @!method initialize(id:, address_types:, country:, created_at:, discarded_at:, line1:, line2:, live_mode:, locality:, object:, postal_code:, region:, updated_at:)
  #   Some parameter documentations has been truncated, see
  #   {ModernTreasury::Models::LegalEntity::Address} for more details.
  #
  #   @param id [String]
  #
  #   @param address_types [Array<Symbol, ModernTreasury::Models::LegalEntity::Address::AddressType>] The types of this address.
  #
  #   @param country [String, nil] Country code conforms to [ISO 3166-1 alpha-2]
  #
  #   @param created_at [Time]
  #
  #   @param discarded_at [Time, nil]
  #
  #   @param line1 [String, nil]
  #
  #   @param line2 [String, nil]
  #
  #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
  #
  #   @param locality [String, nil] Locality or City.
  #
  #   @param object [String]
  #
  #   @param postal_code [String, nil] The postal code of the address.
  #
  #   @param region [String, nil] Region or State.
  #
  #   @param updated_at [Time]

  module AddressType
    extend ModernTreasury::Internal::Type::Enum

    BUSINESS = :business
    MAILING = :mailing
    OTHER = :other
    PO_BOX = :po_box
    RESIDENTIAL = :residential

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#address_types ⇒ Array<Symbol, ModernTreasury::Models::LegalEntity::Address::AddressType>

The types of this address.

Returns:



276
277
 
# File 'lib/modern_treasury/models/legal_entity.rb', line 276

required :address_types,
-> { ModernTreasury::Internal::Type::ArrayOf[enum: ModernTreasury::LegalEntity::Address::AddressType] }

#country ⇒ String?

Country code conforms to [ISO 3166-1 alpha-2]

Returns:

  • (String, nil) 


283
 
# File 'lib/modern_treasury/models/legal_entity.rb', line 283

required :country, String, nil?: true

#created_at ⇒ Time

Returns:

  • (Time) 


288
 
# File 'lib/modern_treasury/models/legal_entity.rb', line 288

required :created_at, Time

#discarded_at ⇒ Time?

Returns:

  • (Time, nil) 


293
 
# File 'lib/modern_treasury/models/legal_entity.rb', line 293

required :discarded_at, Time, nil?: true

#id ⇒ String

Returns:

  • (String) 


270
 
# File 'lib/modern_treasury/models/legal_entity.rb', line 270

required :id, String

#line1 ⇒ String?

Returns:

  • (String, nil) 


298
 
# File 'lib/modern_treasury/models/legal_entity.rb', line 298

required :line1, String, nil?: true

#line2 ⇒ String?

Returns:

  • (String, nil) 


303
 
# File 'lib/modern_treasury/models/legal_entity.rb', line 303

required :line2, 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) 


310
 
# File 'lib/modern_treasury/models/legal_entity.rb', line 310

required :live_mode, ModernTreasury::Internal::Type::Boolean

#locality ⇒ String?

Locality or City.

Returns:

  • (String, nil) 


316
 
# File 'lib/modern_treasury/models/legal_entity.rb', line 316

required :locality, String, nil?: true

#object ⇒ String

Returns:

  • (String) 


321
 
# File 'lib/modern_treasury/models/legal_entity.rb', line 321

required :object, String

#postal_code ⇒ String?

The postal code of the address.

Returns:

  • (String, nil) 


327
 
# File 'lib/modern_treasury/models/legal_entity.rb', line 327

required :postal_code, String, nil?: true

#region ⇒ String?

Region or State.

Returns:

  • (String, nil) 


333
 
# File 'lib/modern_treasury/models/legal_entity.rb', line 333

required :region, String, nil?: true

#updated_at ⇒ Time

Returns:

  • (Time) 


338
 
# File 'lib/modern_treasury/models/legal_entity.rb', line 338

required :updated_at, Time