modern_treasury 0.1.0.pre.alpha.15 → 0.1.0.pre.alpha.17

data/lib/modern_treasury/models/legal_entity_association.rb

@@ -2,7 +2,8 @@
 
 module ModernTreasury
   module Models
-    class LegalEntityAssociation < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::LegalEntityAssociations#create
+    class LegalEntityAssociation < ModernTreasury::Internal::Type::BaseModel
       # @!attribute id
       #
       #   @return [String]
@@ -26,10 +27,10 @@ module ModernTreasury
 
       # @!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.
+      #   if it exists in the test environment.
       #
       #   @return [Boolean]
-      required :live_mode, ModernTreasury::BooleanModel
+      required :live_mode, ModernTreasury::Internal::Type::Boolean
 
       # @!attribute object
       #
@@ -44,7 +45,7 @@ module ModernTreasury
 
       # @!attribute parent_legal_entity_id
       #   The ID of the parent legal entity. This must be a business or joint legal
-      #     entity.
+      #   entity.
       #
       #   @return [String]
       required :parent_legal_entity_id, String
@@ -53,7 +54,7 @@ module ModernTreasury
       #
       #   @return [Array<Symbol, ModernTreasury::Models::LegalEntityAssociation::RelationshipType>]
       required :relationship_types,
-               -> { ModernTreasury::ArrayOf[enum: ModernTreasury::Models::LegalEntityAssociation::RelationshipType] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[enum: ModernTreasury::Models::LegalEntityAssociation::RelationshipType] }
 
       # @!attribute title
       #   The job title of the child entity at the parent entity.
@@ -96,9 +97,10 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      class ChildLegalEntity < ModernTreasury::BaseModel
+      # @see ModernTreasury::Models::LegalEntityAssociation#child_legal_entity
+      class ChildLegalEntity < ModernTreasury::Internal::Type::BaseModel
         # @!attribute id
         #
         #   @return [String]
@@ -109,7 +111,7 @@ module ModernTreasury
         #
         #   @return [Array<ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::Address>]
         required :addresses,
-                 -> { ModernTreasury::ArrayOf[ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::Address] }
+                 -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::Address] }
 
         # @!attribute bank_settings
         #
@@ -128,6 +130,11 @@ module ModernTreasury
         #   @return [String, nil]
         required :citizenship_country, String, nil?: true
 
+        # @!attribute compliance_details
+        #
+        #   @return [ModernTreasury::Models::LegalEntityComplianceDetail, nil]
+        required :compliance_details, -> { ModernTreasury::Models::LegalEntityComplianceDetail }, nil?: true
+
         # @!attribute created_at
         #
         #   @return [Time]
@@ -153,7 +160,7 @@ module ModernTreasury
         # @!attribute doing_business_as_names
         #
         #   @return [Array<String>]
-        required :doing_business_as_names, ModernTreasury::ArrayOf[String]
+        required :doing_business_as_names, ModernTreasury::Internal::Type::ArrayOf[String]
 
         # @!attribute email
         #   The entity's primary email.
@@ -172,7 +179,14 @@ module ModernTreasury
         #
         #   @return [Array<ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::Identification>]
         required :identifications,
-                 -> { ModernTreasury::ArrayOf[ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::Identification] }
+                 -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::Identification] }
+
+        # @!attribute industry_classifications
+        #   A list of industry classifications for the legal entity.
+        #
+        #   @return [Array<ModernTreasury::Models::LegalEntityIndustryClassification>]
+        required :industry_classifications,
+                 -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::LegalEntityIndustryClassification] }
 
         # @!attribute last_name
         #   An individual's last name.
@@ -197,17 +211,17 @@ module ModernTreasury
 
         # @!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.
+        #   if it exists in the test environment.
         #
         #   @return [Boolean]
-        required :live_mode, ModernTreasury::BooleanModel
+        required :live_mode, ModernTreasury::Internal::Type::Boolean
 
         # @!attribute metadata
         #   Additional data represented as key-value pairs. Both the key and value must be
-        #     strings.
+        #   strings.
         #
         #   @return [Hash{Symbol=>String}]
