modern_treasury 0.1.0.pre.alpha.17 → 0.1.0.pre.alpha.19

data/lib/modern_treasury/models/legal_entity.rb

@@ -12,14 +12,16 @@ module ModernTreasury
       # @!attribute addresses
       #   A list of addresses for the entity.
       #
-      #   @return [Array<ModernTreasury::Models::LegalEntity::Address>]
+      #   @return [Array<ModernTreasury::LegalEntity::Address>]
       required :addresses,
-               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::LegalEntity::Address] }
+               -> {
+                 ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntity::Address]
+               }
 
       # @!attribute bank_settings
       #
-      #   @return [ModernTreasury::Models::BankSettings, nil]
-      required :bank_settings, -> { ModernTreasury::Models::BankSettings }, nil?: true
+      #   @return [ModernTreasury::BankSettings, nil]
+      required :bank_settings, -> { ModernTreasury::BankSettings }, nil?: true
 
       # @!attribute business_name
       #   The business's legal business name.
@@ -35,8 +37,8 @@ module ModernTreasury
 
       # @!attribute compliance_details
       #
-      #   @return [ModernTreasury::Models::LegalEntityComplianceDetail, nil]
-      required :compliance_details, -> { ModernTreasury::Models::LegalEntityComplianceDetail }, nil?: true
+      #   @return [ModernTreasury::LegalEntityComplianceDetail, nil]
+      required :compliance_details, -> { ModernTreasury::LegalEntityComplianceDetail }, nil?: true
 
       # @!attribute created_at
       #
@@ -80,16 +82,18 @@ module ModernTreasury
       # @!attribute identifications
       #   A list of identifications for the legal entity.
       #
-      #   @return [Array<ModernTreasury::Models::LegalEntity::Identification>]
+      #   @return [Array<ModernTreasury::LegalEntity::Identification>]
       required :identifications,
-               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::LegalEntity::Identification] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntity::Identification] }
 
       # @!attribute industry_classifications
       #   A list of industry classifications for the legal entity.
       #
-      #   @return [Array<ModernTreasury::Models::LegalEntityIndustryClassification>]
+      #   @return [Array<ModernTreasury::LegalEntityIndustryClassification>]
       required :industry_classifications,
-               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::LegalEntityIndustryClassification] }
+               -> {
+                 ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntityIndustryClassification]
+               }
 
       # @!attribute last_name
       #   An individual's last name.
@@ -100,22 +104,22 @@ module ModernTreasury
       # @!attribute legal_entity_associations
       #   The legal entity associations and its child legal entities.
       #
-      #   @return [Array<ModernTreasury::Models::LegalEntityAssociation>, nil]
+      #   @return [Array<ModernTreasury::LegalEntityAssociation>, nil]
       required :legal_entity_associations,
-               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::LegalEntityAssociation] },
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntityAssociation] },
                nil?: true
 
       # @!attribute legal_entity_type
       #   The type of legal entity.
       #
-      #   @return [Symbol, ModernTreasury::Models::LegalEntity::LegalEntityType]
-      required :legal_entity_type, enum: -> { ModernTreasury::Models::LegalEntity::LegalEntityType }
+      #   @return [Symbol, ModernTreasury::LegalEntity::LegalEntityType]
+      required :legal_entity_type, enum: -> { ModernTreasury::LegalEntity::LegalEntityType }
 
       # @!attribute legal_structure
       #   The business's legal structure.
       #
-      #   @return [Symbol, ModernTreasury::Models::LegalEntity::LegalStructure, nil]
-      required :legal_structure, enum: -> { ModernTreasury::Models::LegalEntity::LegalStructure }, nil?: true
+      #   @return [Symbol, ModernTreasury::LegalEntity::LegalStructure, nil]
+      required :legal_structure, enum: -> { ModernTreasury::LegalEntity::LegalStructure }, nil?: true
 
       # @!attribute live_mode
       #   This field will be true if this object exists in the live environment or false
@@ -144,9 +148,9 @@ module ModernTreasury
 
       # @!attribute phone_numbers
       #
-      #   @return [Array<ModernTreasury::Models::LegalEntity::PhoneNumber>]
+      #   @return [Array<ModernTreasury::LegalEntity::PhoneNumber>]
       required :phone_numbers,
-               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::LegalEntity::PhoneNumber] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntity::PhoneNumber] }
 
       # @!attribute politically_exposed_person
       #   Whether the individual is a politically exposed person.
