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

data/lib/modern_treasury/models/internal_account.rb

@@ -2,7 +2,8 @@
 
 module ModernTreasury
   module Models
-    class InternalAccount < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::InternalAccounts#create
+    class InternalAccount < ModernTreasury::Internal::Type::BaseModel
       # @!attribute id
       #
       #   @return [String]
@@ -12,7 +13,8 @@ module ModernTreasury
       #   An array of account detail objects.
       #
       #   @return [Array<ModernTreasury::Models::AccountDetail>]
-      required :account_details, -> { ModernTreasury::ArrayOf[ModernTreasury::Models::AccountDetail] }
+      required :account_details,
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::AccountDetail] }
 
       # @!attribute account_type
       #   Can be checking, savings or other.
@@ -45,7 +47,7 @@ module ModernTreasury
 
       # @!attribute ledger_account_id
       #   If the internal account links to a ledger account in Modern Treasury, the id of
-      #     the ledger account will be populated here.
+      #   the ledger account will be populated here.
       #
       #   @return [String, nil]
       required :ledger_account_id, String, nil?: true
@@ -58,17 +60,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 name
       #   A nickname for the account.
@@ -109,7 +111,8 @@ module ModernTreasury
       #   An array of routing detail objects.
       #
       #   @return [Array<ModernTreasury::Models::RoutingDetail>]
-      required :routing_details, -> { ModernTreasury::ArrayOf[ModernTreasury::Models::RoutingDetail] }
+      required :routing_details,
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::RoutingDetail] }
 
       # @!attribute updated_at
       #
@@ -162,30 +165,14 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      # @abstract
-      #
       # Can be checking, savings or other.
       #
-      # @example
-      # ```ruby
-      # case account_type
-      # in :cash
-      #   # ...
-      # in :checking
-      #   # ...
-      # in :general_ledger
-      #   # ...
-      # in :loan
-      #   # ...
-      # in :non_resident
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class AccountType < ModernTreasury::Enum
+      # @see ModernTreasury::Models::InternalAccount#account_type
+      module AccountType
+        extend ModernTreasury::Internal::Type::Enum
+
         CASH = :cash
         CHECKING = :checking
         GENERAL_LEDGER = :general_ledger
@@ -199,11 +186,11 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      class PartyAddress < ModernTreasury::BaseModel
+      # @see ModernTreasury::Models::InternalAccount#party_address
+      class PartyAddress < ModernTreasury::Internal::Type::BaseModel
         # @!attribute id
         #
         #   @return [String]
@@ -232,10 +219,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.
@@ -297,23 +284,15 @@ module ModernTreasury
         #     super
         #   end
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
       end
 
-      # @abstract
-      #
       # Either individual or business.
       #
-      # @example
-      # ```ruby
-      # case party_type
-      # in :business
-      #   # ...
-      # in :individual
-      #   # ...
-      # end
-      # ```
-      class PartyType < ModernTreasury::Enum
+      # @see ModernTreasury::Models::InternalAccount#party_type
+      module PartyType
+        extend ModernTreasury::Internal::Type::Enum
+
         BUSINESS = :business
         INDIVIDUAL = :individual
 
@@ -321,7 +300,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/internal_account_create_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class InternalAccountCreateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::InternalAccounts#create
+    class InternalAccountCreateParams < ModernTreasury::Internal::Type::BaseModel
       # @!parse
-      #   extend ModernTreasury::RequestParameters::Converter
-      include ModernTreasury::RequestParameters
+      #   extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
 
       # @!attribute connection_id
       #   The identifier of the financial institution the account belongs to.
@@ -15,7 +16,7 @@ module ModernTreasury
 
       # @!attribute currency
       #   Either "USD" or "CAD". Internal accounts created at Increase only supports
-      #     "USD".
+      #   "USD".
       #
       #   @return [Symbol, ModernTreasury::Models::InternalAccountCreateParams::Currency]
       required :currency, enum: -> { ModernTreasury::Models::InternalAccountCreateParams::Currency }
@@ -74,10 +75,10 @@ module ModernTreasury
 
       # @!attribute [r] vendor_attributes
       #   A hash of vendor specific attributes that will be used when creating the account
-      #     at the vendor specified by the given connection.
+      #   at the vendor specified by the given connection.
       #
       #   @return [Hash{Symbol=>String}, nil]
-      optional :vendor_attributes, ModernTreasury::HashOf[String]
+      optional :vendor_attributes, ModernTreasury::Internal::Type::HashOf[String]
 
       # @!parse
       #   # @return [Hash{Symbol=>String}]
@@ -111,23 +112,13 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      # @abstract
-      #
       # Either "USD" or "CAD". Internal accounts created at Increase only supports
