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

data/lib/modern_treasury/models/legal_entity_industry_classification.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module ModernTreasury
+  module Models
+    class LegalEntityIndustryClassification < ModernTreasury::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute classification_codes
+      #   The industry classification codes for the legal entity.
+      #
+      #   @return [Array<String>]
+      required :classification_codes, ModernTreasury::Internal::Type::ArrayOf[String]
+
+      # @!attribute classification_type
+      #   The classification system of the classification codes.
+      #
+      #   @return [Symbol, ModernTreasury::Models::LegalEntityIndustryClassification::ClassificationType]
+      required :classification_type,
+               enum: -> { ModernTreasury::Models::LegalEntityIndustryClassification::ClassificationType }
+
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute discarded_at
+      #
+      #   @return [Time, nil]
+      required :discarded_at, Time, 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
+
+      # @!parse
+      #   # @param id [String]
+      #   # @param classification_codes [Array<String>]
+      #   # @param classification_type [Symbol, ModernTreasury::Models::LegalEntityIndustryClassification::ClassificationType]
+      #   # @param created_at [Time]
+      #   # @param discarded_at [Time, nil]
+      #   # @param live_mode [Boolean]
+      #   # @param object [String]
+      #   # @param updated_at [Time]
+      #   #
+      #   def initialize(
+      #     id:,
+      #     classification_codes:,
+      #     classification_type:,
+      #     created_at:,
+      #     discarded_at:,
+      #     live_mode:,
+      #     object:,
+      #     updated_at:,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+
+      # The classification system of the classification codes.
+      #
+      # @see ModernTreasury::Models::LegalEntityIndustryClassification#classification_type
+      module ClassificationType
+        extend ModernTreasury::Internal::Type::Enum
+
+        ANZSIC = :anzsic
+        BICS = :bics
+        GICS = :gics
+        HSICS = :hsics
+        ICB = :icb
+        ISIC = :isic
+        MGECS = :mgecs
+        NACE = :nace
+        NAICS = :naics
+        RBICS = :rbics
+        SIC = :sic
+        SNI = :sni
+        TRBC = :trbc
+        UKSIC = :uksic
+        UNSPSC = :unspsc
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/modern_treasury/models/legal_entity_list_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class LegalEntityListParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::LegalEntities#list
+    class LegalEntityListParams < 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
       #
@@ -23,11 +24,11 @@ module ModernTreasury
 
       # @!attribute [r] metadata
       #   For example, if you want to query for records with metadata key `Type` and value
-      #     `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
-      #     parameters.
+      #   `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
+      #   parameters.
       #
       #   @return [Hash{Symbol=>String}, nil]
-      optional :metadata, ModernTreasury::HashOf[String]
+      optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
       # @!parse
       #   # @return [Hash{Symbol=>String}]
@@ -71,20 +72,11 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+
+      module LegalEntityType
+        extend ModernTreasury::Internal::Type::Enum
 
-      # @abstract
-      #
-      # @example
-      # ```ruby
-      # case legal_entity_type
-      # in :business
-      #   # ...
-      # in :individual
-      #   # ...
-      # end
-      # ```
-      class LegalEntityType < ModernTreasury::Enum
         BUSINESS = :business
         INDIVIDUAL = :individual
 
@@ -92,7 +84,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/legal_entity_retrieve_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class LegalEntityRetrieveParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::LegalEntities#retrieve
+    class LegalEntityRetrieveParams < 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_update_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class LegalEntityUpdateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::LegalEntities#update
+    class LegalEntityUpdateParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute [r] addresses
       #   A list of addresses for the entity.
       #
       #   @return [Array<ModernTreasury::Models::LegalEntityUpdateParams::Address>, nil]
       optional :addresses,
-               -> { ModernTreasury::ArrayOf[ModernTreasury::Models::LegalEntityUpdateParams::Address] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::LegalEntityUpdateParams::Address] }
 
       # @!parse
       #   # @return [Array<ModernTreasury::Models::LegalEntityUpdateParams::Address>]
@@ -35,6 +36,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).
       #
@@ -50,7 +56,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>]
@@ -73,12 +79,23 @@ module ModernTreasury
       #
       #   @return [Array<ModernTreasury::Models::LegalEntityUpdateParams::Identification>, nil]
       optional :identifications,
-               -> { ModernTreasury::ArrayOf[ModernTreasury::Models::LegalEntityUpdateParams::Identification] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::LegalEntityUpdateParams::Identification] }
 
       # @!parse
       #   # @return [Array<ModernTreasury::Models::LegalEntityUpdateParams::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.
       #
@@ -95,10 +112,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}]
@@ -114,7 +131,7 @@ module ModernTreasury
       #
       #   @return [Array<ModernTreasury::Models::LegalEntityUpdateParams::PhoneNumber>, nil]
       optional :phone_numbers,
-               -> { ModernTreasury::ArrayOf[ModernTreasury::Models::LegalEntityUpdateParams::PhoneNumber] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::LegalEntityUpdateParams::PhoneNumber] }
 
       # @!parse
       #   # @return [Array<ModernTreasury::Models::LegalEntityUpdateParams::PhoneNumber>]
@@ -124,7 +141,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.
@@ -170,12 +187,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::LegalEntityUpdateParams::Identification>]
+      #   # @param industry_classifications [Array<ModernTreasury::Models::LegalEntityIndustryClassification>]
       #   # @param last_name [String, nil]
       #   # @param legal_structure [Symbol, ModernTreasury::Models::LegalEntityUpdateParams::LegalStructure, nil]
       #   # @param metadata [Hash{Symbol=>String}]