@@ -169,8 +173,8 @@ module ModernTreasury
       # @!attribute risk_rating
       #   The risk rating of the legal entity. One of low, medium, high.
       #
-      #   @return [Symbol, ModernTreasury::Models::LegalEntity::RiskRating, nil]
-      required :risk_rating, enum: -> { ModernTreasury::Models::LegalEntity::RiskRating }, nil?: true
+      #   @return [Symbol, ModernTreasury::LegalEntity::RiskRating, nil]
+      required :risk_rating, enum: -> { ModernTreasury::LegalEntity::RiskRating }, nil?: true
 
       # @!attribute suffix
       #   An individual's suffix.
@@ -185,10 +189,8 @@ module ModernTreasury
 
       # @!attribute wealth_and_employment_details
       #
-      #   @return [ModernTreasury::Models::WealthAndEmploymentDetails, nil]
-      required :wealth_and_employment_details,
-               -> { ModernTreasury::Models::WealthAndEmploymentDetails },
-               nil?: true
+      #   @return [ModernTreasury::WealthAndEmploymentDetails, nil]
+      required :wealth_and_employment_details, -> { ModernTreasury::WealthAndEmploymentDetails }, nil?: true
 
       # @!attribute website
       #   The entity's primary website URL.
@@ -196,79 +198,73 @@ module ModernTreasury
       #   @return [String, nil]
       required :website, String, nil?: true
 
-      # @!parse
-      #   # @param id [String]
-      #   # @param addresses [Array<ModernTreasury::Models::LegalEntity::Address>]
-      #   # @param bank_settings [ModernTreasury::Models::BankSettings, nil]
-      #   # @param business_name [String, nil]
-      #   # @param citizenship_country [String, nil]
-      #   # @param compliance_details [ModernTreasury::Models::LegalEntityComplianceDetail, nil]
-      #   # @param created_at [Time]
-      #   # @param date_formed [Date, nil]
-      #   # @param date_of_birth [Date, nil]
-      #   # @param discarded_at [Time, nil]
-      #   # @param doing_business_as_names [Array<String>]
-      #   # @param email [String, nil]
-      #   # @param first_name [String, nil]
-      #   # @param identifications [Array<ModernTreasury::Models::LegalEntity::Identification>]
-      #   # @param industry_classifications [Array<ModernTreasury::Models::LegalEntityIndustryClassification>]
-      #   # @param last_name [String, nil]
-      #   # @param legal_entity_associations [Array<ModernTreasury::Models::LegalEntityAssociation>, nil]
-      #   # @param legal_entity_type [Symbol, ModernTreasury::Models::LegalEntity::LegalEntityType]
-      #   # @param legal_structure [Symbol, ModernTreasury::Models::LegalEntity::LegalStructure, nil]
-      #   # @param live_mode [Boolean]
-      #   # @param metadata [Hash{Symbol=>String}]
-      #   # @param middle_name [String, nil]
-      #   # @param object [String]
-      #   # @param phone_numbers [Array<ModernTreasury::Models::LegalEntity::PhoneNumber>]
-      #   # @param politically_exposed_person [Boolean, nil]
-      #   # @param preferred_name [String, nil]
-      #   # @param prefix [String, nil]
-      #   # @param risk_rating [Symbol, ModernTreasury::Models::LegalEntity::RiskRating, nil]
-      #   # @param suffix [String, nil]
-      #   # @param updated_at [Time]
-      #   # @param wealth_and_employment_details [ModernTreasury::Models::WealthAndEmploymentDetails, nil]
-      #   # @param website [String, nil]
-      #   #
-      #   def 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:,
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+      # @!method 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:)
+      #   Some parameter documentations has been truncated, see
+      #   {ModernTreasury::LegalEntity} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param addresses [Array<ModernTreasury::LegalEntity::Address>] A list of addresses for the entity.
+      #
+      #   @param bank_settings [ModernTreasury::BankSettings, nil]
+      #
+      #   @param business_name [String, nil] The business's legal business name.
+      #
+      #   @param citizenship_country [String, nil] The country of citizenship for an individual.
+      #
+      #   @param compliance_details [ModernTreasury::LegalEntityComplianceDetail, nil]
+      #
+      #   @param created_at [Time]
+      #
+      #   @param date_formed [Date, nil] A business's formation date (YYYY-MM-DD).
+      #
+      #   @param date_of_birth [Date, nil] An individual's date of birth (YYYY-MM-DD).
+      #
+      #   @param discarded_at [Time, nil]
+      #
+      #   @param doing_business_as_names [Array<String>]
+      #
+      #   @param email [String, nil] The entity's primary email.
+      #
+      #   @param first_name [String, nil] An individual's first name.
+      #
+      #   @param identifications [Array<ModernTreasury::LegalEntity::Identification>] A list of identifications for the legal entity.
+      #
+      #   @param industry_classifications [Array<ModernTreasury::LegalEntityIndustryClassification>] A list of industry classifications for the legal entity.
+      #
+      #   @param last_name [String, nil] An individual's last name.
+      #
+      #   @param legal_entity_associations [Array<ModernTreasury::LegalEntityAssociation>, nil] The legal entity associations and its child legal entities.
+      #
+      #   @param legal_entity_type [Symbol, ModernTreasury::LegalEntity::LegalEntityType] The type of legal entity.
+      #
+      #   @param legal_structure [Symbol, ModernTreasury::LegalEntity::LegalStructure, nil] The business's legal structure.
+      #
+      #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
+      #
+      #   @param metadata [Hash{Symbol=>String}] Additional data represented as key-value pairs. Both the key and value must be s
+      #
+      #   @param middle_name [String, nil] An individual's middle name.
+      #
+      #   @param object [String]
+      #
+      #   @param phone_numbers [Array<ModernTreasury::LegalEntity::PhoneNumber>]
+      #
+      #   @param politically_exposed_person [Boolean, nil] Whether the individual is a politically exposed person.
+      #
+      #   @param preferred_name [String, nil] An individual's preferred name.
+      #
+      #   @param prefix [String, nil] An individual's prefix.
+      #
+      #   @param risk_rating [Symbol, ModernTreasury::LegalEntity::RiskRating, nil] The risk rating of the legal entity. One of low, medium, high.
+      #
+      #   @param suffix [String, nil] An individual's suffix.
+      #
+      #   @param updated_at [Time]
+      #
+      #   @param wealth_and_employment_details [ModernTreasury::WealthAndEmploymentDetails, nil]
+      #
+      #   @param website [String, nil] The entity's primary website URL.
 
       class Address < ModernTreasury::Internal::Type::BaseModel
         # @!attribute id