-      #   "USD".
-      #
-      # @example
-      # ```ruby
-      # case currency
-      # in :USD
-      #   # ...
-      # in :CAD
-      #   # ...
-      # end
-      # ```
-      class Currency < ModernTreasury::Enum
+      # "USD".
+      module Currency
+        extend ModernTreasury::Internal::Type::Enum
+
         USD = :USD
         CAD = :CAD
 
@@ -135,11 +126,10 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      class PartyAddress < ModernTreasury::BaseModel
+      class PartyAddress < ModernTreasury::Internal::Type::BaseModel
         # @!attribute country
         #   Country code conforms to [ISO 3166-1 alpha-2]
         #
@@ -190,7 +180,7 @@ module ModernTreasury
         #   #
         #   def initialize(country:, line1:, locality:, postal_code:, region:, line2: nil, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
       end
     end
   end

data/lib/modern_treasury/models/internal_account_list_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class InternalAccountListParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::InternalAccounts#list
+    class InternalAccountListParams < 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
       #
@@ -44,11 +45,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}]
@@ -109,30 +110,12 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      # @abstract
-      #
       # Only return internal accounts that can make this type of payment.
-      #
-      # @example
-      # ```ruby
-      # case payment_type
-      # in :ach
-      #   # ...
-      # in :au_becs
-      #   # ...
-      # in :bacs
-      #   # ...
-      # in :book
-      #   # ...
-      # in :card
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class PaymentType < ModernTreasury::Enum
+      module PaymentType
+        extend ModernTreasury::Internal::Type::Enum
+
         ACH = :ach
         AU_BECS = :au_becs
         BACS = :bacs
@@ -168,7 +151,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/internal_account_retrieve_params.rb

@@ -2,17 +2,18 @@
 
 module ModernTreasury
   module Models
-    class InternalAccountRetrieveParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::InternalAccounts#retrieve
+    class InternalAccountRetrieveParams < 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/internal_account_update_params.rb

@@ -2,10 +2,11 @@
 
 module ModernTreasury
   module Models
-    class InternalAccountUpdateParams < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::InternalAccounts#update
+    class InternalAccountUpdateParams < 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] counterparty_id
       #   The Counterparty associated to this account.
@@ -29,10 +30,10 @@ module ModernTreasury
 
       # @!attribute [r] metadata
       #   Additional data in the form of key-value pairs. Pairs can be removed by passing
-      #     an empty string or `null` as the value.
+      #   an empty string or `null` as the value.
       #
       #   @return [Hash{Symbol=>String}, nil]
-      optional :metadata, ModernTreasury::HashOf[String]
+      optional :metadata, ModernTreasury::Internal::Type::HashOf[String]
 
       # @!parse
       #   # @return [Hash{Symbol=>String}]
@@ -78,7 +79,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/internal_accounts/balance_report.rb

@@ -3,7 +3,8 @@
 module ModernTreasury
   module Models
     module InternalAccounts
-      class BalanceReport < ModernTreasury::BaseModel
+      # @see ModernTreasury::Resources::InternalAccounts::BalanceReports#create
+      class BalanceReport < ModernTreasury::Internal::Type::BaseModel
         # @!attribute id
         #
         #   @return [String]
@@ -18,12 +19,12 @@ module ModernTreasury
         # @!attribute as_of_time
         #   The time (24-hour clock) of the balance report in local time.
         #
-        #   @return [String, nil]
-        required :as_of_time, String, nil?: true
+        #   @return [Time, nil]
+        required :as_of_time, Time, nil?: true
 
         # @!attribute balance_report_type
         #   The specific type of balance report. One of `intraday`, `previous_day`,
-        #     `real_time`, or `other`.
+        #   `real_time`, or `other`.
         #
         #   @return [Symbol, ModernTreasury::Models::InternalAccounts::BalanceReport::BalanceReportType]
         required :balance_report_type,
@@ -34,7 +35,7 @@ module ModernTreasury
         #
         #   @return [Array<ModernTreasury::Models::InternalAccounts::BalanceReport::Balance>]
         required :balances,
-                 -> { ModernTreasury::ArrayOf[ModernTreasury::Models::InternalAccounts::BalanceReport::Balance] }
+                 -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::InternalAccounts::BalanceReport::Balance] }
 
         # @!attribute created_at
         #
@@ -49,10 +50,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
         #
@@ -67,7 +68,7 @@ module ModernTreasury
         # @!parse
         #   # @param id [String]
         #   # @param as_of_date [Date]
