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

data/lib/modern_treasury/models/ledger_transactions/version_list_params.rb

@@ -3,10 +3,11 @@
 module ModernTreasury
   module Models
     module LedgerTransactions
-      class VersionListParams < ModernTreasury::BaseModel
+      # @see ModernTreasury::Resources::LedgerTransactions::Versions#list
+      class VersionListParams < ModernTreasury::Internal::Type::BaseModel
         # @!parse
-        #   extend ModernTreasury::RequestParameters::Converter
-        include ModernTreasury::RequestParameters
+        #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+        include ModernTreasury::Internal::Type::RequestParameters
 
         # @!attribute after_cursor
         #
@@ -15,11 +16,11 @@ module ModernTreasury
 
         # @!attribute [r] created_at
         #   Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
-        #     created_at timestamp. For example, for all dates after Jan 1 2000 12:00 UTC, use
-        #     created_at%5Bgt%5D=2000-01-01T12:00:00Z.
+        #   created_at timestamp. For example, for all dates after Jan 1 2000 12:00 UTC, use
+        #   created_at%5Bgt%5D=2000-01-01T12:00:00Z.
         #
         #   @return [Hash{Symbol=>Time}, nil]
-        optional :created_at, ModernTreasury::HashOf[Time]
+        optional :created_at, ModernTreasury::Internal::Type::HashOf[Time]
 
         # @!parse
         #   # @return [Hash{Symbol=>Time}]
@@ -27,7 +28,7 @@ module ModernTreasury
 
         # @!attribute [r] ledger_account_statement_id
         #   Get all ledger transaction versions that are included in the ledger account
-        #     statement.
+        #   statement.
         #
         #   @return [String, nil]
         optional :ledger_account_statement_id, String
@@ -38,7 +39,7 @@ module ModernTreasury
 
         # @!attribute [r] ledger_transaction_id
         #   Get all the ledger transaction versions corresponding to the ID of a ledger
-        #     transaction.
+        #   transaction.
         #
         #   @return [String, nil]
         optional :ledger_transaction_id, String
@@ -58,10 +59,10 @@ module ModernTreasury
 
         # @!attribute [r] version
         #   Use `gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the
-        #     version. For example, for all versions after 2, use version%5Bgt%5D=2.
+        #   version. For example, for all versions after 2, use version%5Bgt%5D=2.
         #
         #   @return [Hash{Symbol=>Integer}, nil]
-        optional :version, ModernTreasury::HashOf[Integer]
+        optional :version, ModernTreasury::Internal::Type::HashOf[Integer]
 
         # @!parse
         #   # @return [Hash{Symbol=>Integer}]
@@ -89,7 +90,7 @@ module ModernTreasury
         #     super
         #   end
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
       end
     end
   end

data/lib/modern_treasury/models/ledger_update_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class LedgerUpdateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Ledgers#update
+    class LedgerUpdateParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute description
       #   An optional free-form description for internal use.
@@ -15,10 +16,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}]
@@ -42,7 +43,7 @@ module ModernTreasury
       #   #
       #   def initialize(description: nil, metadata: nil, name: nil, request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/modern_treasury/models/ledgerable_event.rb

@@ -2,7 +2,10 @@
 
 module ModernTreasury
   module Models
-    class LedgerableEvent < ModernTreasury::BaseModel
+    # @deprecated
+    #
+    # @see ModernTreasury::Resources::LedgerableEvents#create
+    class LedgerableEvent < ModernTreasury::Internal::Type::BaseModel
       # @!attribute id
       #
       #   @return [String]
@@ -17,7 +20,7 @@ module ModernTreasury
       #   Additionally data to be used by the Ledger Event Handler.
       #
       #   @return [Object, nil]
-      required :custom_data, ModernTreasury::Unknown, nil?: true
+      required :custom_data, ModernTreasury::Internal::Type::Unknown, nil?: true
 
       # @!attribute description
       #   Description of the ledgerable event.
@@ -33,17 +36,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}, nil]
-      required :metadata, ModernTreasury::HashOf[String], nil?: true
+      required :metadata, ModernTreasury::Internal::Type::HashOf[String], nil?: true
 
       # @!attribute name
       #   Name of the ledgerable event.
@@ -89,7 +92,7 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/modern_treasury/models/ledgerable_event_create_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class LedgerableEventCreateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::LedgerableEvents#create
+    class LedgerableEventCreateParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute name
       #   Name of the ledgerable event.
@@ -17,7 +18,7 @@ module ModernTreasury
       #   Additionally data to be used by the Ledger Event Handler.
       #
       #   @return [Object, nil]
-      optional :custom_data, ModernTreasury::Unknown, nil?: true
+      optional :custom_data, ModernTreasury::Internal::Type::Unknown, nil?: true
 
       # @!attribute description
       #   Description of the ledgerable event.
