modern_treasury 0.11.0 → 0.12.0

data/lib/modern_treasury/models/legal_entity_association.rb

@@ -12,8 +12,8 @@ module ModernTreasury
       # @!attribute child_legal_entity
       #   The child legal entity.
       #
-      #   @return [ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity]
-      required :child_legal_entity, -> { ModernTreasury::LegalEntityAssociation::ChildLegalEntity }
+      #   @return [ModernTreasury::Models::ChildLegalEntity]
+      required :child_legal_entity, -> { ModernTreasury::ChildLegalEntity }
 
       # @!attribute created_at
       #
@@ -73,7 +73,7 @@ module ModernTreasury
       #
       #   @param id [String]
       #
-      #   @param child_legal_entity [ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity] The child legal entity.
+      #   @param child_legal_entity [ModernTreasury::Models::ChildLegalEntity] The child legal entity.
       #
       #   @param created_at [Time]
       #
@@ -93,562 +93,6 @@ module ModernTreasury
       #
       #   @param updated_at [Time]
 
-      # @see ModernTreasury::Models::LegalEntityAssociation#child_legal_entity
-      class ChildLegalEntity < ModernTreasury::Internal::Type::BaseModel
-        # @!attribute id
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute addresses
-        #   A list of addresses for the entity.
-        #
-        #   @return [Array<ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::Address>]
-        required :addresses,
-                 -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntityAssociation::ChildLegalEntity::Address] }
-
-        # @!attribute bank_settings
-        #
-        #   @return [ModernTreasury::Models::LegalEntityBankSettings, nil]
-        required :bank_settings, -> { ModernTreasury::LegalEntityBankSettings }, nil?: true
-
-        # @!attribute business_name
-        #   The business's legal business name.
-        #
-        #   @return [String, nil]
-        required :business_name, String, nil?: true
-
-        # @!attribute citizenship_country
-        #   The country of citizenship for an individual.
-        #
-        #   @return [String, nil]
-        required :citizenship_country, String, nil?: true
-
-        # @!attribute compliance_details
-        #
-        #   @return [ModernTreasury::Models::LegalEntityComplianceDetail, nil]
-        required :compliance_details, -> { ModernTreasury::LegalEntityComplianceDetail }, nil?: true
-
-        # @!attribute created_at
-        #
-        #   @return [Time]
-        required :created_at, Time
-
-        # @!attribute date_formed
-        #   A business's formation date (YYYY-MM-DD).
-        #
-        #   @return [Date, nil]
-        required :date_formed, Date, nil?: true
-
-        # @!attribute date_of_birth
-        #   An individual's date of birth (YYYY-MM-DD).
-        #
-        #   @return [Date, nil]
-        required :date_of_birth, Date, nil?: true
-
-        # @!attribute discarded_at
-        #
-        #   @return [Time, nil]
-        required :discarded_at, Time, nil?: true
-
-        # @!attribute doing_business_as_names
-        #
-        #   @return [Array<String>]
-        required :doing_business_as_names, ModernTreasury::Internal::Type::ArrayOf[String]
-
-        # @!attribute email
-        #   The entity's primary email.
-        #
-        #   @return [String, nil]
-        required :email, String, nil?: true
-
-        # @!attribute first_name
-        #   An individual's first name.
-        #
-        #   @return [String, nil]
-        required :first_name, String, nil?: true
-
-        # @!attribute identifications
-        #   A list of identifications for the legal entity.
-        #
-        #   @return [Array<ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::Identification>]
-        required :identifications,
-                 -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::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::LegalEntityIndustryClassification] }
-
-        # @!attribute last_name
-        #   An individual's last name.
-        #
-        #   @return [String, nil]
-        required :last_name, String, nil?: true
-
-        # @!attribute legal_entity_type
-        #   The type of legal entity.
-        #
-        #   @return [Symbol, ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::LegalEntityType]
-        required :legal_entity_type,
-                 enum: -> { ModernTreasury::LegalEntityAssociation::ChildLegalEntity::LegalEntityType }
-
-        # @!attribute legal_structure
-        #   The business's legal structure.
-        #
-        #   @return [Symbol, ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::LegalStructure, nil]
-        required :legal_structure,
-                 enum: -> { ModernTreasury::LegalEntityAssociation::ChildLegalEntity::LegalStructure },
-                 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 metadata
-        #   Additional data represented as key-value pairs. Both the key and value must be
-        #   strings.
-        #
-        #   @return [Hash{Symbol=>String}]
-        required :metadata, ModernTreasury::Internal::Type::HashOf[String]
-
-        # @!attribute middle_name
-        #   An individual's middle name.
-        #
-        #   @return [String, nil]
-        required :middle_name, String, nil?: true
-
-        # @!attribute object
-        #
-        #   @return [String]
-        required :object, String
-
-        # @!attribute phone_numbers
-        #
-        #   @return [Array<ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::PhoneNumber>]
-        required :phone_numbers,
-                 -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::LegalEntityAssociation::ChildLegalEntity::PhoneNumber] }
-
-        # @!attribute politically_exposed_person
-        #   Whether the individual is a politically exposed person.
-        #
-        #   @return [Boolean, nil]
-        required :politically_exposed_person, ModernTreasury::Internal::Type::Boolean, nil?: true
-
-        # @!attribute preferred_name
-        #   An individual's preferred name.
-        #
-        #   @return [String, nil]
-        required :preferred_name, String, nil?: true
-
-        # @!attribute prefix
-        #   An individual's prefix.
-        #
-        #   @return [String, nil]
-        required :prefix, String, nil?: true
-
-        # @!attribute risk_rating
-        #   The risk rating of the legal entity. One of low, medium, high.
-        #
-        #   @return [Symbol, ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::RiskRating, nil]
-        required :risk_rating,
-                 enum: -> { ModernTreasury::LegalEntityAssociation::ChildLegalEntity::RiskRating },
-                 nil?: true
-
-        # @!attribute suffix
-        #   An individual's suffix.
-        #
-        #   @return [String, nil]
-        required :suffix, String, nil?: true
-
-        # @!attribute updated_at
-        #
-        #   @return [Time]
-        required :updated_at, Time
-
-        # @!attribute wealth_and_employment_details
-        #
-        #   @return [ModernTreasury::Models::LegalEntityWealthEmploymentDetail, nil]
-        required :wealth_and_employment_details,
-                 -> { ModernTreasury::LegalEntityWealthEmploymentDetail },
-                 nil?: true
-
-        # @!attribute website
-        #   The entity's primary website URL.
-        #
-        #   @return [String, nil]
-        required :website, String, nil?: true
-
-        # @!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_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::Models::LegalEntityAssociation::ChildLegalEntity} for more
-        #   details.
-        #
-        #   The child legal entity.
-        #
-        #   @param id [String]
-        #
-        #   @param addresses [Array<ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::Address>] A list of addresses for the entity.
-        #
-        #   @param bank_settings [ModernTreasury::Models::LegalEntityBankSettings, 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::Models::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::Models::LegalEntityAssociation::ChildLegalEntity::Identification>] A list of identifications for the legal entity.
-        #
-        #   @param industry_classifications [Array<ModernTreasury::Models::LegalEntityIndustryClassification>] A list of industry classifications for the legal entity.
-        #
-        #   @param last_name [String, nil] An individual's last name.
-        #
-        #   @param legal_entity_type [Symbol, ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::LegalEntityType] The type of legal entity.
-        #
-        #   @param legal_structure [Symbol, ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::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::Models::LegalEntityAssociation::ChildLegalEntity::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::Models::LegalEntityAssociation::ChildLegalEntity::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::Models::LegalEntityWealthEmploymentDetail, nil]
-        #
-        #   @param website [String, nil] The entity's primary website URL.
-
-        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
-
-        class Identification < 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 expiration_date
-          #   The date when the Identification is no longer considered valid by the issuing
-          #   authority.
-          #
-          #   @return [Date, nil]
-          required :expiration_date, Date, nil?: true
-
-          # @!attribute id_type
-          #   The type of ID number.
-          #
-          #   @return [Symbol, ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::Identification::IDType]
-          required :id_type,
-                   enum: -> { ModernTreasury::LegalEntityAssociation::ChildLegalEntity::Identification::IDType }
-
-          # @!attribute issuing_country
-          #   The ISO 3166-1 alpha-2 country code of the country that issued the
-          #   identification
-          #
-          #   @return [String, nil]
-          required :issuing_country, String, nil?: true
-
-          # @!attribute issuing_region
-          #   The region in which the identifcation was issued.
-          #
-          #   @return [String, nil]
-          required :issuing_region, 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 object
-          #
-          #   @return [String]
-          required :object, String
-
-          # @!attribute updated_at
-          #
-          #   @return [Time]
-          required :updated_at, Time
-
-          # @!method initialize(id:, created_at:, discarded_at:, expiration_date:, id_type:, issuing_country:, issuing_region:, live_mode:, object:, updated_at:)
-          #   Some parameter documentations has been truncated, see
-          #   {ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::Identification}
-          #   for more details.
-          #
-          #   @param id [String]
-          #
-          #   @param created_at [Time]
-          #
-          #   @param discarded_at [Time, nil]
-          #
-          #   @param expiration_date [Date, nil] The date when the Identification is no longer considered valid by the issuing au
-          #
-          #   @param id_type [Symbol, ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity::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 issuing_region [String, nil] The region in which the identifcation was issued.
-          #
-          #   @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::LegalEntityAssociation::ChildLegalEntity::Identification#id_type
-          module IDType
-            extend ModernTreasury::Internal::Type::Enum
-
-            AR_CUIL = :ar_cuil
-            AR_CUIT = :ar_cuit
-            BR_CNPJ = :br_cnpj
-            BR_CPF = :br_cpf
-            CL_RUN = :cl_run
-            CL_RUT = :cl_rut
-            CO_CEDULAS = :co_cedulas
-            CO_NIT = :co_nit
-            DRIVERS_LICENSE = :drivers_license
-            HN_ID = :hn_id
-            HN_RTN = :hn_rtn
-            IN_LEI = :in_lei
-            KR_BRN = :kr_brn
-            KR_CRN = :kr_crn
-            KR_RRN = :kr_rrn
-            PASSPORT = :passport
-            SA_TIN = :sa_tin
-            SA_VAT = :sa_vat
-            US_EIN = :us_ein
-            US_ITIN = :us_itin
-            US_SSN = :us_ssn
-            VN_TIN = :vn_tin
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-        end
-
-        # The type of legal entity.
-        #
-        # @see ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity#legal_entity_type
-        module LegalEntityType
-          extend ModernTreasury::Internal::Type::Enum
-
-          BUSINESS = :business
-          INDIVIDUAL = :individual
-          JOINT = :joint
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        # The business's legal structure.
-        #
-        # @see ModernTreasury::Models::LegalEntityAssociation::ChildLegalEntity#legal_structure
-        module LegalStructure
-          extend ModernTreasury::Internal::Type::Enum
-
-          CORPORATION = :corporation
-          LLC = :llc
-          NON_PROFIT = :non_profit
-          PARTNERSHIP = :partnership
-          SOLE_PROPRIETORSHIP = :sole_proprietorship
-          TRUST = :trust
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-
-        class PhoneNumber < ModernTreasury::Internal::Type::BaseModel
-          # @!attribute phone_number
-          #
-          #   @return [String, nil]
-          optional :phone_number, String
-
-          # @!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::LegalEntityAssociation::ChildLegalEntity#risk_rating
-        module RiskRating
-          extend ModernTreasury::Internal::Type::Enum
-
-          LOW = :low
-          MEDIUM = :medium
-          HIGH = :high
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-
       # A list of relationship types for how the child entity relates to parent entity.
       module RelationshipType
         extend ModernTreasury::Internal::Type::Enum