-        required :metadata, ModernTreasury::HashOf[String]
+        required :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
         # @!attribute middle_name
         #   An individual's middle name.
@@ -224,13 +238,13 @@ module ModernTreasury
         #
         #   @return [Array<ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::PhoneNumber>]
         required :phone_numbers,
-                 -> { ModernTreasury::ArrayOf[ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::PhoneNumber] }
+                 -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::PhoneNumber] }
 
         # @!attribute politically_exposed_person
         #   Whether the individual is a politically exposed person.
         #
         #   @return [Boolean, nil]
-        required :politically_exposed_person, ModernTreasury::BooleanModel, nil?: true
+        required :politically_exposed_person, ModernTreasury::Internal::Type::Boolean, nil?: true
 
         # @!attribute preferred_name
         #   An individual's preferred name.
@@ -284,6 +298,7 @@ module ModernTreasury
         #   # @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]
@@ -292,6 +307,7 @@ module ModernTreasury
         #   # @param email [String, nil]
         #   # @param first_name [String, nil]
         #   # @param identifications [Array<ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::Identification>]
+        #   # @param industry_classifications [Array<ModernTreasury::Models::LegalEntityIndustryClassification>]
         #   # @param last_name [String, nil]
         #   # @param legal_entity_type [Symbol, ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::LegalEntityType]
         #   # @param legal_structure [Symbol, ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::LegalStructure, nil]
@@ -315,6 +331,7 @@ module ModernTreasury
         #     bank_settings:,
         #     business_name:,
         #     citizenship_country:,
+        #     compliance_details:,
         #     created_at:,
         #     date_formed:,
         #     date_of_birth:,
@@ -323,6 +340,7 @@ module ModernTreasury
         #     email:,
         #     first_name:,
         #     identifications:,
+        #     industry_classifications:,
         #     last_name:,
         #     legal_entity_type:,
         #     legal_structure:,
@@ -344,9 +362,9 @@ module ModernTreasury
         #     super
         #   end
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-        class Address < ModernTreasury::BaseModel
+        class Address < ModernTreasury::Internal::Type::BaseModel
           # @!attribute id
           #
           #   @return [String]
@@ -357,7 +375,7 @@ module ModernTreasury
           #
           #   @return [Array<Symbol, ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::Address::AddressType>]
           required :address_types,
-                   -> { ModernTreasury::ArrayOf[enum: ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::Address::AddressType] }
+                   -> { ModernTreasury::Internal::Type::ArrayOf[enum: ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::Address::AddressType] }
 
           # @!attribute country
           #   Country code conforms to [ISO 3166-1 alpha-2]
@@ -387,10 +405,10 @@ module ModernTreasury
 
           # @!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.
+          #   if it exists in the test environment.
           #
           #   @return [Boolean]
-          required :live_mode, ModernTreasury::BooleanModel
+          required :live_mode, ModernTreasury::Internal::Type::Boolean
 
           # @!attribute locality
           #   Locality or City.
@@ -454,26 +472,11 @@ module ModernTreasury
           #     super
           #   end
 
-          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+
+          module AddressType
+            extend ModernTreasury::Internal::Type::Enum
 
-          # @abstract
-          #
-          # @example
-          # ```ruby
-          # case address_type
-          # in :business
-          #   # ...
-          # in :mailing
-          #   # ...
-          # in :other
-          #   # ...
-          # in :po_box
-          #   # ...
-          # in :residential
-          #   # ...
-          # end
-          # ```
-          class AddressType < ModernTreasury::Enum
             BUSINESS = :business
             MAILING = :mailing
             OTHER = :other
@@ -484,12 +487,11 @@ module ModernTreasury
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end
 
-        class Identification < ModernTreasury::BaseModel
+        class Identification < ModernTreasury::Internal::Type::BaseModel
           # @!attribute id
           #
           #   @return [String]
@@ -514,17 +516,17 @@ module ModernTreasury
 
           # @!attribute issuing_country
           #   The ISO 3166-1 alpha-2 country code of the country that issued the
-          #     identification
+          #   identification
           #
           #   @return [String, nil]
           required :issuing_country, 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.
+          #   if it exists in the test environment.
           #
           #   @return [Boolean]