@@ -195,12 +214,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_structure: nil,
       #     metadata: nil,
@@ -219,9 +240,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]
         #
@@ -256,7 +277,7 @@ module ModernTreasury
         #
         #   @return [Array<Symbol, ModernTreasury::Models::LegalEntityUpdateParams::Address::AddressType>, nil]
         optional :address_types,
-                 -> { ModernTreasury::ArrayOf[enum: ModernTreasury::Models::LegalEntityUpdateParams::Address::AddressType] }
+                 -> { ModernTreasury::Internal::Type::ArrayOf[enum: ModernTreasury::Models::LegalEntityUpdateParams::Address::AddressType] }
 
         # @!parse
         #   # @return [Array<Symbol, ModernTreasury::Models::LegalEntityUpdateParams::Address::AddressType>]
@@ -278,26 +299,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
@@ -308,12 +314,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.
         #
@@ -328,7 +333,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
@@ -340,30 +345,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::LegalEntityUpdateParams::Identification#id_type
+        module IDType
+          extend ModernTreasury::Internal::Type::Enum
+
           AR_CUIL = :ar_cuil
           AR_CUIT = :ar_cuit
           BR_CNPJ = :br_cnpj
@@ -390,33 +379,14 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         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
+      module LegalStructure
+        extend ModernTreasury::Internal::Type::Enum
+
         CORPORATION = :corporation
         LLC = :llc
         NON_PROFIT = :non_profit
@@ -428,11 +398,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]
@@ -449,25 +418,13 @@ 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
+      module RiskRating
+        extend ModernTreasury::Internal::Type::Enum
+
         LOW = :low
         MEDIUM = :medium
         HIGH = :high
@@ -476,7 +433,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/line_item.rb

@@ -2,7 +2,8 @@
 
 module ModernTreasury
   module Models
-    class LineItem < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::LineItems#retrieve
+    class LineItem < ModernTreasury::Internal::Type::BaseModel
       # @!attribute id
       #
       #   @return [String]
@@ -15,22 +16,22 @@ module ModernTreasury
 
       # @!attribute accounting_category_id
       #   The ID of one of your accounting categories. Note that these will only be
-      #     accessible if your accounting system has been connected.
+      #   accessible if your accounting system has been connected.
       #
       #   @return [String, nil]
       required :accounting_category_id, String, nil?: true
 
       # @!attribute accounting_ledger_class_id
       #   The ID of one of the class objects in your accounting system. Class objects
-      #     track segments of your business independent of client or project. Note that
-      #     these will only be accessible if your accounting system has been connected.
+      #   track segments of your business independent of client or project. Note that
+      #   these will only be accessible if your accounting system has been connected.
       #
       #   @return [String, nil]
       required :accounting_ledger_class_id, String, nil?: true
 
       # @!attribute amount
       #   Value in specified currency's smallest unit. e.g. $10 would be represented
-      #     as 1000.
+      #   as 1000.
       #
       #   @return [Integer]
       required :amount, Integer
@@ -60,17 +61,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 object
       #
@@ -116,20 +117,21 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      class Accounting < ModernTreasury::BaseModel
+      # @see ModernTreasury::Models::LineItem#accounting
+      class Accounting < ModernTreasury::Internal::Type::BaseModel
         # @!attribute account_id
         #   The ID of one of your accounting categories. Note that these will only be
-        #     accessible if your accounting system has been connected.
+        #   accessible if your accounting system has been connected.
         #
         #   @return [String, nil]
         optional :account_id, String, nil?: true
 
         # @!attribute class_id
         #   The ID of one of the class objects in your accounting system. Class objects
-        #     track segments of your business independent of client or project. Note that
-        #     these will only be accessible if your accounting system has been connected.
+        #   track segments of your business independent of client or project. Note that
+        #   these will only be accessible if your accounting system has been connected.
         #
         #   @return [String, nil]
         optional :class_id, String, nil?: true
@@ -140,23 +142,15 @@ module ModernTreasury
         #   #
         #   def initialize(account_id: nil, class_id: nil, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
       end
 
-      # @abstract
-      #
       # One of `payment_orders` or `expected_payments`.
       #
-      # @example
-      # ```ruby
-      # case itemizable_type
-      # in :ExpectedPayment
-      #   # ...
-      # in :PaymentOrder
-      #   # ...
-      # end
-      # ```
-      class ItemizableType < ModernTreasury::Enum
+      # @see ModernTreasury::Models::LineItem#itemizable_type
+      module ItemizableType
+        extend ModernTreasury::Internal::Type::Enum
+
         EXPECTED_PAYMENT = :ExpectedPayment
         PAYMENT_ORDER = :PaymentOrder
 
@@ -164,7 +158,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/line_item_list_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class LineItemListParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::LineItems#list
+    class LineItemListParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute itemizable_type
       #
@@ -34,20 +35,11 @@ module ModernTreasury
       #   #
       #   def initialize(itemizable_type:, after_cursor: nil, per_page: nil, request_options: {}, **) = super
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
+
+      module ItemizableType
+        extend ModernTreasury::Internal::Type::Enum
 
-      # @abstract
-      #
-      # @example
-      # ```ruby
-      # case itemizable_type
-      # in :expected_payments
-      #   # ...
-      # in :payment_orders
-      #   # ...
-      # end
-      # ```
-      class ItemizableType < ModernTreasury::Enum
         EXPECTED_PAYMENTS = :expected_payments
         PAYMENT_ORDERS = :payment_orders
 
@@ -55,7 +47,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end