data/lib/modern_treasury/models/legal_entity_association_inline_create.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LegalEntityAssociationInlineCreate < ModernTreasury::Internal::Type::BaseModel
+      # @!attribute relationship_types
+      #
+      #   @return [Array<Symbol, ModernTreasury::Models::LegalEntityAssociationInlineCreate::RelationshipType>]
+      required :relationship_types,
+               -> { ModernTreasury::Internal::Type::ArrayOf[enum: ModernTreasury::LegalEntityAssociationInlineCreate::RelationshipType] }
+
+      # @!attribute child_legal_entity
+      #   The child legal entity.
+      #
+      #   @return [ModernTreasury::Models::ChildLegalEntityCreate, nil]
+      optional :child_legal_entity, -> { ModernTreasury::ChildLegalEntityCreate }
+
+      # @!attribute child_legal_entity_id
+      #   The ID of the child legal entity.
+      #
+      #   @return [String, nil]
+      optional :child_legal_entity_id, String
+
+      # @!attribute ownership_percentage
+      #   The child entity's ownership percentage iff they are a beneficial owner.
+      #
+      #   @return [Integer, nil]
+      optional :ownership_percentage, Integer, nil?: true
+
+      # @!attribute title
+      #   The job title of the child entity at the parent entity.
+      #
+      #   @return [String, nil]
+      optional :title, String, nil?: true
+
+      # @!method initialize(relationship_types:, child_legal_entity: nil, child_legal_entity_id: nil, ownership_percentage: nil, title: nil)
+      #   @param relationship_types [Array<Symbol, ModernTreasury::Models::LegalEntityAssociationInlineCreate::RelationshipType>]
+      #
+      #   @param child_legal_entity [ModernTreasury::Models::ChildLegalEntityCreate] The child legal entity.
+      #
+      #   @param child_legal_entity_id [String] The ID of the child legal entity.
+      #
+      #   @param ownership_percentage [Integer, nil] The child entity's ownership percentage iff they are a beneficial owner.
+      #
+      #   @param title [String, nil] The job title of the child entity at the parent entity.
+
+      # A list of relationship types for how the child entity relates to parent entity.
+      module RelationshipType
+        extend ModernTreasury::Internal::Type::Enum
+
+        AUTHORIZED_SIGNER = :authorized_signer
+        BENEFICIAL_OWNER = :beneficial_owner
+        CONTROL_PERSON = :control_person
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end