@@ -27,10 +28,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}]
@@ -45,7 +46,7 @@ module ModernTreasury
       #   #
       #   def initialize(name:, custom_data: nil, description: nil, metadata: nil, request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/modern_treasury/models/ledgerable_event_retrieve_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class LedgerableEventRetrieveParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::LedgerableEvents#retrieve
+    class LedgerableEventRetrieveParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!parse
       #   # @param request_options [ModernTreasury::RequestOptions, Hash{Symbol=>Object}]
       #   #
       #   def initialize(request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
     end
   end
 end

data/lib/modern_treasury/models/legal_entity.rb

@@ -2,7 +2,8 @@
 
 module ModernTreasury
   module Models
-    class LegalEntity < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::LegalEntities#create
+    class LegalEntity < ModernTreasury::Internal::Type::BaseModel
       # @!attribute id
       #
       #   @return [String]
@@ -12,7 +13,8 @@ module ModernTreasury
       #   A list of addresses for the entity.
       #
       #   @return [Array<ModernTreasury::Models::LegalEntity::Address>]
-      required :addresses, -> { ModernTreasury::ArrayOf[ModernTreasury::Models::LegalEntity::Address] }
+      required :addresses,
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::LegalEntity::Address] }
 
       # @!attribute bank_settings
       #
@@ -31,6 +33,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]
@@ -56,7 +63,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.
@@ -75,7 +82,14 @@ module ModernTreasury
       #
       #   @return [Array<ModernTreasury::Models::LegalEntity::Identification>]
       required :identifications,
-               -> { ModernTreasury::ArrayOf[ModernTreasury::Models::LegalEntity::Identification] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::LegalEntity::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.
@@ -88,7 +102,7 @@ module ModernTreasury
       #
       #   @return [Array<ModernTreasury::Models::LegalEntityAssociation>, nil]
       required :legal_entity_associations,
-               -> { ModernTreasury::ArrayOf[ModernTreasury::Models::LegalEntityAssociation] },
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::LegalEntityAssociation] },
                nil?: true
 
       # @!attribute legal_entity_type
@@ -105,17 +119,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.
@@ -131,13 +145,14 @@ module ModernTreasury
       # @!attribute phone_numbers
       #
       #   @return [Array<ModernTreasury::Models::LegalEntity::PhoneNumber>]
-      required :phone_numbers, -> { ModernTreasury::ArrayOf[ModernTreasury::Models::LegalEntity::PhoneNumber] }
+      required :phone_numbers,
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::LegalEntity::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.
@@ -187,6 +202,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]
@@ -195,6 +211,7 @@ module ModernTreasury
       #   # @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]
@@ -219,6 +236,7 @@ module ModernTreasury
       #     bank_settings:,
       #     business_name:,
       #     citizenship_country:,
+      #     compliance_details:,
       #     created_at:,
       #     date_formed:,
       #     date_of_birth:,
@@ -227,6 +245,7 @@ module ModernTreasury
       #     email:,
       #     first_name:,
       #     identifications:,
+      #     industry_classifications:,
       #     last_name:,
       #     legal_entity_associations:,
       #     legal_entity_type:,
@@ -249,9 +268,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]
@@ -262,7 +281,7 @@ module ModernTreasury
         #
         #   @return [Array<Symbol, ModernTreasury::Models::LegalEntity::Address::AddressType>]
         required :address_types,
-                 -> { ModernTreasury::ArrayOf[enum: ModernTreasury::Models::LegalEntity::Address::AddressType] }
+                 -> { ModernTreasury::Internal::Type::ArrayOf[enum: ModernTreasury::Models::LegalEntity::Address::AddressType] }
 
         # @!attribute country
         #   Country code conforms to [ISO 3166-1 alpha-2]
@@ -292,10 +311,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.
@@ -359,26 +378,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
@@ -389,12 +393,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]
@@ -418,17 +421,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
         #
@@ -452,30 +455,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::LegalEntity::Identification#id_type
+        module IDType
+          extend ModernTreasury::Internal::Type::Enum
+
           AR_CUIL = :ar_cuil
           AR_CUIT = :ar_cuit
           BR_CNPJ = :br_cnpj
@@ -502,27 +489,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::LegalEntity#legal_entity_type
+      module LegalEntityType
+        extend ModernTreasury::Internal::Type::Enum
+
         BUSINESS = :business
         INDIVIDUAL = :individual
         JOINT = :joint
@@ -531,32 +507,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::LegalEntity#legal_structure
+      module LegalStructure
+        extend ModernTreasury::Internal::Type::Enum
+
         CORPORATION = :corporation
         LLC = :llc
         NON_PROFIT = :non_profit
@@ -568,11 +527,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]
@@ -589,25 +547,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::LegalEntity#risk_rating
+      module RiskRating
+        extend ModernTreasury::Internal::Type::Enum
+
         LOW = :low
         MEDIUM = :medium
         HIGH = :high
@@ -616,7 +564,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end