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

data/lib/modern_treasury/models/legal_entity_association_create_params.rb

@@ -2,14 +2,15 @@
 
 module ModernTreasury
   module Models
-    class LegalEntityAssociationCreateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::LegalEntityAssociations#create
+    class LegalEntityAssociationCreateParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!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
@@ -18,7 +19,7 @@ module ModernTreasury
       #
       #   @return [Array<Symbol, ModernTreasury::Models::LegalEntityAssociationCreateParams::RelationshipType>]
       required :relationship_types,
-               -> { ModernTreasury::ArrayOf[enum: ModernTreasury::Models::LegalEntityAssociationCreateParams::RelationshipType] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[enum: ModernTreasury::Models::LegalEntityAssociationCreateParams::RelationshipType] }
 
       # @!attribute [r] child_legal_entity
       #   The child legal entity.
@@ -75,22 +76,12 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      # @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
 
@@ -98,17 +89,16 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      class ChildLegalEntity < ModernTreasury::BaseModel
+      class ChildLegalEntity < ModernTreasury::Internal::Type::BaseModel
         # @!attribute [r] addresses
         #   A list of addresses for the entity.
         #
         #   @return [Array<ModernTreasury::Models::LegalEntityAssociationCreateParams::ChildLegalEntity::Address>, nil]
         optional :addresses,
-                 -> { ModernTreasury::ArrayOf[ModernTreasury::Models::LegalEntityAssociationCreateParams::ChildLegalEntity::Address] }
+                 -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::LegalEntityAssociationCreateParams::ChildLegalEntity::Address] }
 
         # @!parse
         #   # @return [Array<ModernTreasury::Models::LegalEntityAssociationCreateParams::ChildLegalEntity::Address>]
@@ -131,6 +121,11 @@ module ModernTreasury
         #   @return [String, nil]
         optional :citizenship_country, String, nil?: true
 
+        # @!attribute compliance_details
+        #
+        #   @return [ModernTreasury::Models::LegalEntityComplianceDetail, nil]
+        optional :compliance_details, -> { ModernTreasury::Models::LegalEntityComplianceDetail }, nil?: true
+
         # @!attribute date_formed
         #   A business's formation date (YYYY-MM-DD).
         #
@@ -146,7 +141,7 @@ module ModernTreasury
         # @!attribute [r] doing_business_as_names
         #
         #   @return [Array<String>, nil]
-        optional :doing_business_as_names, ModernTreasury::ArrayOf[String]
+        optional :doing_business_as_names, ModernTreasury::Internal::Type::ArrayOf[String]
 
         # @!parse
         #   # @return [Array<String>]
@@ -169,12 +164,23 @@ module ModernTreasury
         #
         #   @return [Array<ModernTreasury::Models::LegalEntityAssociationCreateParams::ChildLegalEntity::Identification>, nil]
         optional :identifications,
-                 -> { ModernTreasury::ArrayOf[ModernTreasury::Models::LegalEntityAssociationCreateParams::ChildLegalEntity::Identification] }
+                 -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::LegalEntityAssociationCreateParams::ChildLegalEntity::Identification] }
 
         # @!parse
         #   # @return [Array<ModernTreasury::Models::LegalEntityAssociationCreateParams::ChildLegalEntity::Identification>]
         #   attr_writer :identifications
 
+        # @!attribute [r] industry_classifications
+        #   A list of industry classifications for the legal entity.
+        #
+        #   @return [Array<ModernTreasury::Models::LegalEntityIndustryClassification>, nil]
+        optional :industry_classifications,
+                 -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::LegalEntityIndustryClassification] }
+
+        # @!parse
+        #   # @return [Array<ModernTreasury::Models::LegalEntityIndustryClassification>]
+        #   attr_writer :industry_classifications
+
         # @!attribute last_name
         #   An individual's last name.
         #
@@ -202,10 +208,10 @@ module ModernTreasury
 
         # @!attribute [r] metadata
         #   Additional data represented as key-value pairs. Both the key and value must be