-        #   # @param as_of_time [String, nil]
+        #   # @param as_of_time [Time, nil]
         #   # @param balance_report_type [Symbol, ModernTreasury::Models::InternalAccounts::BalanceReport::BalanceReportType]
         #   # @param balances [Array<ModernTreasury::Models::InternalAccounts::BalanceReport::Balance>]
         #   # @param created_at [Time]
@@ -92,27 +93,15 @@ module ModernTreasury
         #     super
         #   end
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-        # @abstract
-        #
         # The specific type of balance report. One of `intraday`, `previous_day`,
-        #   `real_time`, or `other`.
+        # `real_time`, or `other`.
         #
-        # @example
-        # ```ruby
-        # case balance_report_type
-        # in :intraday
-        #   # ...
-        # in :other
-        #   # ...
-        # in :previous_day
-        #   # ...
-        # in :real_time
-        #   # ...
-        # end
-        # ```
-        class BalanceReportType < ModernTreasury::Enum
+        # @see ModernTreasury::Models::InternalAccounts::BalanceReport#balance_report_type
+        module BalanceReportType
+          extend ModernTreasury::Internal::Type::Enum
+
           INTRADAY = :intraday
           OTHER = :other
           PREVIOUS_DAY = :previous_day
@@ -122,11 +111,10 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
 
-        class Balance < ModernTreasury::BaseModel
+        class Balance < ModernTreasury::Internal::Type::BaseModel
           # @!attribute id
           #
           #   @return [String]
@@ -147,14 +135,14 @@ module ModernTreasury
           # @!attribute as_of_time
           #   The time on which the balance became true for the account.
           #
-          #   @return [String, nil]
-          required :as_of_time, String, nil?: true
+          #   @return [Time, nil]
+          required :as_of_time, Time, nil?: true
 
           # @!attribute balance_type
           #   The specific type of balance reported. One of `opening_ledger`,
-          #     `closing_ledger`, `current_ledger`, `opening_available`,
-          #     `opening_available_next_business_day`, `closing_available`, `current_available`,
-          #     'previously_closed_book', or `other`.
+          #   `closing_ledger`, `current_ledger`, `opening_available`,
+          #   `opening_available_next_business_day`, `closing_available`, `current_available`,
+          #   'previously_closed_book', or `other`.
           #
           #   @return [Symbol, ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType]
           required :balance_type,
@@ -173,10 +161,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
           #
@@ -202,9 +190,9 @@ module ModernTreasury
 
           # @!attribute vendor_code_type
           #   The type of `vendor_code` being reported. Can be one of `bai2`, `bankprov`,
-          #     `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`,
-          #     `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `signet`, `silvergate`,
-          #     `swift`, or `us_bank`.
+          #   `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`,
+          #   `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `signet`, `silvergate`,
+          #   `swift`, or `us_bank`.
           #
           #   @return [String, nil]
           required :vendor_code_type, String, nil?: true
@@ -213,7 +201,7 @@ module ModernTreasury
           #   # @param id [String]
           #   # @param amount [Integer]
           #   # @param as_of_date [Date, nil]
-          #   # @param as_of_time [String, nil]
+          #   # @param as_of_time [Time, nil]
           #   # @param balance_type [Symbol, ModernTreasury::Models::InternalAccounts::BalanceReport::Balance::BalanceType]
           #   # @param created_at [Time]
           #   # @param currency [Symbol, ModernTreasury::Models::Currency]
@@ -243,33 +231,17 @@ module ModernTreasury
           #     super
           #   end
 
-          # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+          # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-          # @abstract
-          #
           # The specific type of balance reported. One of `opening_ledger`,
-          #   `closing_ledger`, `current_ledger`, `opening_available`,
-          #   `opening_available_next_business_day`, `closing_available`, `current_available`,
-          #   'previously_closed_book', or `other`.
+          # `closing_ledger`, `current_ledger`, `opening_available`,
+          # `opening_available_next_business_day`, `closing_available`, `current_available`,
+          # 'previously_closed_book', or `other`.
           #
-          # @example
-          # ```ruby
-          # case balance_type
-          # in :closing_available
-          #   # ...
-          # in :closing_ledger
-          #   # ...
-          # in :current_available
-          #   # ...
-          # in :current_ledger
-          #   # ...
-          # in :opening_available
-          #   # ...
-          # in ...
-          #   #...
-          # end
-          # ```
-          class BalanceType < ModernTreasury::Enum
+          # @see ModernTreasury::Models::InternalAccounts::BalanceReport::Balance#balance_type
+          module BalanceType
+            extend ModernTreasury::Internal::Type::Enum
+
             CLOSING_AVAILABLE = :closing_available
             CLOSING_LEDGER = :closing_ledger
             CURRENT_AVAILABLE = :current_available
@@ -284,7 +256,6 @@ module ModernTreasury
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end