-          required :live_mode, ModernTreasury::BooleanModel
+          required :live_mode, ModernTreasury::Internal::Type::Boolean
 
           # @!attribute object
           #
@@ -548,30 +550,14 @@ module ModernTreasury
           #   #
           #   def initialize(id:, created_at:, discarded_at:, id_type:, issuing_country:, live_mode:, object:, updated_at:, **) = super
 
-          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-          # @abstract
-          #
           # The type of ID number.
           #
-          # @example
-          # ```ruby
-          # case id_type
-          # in :ar_cuil
-          #   # ...
-          # in :ar_cuit
-          #   # ...
-          # in :br_cnpj
-          #   # ...
-          # in :br_cpf
-          #   # ...
-          # in :cl_run
-          #   # ...
-          # in ...
-          #   #...
-          # end
-          # ```
-          class IDType < ModernTreasury::Enum
+          # @see ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::Identification#id_type
+          module IDType
+            extend ModernTreasury::Internal::Type::Enum
+
             AR_CUIL = :ar_cuil
             AR_CUIT = :ar_cuit
             BR_CNPJ = :br_cnpj
@@ -598,27 +584,16 @@ module ModernTreasury
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end
 
-        # @abstract
-        #
         # The type of legal entity.
         #
-        # @example
-        # ```ruby
-        # case legal_entity_type
-        # in :business
-        #   # ...
-        # in :individual
-        #   # ...
-        # in :joint
-        #   # ...
-        # end
-        # ```
-        class LegalEntityType < ModernTreasury::Enum
+        # @see ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity#legal_entity_type
+        module LegalEntityType
+          extend ModernTreasury::Internal::Type::Enum
+
           BUSINESS = :business
           INDIVIDUAL = :individual
           JOINT = :joint
@@ -627,32 +602,15 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
 
-        # @abstract
-        #
         # The business's legal structure.
         #
-        # @example
-        # ```ruby
-        # case legal_structure
-        # in :corporation
-        #   # ...
-        # in :llc
-        #   # ...
-        # in :non_profit
-        #   # ...
-        # in :partnership
-        #   # ...
-        # in :sole_proprietorship
-        #   # ...
-        # in ...
-        #   #...
-        # end
-        # ```
-        class LegalStructure < ModernTreasury::Enum
+        # @see ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity#legal_structure
+        module LegalStructure
+          extend ModernTreasury::Internal::Type::Enum
+
           CORPORATION = :corporation
           LLC = :llc
           NON_PROFIT = :non_profit
@@ -664,11 +622,10 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
 
-        class PhoneNumber < ModernTreasury::BaseModel
+        class PhoneNumber < ModernTreasury::Internal::Type::BaseModel
           # @!attribute [r] phone_number
           #
           #   @return [String, nil]
@@ -685,25 +642,15 @@ module ModernTreasury
           #   #
           #   def initialize(phone_number: nil, **) = super
 
-          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
         end
 
-        # @abstract
-        #
         # The risk rating of the legal entity. One of low, medium, high.
         #
-        # @example
-        # ```ruby
-        # case risk_rating
-        # in :low
-        #   # ...
-        # in :medium
-        #   # ...
-        # in :high
-        #   # ...
-        # end
-        # ```
-        class RiskRating < ModernTreasury::Enum
+        # @see ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity#risk_rating
+        module RiskRating
+          extend ModernTreasury::Internal::Type::Enum
+
           LOW = :low
           MEDIUM = :medium
           HIGH = :high
@@ -712,25 +659,14 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end
 
-      # @abstract
-      #
       # A list of relationship types for how the child entity relates to parent entity.
-      #
-      # @example
-      # ```ruby
-      # case relationship_type
-      # in :beneficial_owner
-      #   # ...
-      # in :control_person
-      #   # ...
-      # end
-      # ```
-      class RelationshipType < ModernTreasury::Enum
+      module RelationshipType
+        extend ModernTreasury::Internal::Type::Enum
+
         BENEFICIAL_OWNER = :beneficial_owner
         CONTROL_PERSON = :control_person
 
@@ -738,7 +674,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end