-        #     strings.
+        #   strings.
         #
         #   @return [Hash{Symbol=>String}, nil]
-        optional :metadata, ModernTreasury::HashOf[String]
+        optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
         # @!parse
         #   # @return [Hash{Symbol=>String}]
@@ -221,7 +227,7 @@ module ModernTreasury
         #
         #   @return [Array<ModernTreasury::Models::LegalEntityAssociationCreateParams::ChildLegalEntity::PhoneNumber>, nil]
         optional :phone_numbers,
-                 -> { ModernTreasury::ArrayOf[ModernTreasury::Models::LegalEntityAssociationCreateParams::ChildLegalEntity::PhoneNumber] }
+                 -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::LegalEntityAssociationCreateParams::ChildLegalEntity::PhoneNumber] }
 
         # @!parse
         #   # @return [Array<ModernTreasury::Models::LegalEntityAssociationCreateParams::ChildLegalEntity::PhoneNumber>]
@@ -231,7 +237,7 @@ module ModernTreasury
         #   Whether the individual is a politically exposed person.
         #
         #   @return [Boolean, nil]
-        optional :politically_exposed_person, ModernTreasury::BooleanModel, nil?: true
+        optional :politically_exposed_person, ModernTreasury::Internal::Type::Boolean, nil?: true
 
         # @!attribute preferred_name
         #   An individual's preferred name.
@@ -279,12 +285,14 @@ 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 date_formed [Date, nil]
         #   # @param date_of_birth [Date, nil]
         #   # @param doing_business_as_names [Array<String>]
         #   # @param email [String, nil]
         #   # @param first_name [String, nil]
         #   # @param identifications [Array<ModernTreasury::Models::LegalEntityAssociationCreateParams::ChildLegalEntity::Identification>]
+        #   # @param industry_classifications [Array<ModernTreasury::Models::LegalEntityIndustryClassification>]
         #   # @param last_name [String, nil]
         #   # @param legal_entity_type [Symbol, ModernTreasury::Models::LegalEntityAssociationCreateParams::ChildLegalEntity::LegalEntityType]
         #   # @param legal_structure [Symbol, ModernTreasury::Models::LegalEntityAssociationCreateParams::ChildLegalEntity::LegalStructure, nil]
@@ -304,12 +312,14 @@ module ModernTreasury
         #     bank_settings: nil,
         #     business_name: nil,
         #     citizenship_country: nil,
+        #     compliance_details: nil,
         #     date_formed: nil,
         #     date_of_birth: nil,
         #     doing_business_as_names: nil,
         #     email: nil,
         #     first_name: nil,
         #     identifications: nil,
+        #     industry_classifications: nil,
         #     last_name: nil,
         #     legal_entity_type: nil,
         #     legal_structure: nil,
@@ -328,9 +338,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 country
           #   Country code conforms to [ISO 3166-1 alpha-2]
           #
@@ -365,7 +375,7 @@ module ModernTreasury
           #
           #   @return [Array<Symbol, ModernTreasury::Models::LegalEntityAssociationCreateParams::ChildLegalEntity::Address::AddressType>, nil]
           optional :address_types,
-                   -> { ModernTreasury::ArrayOf[enum: ModernTreasury::Models::LegalEntityAssociationCreateParams::ChildLegalEntity::Address::AddressType] }
+                   -> { ModernTreasury::Internal::Type::ArrayOf[enum: ModernTreasury::Models::LegalEntityAssociationCreateParams::ChildLegalEntity::Address::AddressType] }
 
           # @!parse
           #   # @return [Array<Symbol, ModernTreasury::Models::LegalEntityAssociationCreateParams::ChildLegalEntity::Address::AddressType>]
@@ -387,26 +397,11 @@ module ModernTreasury
           #   #
           #   def initialize(country:, line1:, locality:, postal_code:, region:, address_types: nil, line2: nil, **) = super
 
-          # 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
@@ -417,12 +412,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_number
           #   The ID number of identification document.
           #
@@ -438,7 +432,7 @@ module ModernTreasury
 
           # @!attribute issuing_country
           #   The ISO 3166-1 alpha-2 country code of the country that issued the