@@ -279,9 +275,11 @@ module ModernTreasury
         # @!attribute address_types
         #   The types of this address.
         #
-        #   @return [Array<Symbol, ModernTreasury::Models::LegalEntity::Address::AddressType>]
+        #   @return [Array<Symbol, ModernTreasury::LegalEntity::Address::AddressType>]
         required :address_types,
-                 -> { ModernTreasury::Internal::Type::ArrayOf[enum: ModernTreasury::Models::LegalEntity::Address::AddressType] }
+                 -> {
+                   ModernTreasury::Internal::Type::ArrayOf[enum: ModernTreasury::LegalEntity::Address::AddressType]
+                 }
 
         # @!attribute country
         #   Country code conforms to [ISO 3166-1 alpha-2]
@@ -344,41 +342,35 @@ module ModernTreasury
         #   @return [Time]
         required :updated_at, Time
 
-        # @!parse
-        #   # @param id [String]
-        #   # @param address_types [Array<Symbol, ModernTreasury::Models::LegalEntity::Address::AddressType>]
-        #   # @param country [String, nil]
-        #   # @param created_at [Time]
-        #   # @param discarded_at [Time, nil]
-        #   # @param line1 [String, nil]
-        #   # @param line2 [String, nil]
-        #   # @param live_mode [Boolean]
-        #   # @param locality [String, nil]
-        #   # @param object [String]
-        #   # @param postal_code [String, nil]
-        #   # @param region [String, nil]
-        #   # @param updated_at [Time]
-        #   #
-        #   def initialize(
-        #     id:,
-        #     address_types:,
-        #     country:,
-        #     created_at:,
-        #     discarded_at:,
-        #     line1:,
-        #     line2:,
-        #     live_mode:,
-        #     locality:,
-        #     object:,
-        #     postal_code:,
-        #     region:,
-        #     updated_at:,
-        #     **
-        #   )
-        #     super
-        #   end
-
-        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+        # @!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::LegalEntity::Address} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param address_types [Array<Symbol, ModernTreasury::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
@@ -389,11 +381,8 @@ module ModernTreasury
           PO_BOX = :po_box
           RESIDENTIAL = :residential
 
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
+          # @!method self.values
+          #   @return [Array<Symbol>]
         end
       end
 
@@ -416,8 +405,8 @@ module ModernTreasury
         # @!attribute id_type
         #   The type of ID number.
         #
