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

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ModernTreasury::Models::ChildLegalEntity::Address

Defined in:

lib/modern_treasury/models/child_legal_entity.rb,
sig/modern_treasury/models/child_legal_entity.rbs

Defined Under Namespace

Modules: AddressType

Instance Attribute Summary

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

  The types of this address.

• #country ⇒ String^?

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

• #created_at ⇒ Time
• #discarded_at ⇒ Time^?
• #id ⇒ String
• #line1 ⇒ String^?
• #line2 ⇒ String^?
• #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.

• #locality ⇒ String^?

  Locality or City.

• #object ⇒ String
• #postal_code ⇒ String^?

  The postal code of the address.

• #primary ⇒ Boolean^?

  Whether this address is the primary address for the legal entity.

• #region ⇒ String^?

  Region or State.

• #updated_at ⇒ Time

Instance Method Summary

• #initialize(id:, addresses:, bank_settings:, business_description:, business_designation:, business_name:, citizenship_country:, compliance_details:, country_of_incorporation:, created_at:, date_formed:, date_of_birth:, discarded_at:, documents:, doing_business_as_names:, email:, expected_activity_volume:, external_id:, first_name:, identifications:, industry_classifications:, intended_use:, last_name:, legal_entity_associations:, legal_entity_type:, legal_structure:, listed_exchange:, live_mode:, metadata:, middle_name:, object:, operating_jurisdictions:, phone_numbers:, politically_exposed_person:, preferred_name:, prefix:, primary_social_media_sites:, regulators:, risk_rating:, service_provider_legal_entity_id:, status:, suffix:, terms_of_use:, third_party_verification:, third_party_verifications:, ticker_symbol:, updated_at:, wealth_and_employment_details:, website:) ⇒ Object constructor

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

• #to_hash ⇒ {

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_description:, business_designation:, business_name:, citizenship_country:, compliance_details:, country_of_incorporation:, created_at:, date_formed:, date_of_birth:, discarded_at:, documents:, doing_business_as_names:, email:, expected_activity_volume:, external_id:, first_name:, identifications:, industry_classifications:, intended_use:, last_name:, legal_entity_associations:, legal_entity_type:, legal_structure:, listed_exchange:, live_mode:, metadata:, middle_name:, object:, operating_jurisdictions:, phone_numbers:, politically_exposed_person:, preferred_name:, prefix:, primary_social_media_sites:, regulators:, risk_rating:, service_provider_legal_entity_id:, status:, suffix:, terms_of_use:, third_party_verification:, third_party_verifications:, ticker_symbol:, updated_at:, wealth_and_employment_details:, website:) ⇒ Object

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

Parameters:

• id (String)
• addresses (Array<ModernTreasury::Models::ChildLegalEntity::Address>) —

  A list of addresses for the entity.

• bank_settings (ModernTreasury::Models::LegalEntityBankSettings, nil)
• business_description (String, nil) —

  A description of the business.

• business_designation (Symbol, ModernTreasury::Models::ChildLegalEntity::BusinessDesignation, nil) —

  Legal designation associated with the business.

• business_name (String, nil) —

  The business's legal business name.

• citizenship_country (String, nil) —

  The country of citizenship for an individual.

• compliance_details (Object, nil)
• country_of_incorporation (String, nil) —

  The country where the business is incorporated, as an ISO 3166-1 alpha-2 country

• created_at (Time)
• date_formed (Date, nil) —

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

• date_of_birth (Date, nil) —

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

• discarded_at (Time, nil)
• documents (Array<ModernTreasury::Models::Document>)
• doing_business_as_names (Array<String>)
• email (String, nil) —

  The entity's primary email.

• expected_activity_volume (Integer, nil) —

  Monthly expected transaction volume in USD.

• external_id (String, nil) —

  An optional user-defined 180 character unique identifier.

• first_name (String, nil) —

  An individual's first name.

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

  A list of identifications for the legal entity.

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

  A list of industry classifications for the legal entity.

• intended_use (String, nil) —

  A description of the intended use of the legal entity.

• last_name (String, nil) —

  An individual's last name.

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

  The legal entity associations and its child legal entities.

• legal_entity_type (Symbol, ModernTreasury::Models::ChildLegalEntity::LegalEntityType) —

  The type of legal entity.

• legal_structure (Symbol, ModernTreasury::Models::ChildLegalEntity::LegalStructure, nil) —

  The business's legal structure.

• listed_exchange (String, nil) —

  ISO 10383 market identifier code.

• live_mode (Boolean) —

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

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

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

• middle_name (String, nil) —

  An individual's middle name.

• object (String)
• operating_jurisdictions (Array<String>) —

  A list of countries where the business operates, as ISO 3166-1 alpha-2 country c

• phone_numbers (Array<ModernTreasury::Models::ChildLegalEntity::PhoneNumber>)
• politically_exposed_person (Boolean, nil) —

  Whether the individual is a politically exposed person.

• preferred_name (String, nil) —

  An individual's preferred name.

• prefix (String, nil) —

  An individual's prefix.

• primary_social_media_sites (Array<String>) —

  A list of the entity's primary social media URLs.

