Class: ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::Address

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/modern_treasury/models/legal_entity_association.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_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::LegalEntityAssociation::ChildLegalEntity for more details.

The child legal entity.

Parameters:



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
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/modern_treasury/models/legal_entity_association.rb', line 356

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::LegalEntityAssociation::ChildLegalEntity::Address::AddressType>]
  required :address_types,
           -> { ModernTreasury::Internal::Type::ArrayOf[enum: ModernTreasury::LegalEntityAssociation::ChildLegalEntity::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::LegalEntityAssociation::ChildLegalEntity::Address} for
  #   more details.
  #
  #   @param id [String]
  #
  #   @param address_types [Array<Symbol, ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::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::LegalEntityAssociation::ChildLegalEntity::Address::AddressType>

The types of this address.

Returns:



366
367
 
# File 'lib/modern_treasury/models/legal_entity_association.rb', line 366

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

#country ⇒ String?

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

Returns:

  • (String, nil) 


373
 
# File 'lib/modern_treasury/models/legal_entity_association.rb', line 373

required :country, String, nil?: true

#created_at ⇒ Time

Returns:

  • (Time) 


378
 
# File 'lib/modern_treasury/models/legal_entity_association.rb', line 378

required :created_at, Time

#discarded_at ⇒ Time?

Returns:

  • (Time, nil) 


383
 
# File 'lib/modern_treasury/models/legal_entity_association.rb', line 383

required :discarded_at, Time, nil?: true

#id ⇒ String

Returns:

  • (String) 


360
 
# File 'lib/modern_treasury/models/legal_entity_association.rb', line 360

required :id, String

#line1 ⇒ String?

Returns:

  • (String, nil) 


388
 
# File 'lib/modern_treasury/models/legal_entity_association.rb', line 388

required :line1, String, nil?: true

#line2 ⇒ String?

Returns:

  • (String, nil) 


393
 
# File 'lib/modern_treasury/models/legal_entity_association.rb', line 393

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) 


400
 
# File 'lib/modern_treasury/models/legal_entity_association.rb', line 400

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

#locality ⇒ String?

Locality or City.

Returns:

  • (String, nil) 


406
 
# File 'lib/modern_treasury/models/legal_entity_association.rb', line 406

required :locality, String, nil?: true

#object ⇒ String

Returns:

  • (String) 


411
 
# File 'lib/modern_treasury/models/legal_entity_association.rb', line 411

required :object, String

#postal_code ⇒ String?

The postal code of the address.

Returns:

  • (String, nil) 


417
 
# File 'lib/modern_treasury/models/legal_entity_association.rb', line 417

required :postal_code, String, nil?: true

#region ⇒ String?

Region or State.

Returns:

  • (String, nil) 


423
 
# File 'lib/modern_treasury/models/legal_entity_association.rb', line 423

required :region, String, nil?: true

#updated_at ⇒ Time

Returns:

  • (Time) 


428
 
# File 'lib/modern_treasury/models/legal_entity_association.rb', line 428

required :updated_at, Time