-          #     identification
+          #   identification
           #
           #   @return [String, nil]
           optional :issuing_country, String, nil?: true
@@ -450,30 +444,14 @@ module ModernTreasury
           #   #
           #   def initialize(id_number:, id_type:, issuing_country: nil, **) = 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::LegalEntityAssociationCreateParams::ChildLegalEntity::Identification#id_type
+          module IDType
+            extend ModernTreasury::Internal::Type::Enum
+
             AR_CUIL = :ar_cuil
             AR_CUIT = :ar_cuit
             BR_CNPJ = :br_cnpj
@@ -500,25 +478,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
-        #   # ...
-        # end
-        # ```
-        class LegalEntityType < ModernTreasury::Enum
+        # @see ModernTreasury::Models::LegalEntityAssociationCreateParams::ChildLegalEntity#legal_entity_type
+        module LegalEntityType
+          extend ModernTreasury::Internal::Type::Enum
+
           BUSINESS = :business
           INDIVIDUAL = :individual
 
@@ -526,32 +495,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::LegalEntityAssociationCreateParams::ChildLegalEntity#legal_structure
+        module LegalStructure
+          extend ModernTreasury::Internal::Type::Enum
+
           CORPORATION = :corporation
           LLC = :llc
           NON_PROFIT = :non_profit
@@ -563,11 +515,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]
@@ -584,25 +535,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::LegalEntityAssociationCreateParams::ChildLegalEntity#risk_rating
+        module RiskRating
+          extend ModernTreasury::Internal::Type::Enum
+
           LOW = :low
           MEDIUM = :medium
           HIGH = :high
@@ -611,7 +552,6 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end

data/lib/modern_treasury/models/legal_entity_compliance_detail.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LegalEntityComplianceDetail < ModernTreasury::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute discarded_at
+      #
+      #   @return [Time, nil]
+      required :discarded_at, Time, nil?: true
+
+      # @!attribute issuer
+      #   The issuer of the compliance token.
+      #
+      #   @return [String]
+      required :issuer, String
+
+      # @!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 object
+      #
+      #   @return [String]
+      required :object, String
+
+      # @!attribute token_expires_at
+      #   The timestamp when the compliance token expires.
+      #
+      #   @return [Time, nil]
+      required :token_expires_at, Time, nil?: true
+
+      # @!attribute token_issued_at
+      #   The timestamp when the compliance token was issued.
+      #
+      #   @return [Time, nil]
+      required :token_issued_at, Time, nil?: true
+
+      # @!attribute token_url
+      #   The URL to the compliance token. (ex. provider portal URL)
+      #
+      #   @return [String, nil]
+      required :token_url, String, nil?: true
+
+      # @!attribute updated_at
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute validated
+      #   Whether entity corresponding to the compliance token has been validated.
+      #
+      #   @return [Boolean]
+      required :validated, ModernTreasury::Internal::Type::Boolean
+
+      # @!attribute validated_at
+      #   The timestamp when the entity was validated.
+      #
+      #   @return [Time, nil]
+      required :validated_at, Time, nil?: true
+
+      # @!parse
+      #   # @param id [String]
+      #   # @param created_at [Time]
+      #   # @param discarded_at [Time, nil]
+      #   # @param issuer [String]
+      #   # @param live_mode [Boolean]
+      #   # @param object [String]
+      #   # @param token_expires_at [Time, nil]
+      #   # @param token_issued_at [Time, nil]
+      #   # @param token_url [String, nil]
+      #   # @param updated_at [Time]
+      #   # @param validated [Boolean]
+      #   # @param validated_at [Time, nil]
+      #   #
+      #   def initialize(
+      #     id:,
+      #     created_at:,
+      #     discarded_at:,
+      #     issuer:,
+      #     live_mode:,
+      #     object:,
+      #     token_expires_at:,
+      #     token_issued_at:,
+      #     token_url:,
+      #     updated_at:,
+      #     validated:,
+      #     validated_at:,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+    end
+  end
+end