• regulators (Array<ModernTreasury::Models::ChildLegalEntity::Regulator>, nil) —

  Array of regulatory bodies overseeing this institution.

• risk_rating (Symbol, ModernTreasury::Models::ChildLegalEntity::RiskRating, nil) —

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

• service_provider_legal_entity_id (String, nil) —

  The UUID of the parent legal entity in the service provider tree.

• status (Symbol, ModernTreasury::Models::ChildLegalEntity::Status, nil) —

  The activation status of the legal entity. One of pending, active, suspended, or

• suffix (String, nil) —

  An individual's suffix.

• terms_of_use (ModernTreasury::Models::ChildLegalEntity::TermsOfUse, nil) —

  Acceptance of terms of use by the legal entity.

• third_party_verification (ModernTreasury::Models::ThirdPartyVerification, nil) —

  Deprecated. Use third_party_verifications instead.

• third_party_verifications (Array<ModernTreasury::Models::ThirdPartyVerification>) —

  A list of third-party verifications run by external vendors.

• ticker_symbol (String, nil) —

  Stock ticker symbol for publicly traded companies.

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

  The entity's primary website URL.

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

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::ChildLegalEntity::Address::AddressType>]
  required :address_types,
           -> { ModernTreasury::Internal::Type::ArrayOf[enum: ModernTreasury::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. Use the full city name rather than an abbreviation (e.g. San
  #   Francisco).
  #
  #   @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 primary
  #   Whether this address is the primary address for the legal entity. Optional; when
  #   omitted it is inferred from the address types.
  #
  #   @return [Boolean, nil]
  required :primary, ModernTreasury::Internal::Type::Boolean, nil?: true

  # @!attribute region
  #   Region or State. This field is free-form; for US states, we recommend a
  #   two-letter code (e.g. CA). Full state names are also accepted.
  #
  #   @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:, primary:, region:, updated_at:)
  #   Some parameter documentations has been truncated, see
  #   {ModernTreasury::Models::ChildLegalEntity::Address} for more details.
  #
  #   @param id [String]
  #
  #   @param address_types [Array<Symbol, ModernTreasury::Models::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. Use the full city name rather than an abbreviation (e.g. San F
  #
  #   @param object [String]
  #
  #   @param postal_code [String, nil] The postal code of the address.
  #
  #   @param primary [Boolean, nil] Whether this address is the primary address for the legal entity. Optional; when
  #
  #   @param region [String, nil] Region or State. This field is free-form; for US states, we recommend a two-lett
  #
  #   @param updated_at [Time]

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

    BUSINESS = :business
    BUSINESS_PHYSICAL = :business_physical
    BUSINESS_REGISTERED = :business_registered
    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::ChildLegalEntity::Address::AddressType>

The types of this address.

Parameters:

• value (::Array[ModernTreasury::Models::ChildLegalEntity::Address::address_type])

Returns:

• (Array<Symbol, ModernTreasury::Models::ChildLegalEntity::Address::AddressType>)

# File 'lib/modern_treasury/models/child_legal_entity.rb', line 421

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

#country ⇒ String^?

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

Parameters:

• value (String, nil)

Returns:

• (String, nil)

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

required :country, String, nil?: true

#created_at ⇒ Time

Parameters:

• value (Time)

Returns:

• (Time)

# File 'lib/modern_treasury/models/child_legal_entity.rb', line 433

required :created_at, Time

#discarded_at ⇒ Time^?

Parameters:

• value (Time, nil)

Returns:

• (Time, nil)

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

required :discarded_at, Time, nil?: true

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/modern_treasury/models/child_legal_entity.rb', line 415

required :id, String

#line1 ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/child_legal_entity.rb', line 443

required :line1, String, nil?: true

#line2 ⇒ String^?

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/child_legal_entity.rb', line 448

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.

Parameters:

• value (Boolean)

Returns:

• (Boolean)

# File 'lib/modern_treasury/models/child_legal_entity.rb', line 455

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

#locality ⇒ String^?

Locality or City. Use the full city name rather than an abbreviation (e.g. San Francisco).

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/child_legal_entity.rb', line 462

required :locality, String, nil?: true

#object ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/modern_treasury/models/child_legal_entity.rb', line 467

required :object, String

#postal_code ⇒ String^?

The postal code of the address.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/child_legal_entity.rb', line 473

required :postal_code, String, nil?: true

#primary ⇒ Boolean^?

Whether this address is the primary address for the legal entity. Optional; when omitted it is inferred from the address types.

Parameters:

• value (Boolean, nil)

Returns:

• (Boolean, nil)

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

required :primary, ModernTreasury::Internal::Type::Boolean, nil?: true

#region ⇒ String^?

Region or State. This field is free-form; for US states, we recommend a two-letter code (e.g. CA). Full state names are also accepted.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/child_legal_entity.rb', line 487

required :region, String, nil?: true

#updated_at ⇒ Time

Parameters:

• value (Time)

Returns:

• (Time)

# File 'lib/modern_treasury/models/child_legal_entity.rb', line 492

required :updated_at, Time

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/modern_treasury/models/child_legal_entity.rbs', line 323

def to_hash: -> {