-        #   @return [Symbol, ModernTreasury::Models::LegalEntity::Identification::IDType]
-        required :id_type, enum: -> { ModernTreasury::Models::LegalEntity::Identification::IDType }
+        #   @return [Symbol, ModernTreasury::LegalEntity::Identification::IDType]
+        required :id_type, enum: -> { ModernTreasury::LegalEntity::Identification::IDType }
 
         # @!attribute issuing_country
         #   The ISO 3166-1 alpha-2 country code of the country that issued the
@@ -443,23 +432,29 @@ module ModernTreasury
         #   @return [Time]
         required :updated_at, Time
 
-        # @!parse
-        #   # @param id [String]
-        #   # @param created_at [Time]
-        #   # @param discarded_at [Time, nil]
-        #   # @param id_type [Symbol, ModernTreasury::Models::LegalEntity::Identification::IDType]
-        #   # @param issuing_country [String, nil]
-        #   # @param live_mode [Boolean]
-        #   # @param object [String]
-        #   # @param updated_at [Time]
-        #   #
-        #   def initialize(id:, created_at:, discarded_at:, id_type:, issuing_country:, live_mode:, object:, updated_at:, **) = super
-
-        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+        # @!method initialize(id:, created_at:, discarded_at:, id_type:, issuing_country:, live_mode:, object:, updated_at:)
+        #   Some parameter documentations has been truncated, see
+        #   {ModernTreasury::LegalEntity::Identification} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param created_at [Time]
+        #
+        #   @param discarded_at [Time, nil]
+        #
+        #   @param id_type [Symbol, ModernTreasury::LegalEntity::Identification::IDType] The type of ID number.
+        #
+        #   @param issuing_country [String, nil] The ISO 3166-1 alpha-2 country code of the country that issued the identificatio
+        #
+        #   @param live_mode [Boolean] This field will be true if this object exists in the live environment or false i
+        #
+        #   @param object [String]
+        #
+        #   @param updated_at [Time]
 
         # The type of ID number.
         #
-        # @see ModernTreasury::Models::LegalEntity::Identification#id_type
+        # @see ModernTreasury::LegalEntity::Identification#id_type
         module IDType
           extend ModernTreasury::Internal::Type::Enum
 
@@ -485,17 +480,14 @@ module ModernTreasury
           US_SSN = :us_ssn
           VN_TIN = :vn_tin
 
-          finalize!
-
-          # @!parse
-          #   # @return [Array<Symbol>]
-          #   def self.values; end
+          # @!method self.values
+          #   @return [Array<Symbol>]
         end
       end
 
       # The type of legal entity.
       #
-      # @see ModernTreasury::Models::LegalEntity#legal_entity_type
+      # @see ModernTreasury::LegalEntity#legal_entity_type
       module LegalEntityType
         extend ModernTreasury::Internal::Type::Enum
 
@@ -503,16 +495,13 @@ module ModernTreasury
         INDIVIDUAL = :individual
         JOINT = :joint
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
 
       # The business's legal structure.
       #
-      # @see ModernTreasury::Models::LegalEntity#legal_structure
+      # @see ModernTreasury::LegalEntity#legal_structure
       module LegalStructure
         extend ModernTreasury::Internal::Type::Enum
 
@@ -523,36 +512,25 @@ module ModernTreasury
         SOLE_PROPRIETORSHIP = :sole_proprietorship
         TRUST = :trust
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
 
       class PhoneNumber < ModernTreasury::Internal::Type::BaseModel
-        # @!attribute [r] phone_number
+        # @!attribute phone_number
         #
         #   @return [String, nil]
         optional :phone_number, String
 
-        # @!parse
-        #   # @return [String]
-        #   attr_writer :phone_number
-
-        # @!parse
-        #   # A list of phone numbers in E.164 format.
-        #   #
-        #   # @param phone_number [String]
-        #   #
-        #   def initialize(phone_number: nil, **) = super
-
-        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+        # @!method initialize(phone_number: nil)
+        #   A list of phone numbers in E.164 format.
+        #
+        #   @param phone_number [String]
       end
 
       # The risk rating of the legal entity. One of low, medium, high.
       #
-      # @see ModernTreasury::Models::LegalEntity#risk_rating
+      # @see ModernTreasury::LegalEntity#risk_rating
       module RiskRating
         extend ModernTreasury::Internal::Type::Enum
 
@@ -560,11 +538,8 @@ module ModernTreasury
         MEDIUM = :medium
         HIGH = :high
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end