modern_treasury 0.1.0.pre.alpha.15 → 0.1.0.pre.alpha.16

data/lib/modern_treasury/models/transaction.rb

@@ -25,8 +25,8 @@ module ModernTreasury
       #   The time on which the transaction occurred. Depending on the granularity of the
       #     timestamp information received from the bank, it may be `null`.
       #
-      #   @return [String, nil]
-      required :as_of_time, String, nil?: true
+      #   @return [Time, nil]
+      required :as_of_time, Time, nil?: true
 
       # @!attribute as_of_timezone
       #   The timezone in which the `as_of_time` is represented. Can be `null` if the bank
@@ -178,7 +178,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 as_of_timezone [String, nil]
       #   # @param created_at [Time]
       #   # @param currency [Symbol, ModernTreasury::Models::Currency]
@@ -297,29 +297,11 @@ module ModernTreasury
         # def initialize: (Hash | ModernTreasury::BaseModel) -> void
       end
 
-      # @abstract
-      #
       # The type of the transaction. Examples could be
       #   `card, `ach`, `wire`, `check`, `rtp`, `book`, or `sen`.
-      #
-      # @example
-      # ```ruby
-      # case type
-      # in :ach
-      #   # ...
-      # in :au_becs
-      #   # ...
-      # in :bacs
-      #   # ...
-      # in :book
-      #   # ...
-      # in :card
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class Type < ModernTreasury::Enum
+      module Type
+        extend ModernTreasury::Enum
+
         ACH = :ach
         AU_BECS = :au_becs
         BACS = :bacs
@@ -356,35 +338,16 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # 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`, `us_bank`, or others.
-      #
-      # @example
-      # ```ruby
-      # case vendor_code_type
-      # in :bai2
-      #   # ...
-      # in :banking_circle
-      #   # ...
-      # in :bankprov
-      #   # ...
-      # in :bnk_dev
-      #   # ...
-      # in :cleartouch
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class VendorCodeType < ModernTreasury::Enum
+      module VendorCodeType
+        extend ModernTreasury::Enum
+
         BAI2 = :bai2
         BANKING_CIRCLE = :banking_circle
         BANKPROV = :bankprov
@@ -413,7 +376,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/transaction_create_params.rb

@@ -115,29 +115,11 @@ module ModernTreasury
 
       # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-      # @abstract
-      #
       # The type of the transaction. Examples could be
       #   `card, `ach`, `wire`, `check`, `rtp`, `book`, or `sen`.
-      #
-      # @example
-      # ```ruby
-      # case type
-      # in :ach
-      #   # ...
-      # in :au_becs
-      #   # ...
-      # in :bacs
-      #   # ...
-      # in :book
-      #   # ...
-      # in :card
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class Type < ModernTreasury::Enum
+      module Type
+        extend ModernTreasury::Enum
+
         ACH = :ach
         AU_BECS = :au_becs
         BACS = :bacs
@@ -174,7 +156,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/transaction_direction.rb

@@ -2,18 +2,9 @@
 
 module ModernTreasury
   module Models
-    # @abstract
-    #
-    # @example
-    # ```ruby
-    # case transaction_direction
-    # in :credit
-    #   # ...
-    # in :debit
-    #   # ...
-    # end
-    # ```
-    class TransactionDirection < ModernTreasury::Enum
+    module TransactionDirection
+      extend ModernTreasury::Enum
+
       CREDIT = :credit
       DEBIT = :debit
 
@@ -21,7 +12,6 @@ module ModernTreasury
 
       # @!parse
       #   # @return [Array<Symbol>]
-      #   #
       #   def self.values; end
     end
   end

data/lib/modern_treasury/models/transactions/line_item_list_params.rb

@@ -57,18 +57,9 @@ module ModernTreasury
 
         # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-        # @abstract
-        #
-        # @example
-        # ```ruby
-        # case type
-        # in :originating
-        #   # ...
-        # in :receiving
-        #   # ...
-        # end
-        # ```
-        class Type < ModernTreasury::Enum
+        module Type
+          extend ModernTreasury::Enum
+
           ORIGINATING = :originating
           RECEIVING = :receiving
 
@@ -76,7 +67,6 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end

data/lib/modern_treasury/models/transactions/transaction_line_item.rb

@@ -141,29 +141,11 @@ module ModernTreasury
 
         # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-        # @abstract
-        #
         # If a matching object exists in Modern Treasury, the type will be populated here,
         #   otherwise `null`.
-        #
-        # @example
-        # ```ruby
-        # case transactable_type
-        # in :incoming_payment_detail
-        #   # ...
-        # in :paper_item
-        #   # ...
-        # in :payment_order
-        #   # ...
-        # in :payment_order_attempt
-        #   # ...
-        # in :return
-        #   # ...
-        # in ...
-        #   #...
-        # end
-        # ```
-        class TransactableType < ModernTreasury::Enum
+        module TransactableType
+          extend ModernTreasury::Enum
+
           INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
           PAPER_ITEM = :paper_item
           PAYMENT_ORDER = :payment_order
@@ -175,25 +157,14 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
 
-        # @abstract
-        #
         # Indicates whether the line item is `originating` or `receiving` (see
         #   https://www.moderntreasury.com/journal/beginners-guide-to-ach for more).
-        #
-        # @example
-        # ```ruby
-        # case type
-        # in :originating
-        #   # ...
-        # in :receiving
-        #   # ...
-        # end
-        # ```
-        class Type < ModernTreasury::Enum
+        module Type
+          extend ModernTreasury::Enum
+
           ORIGINATING = :originating
           RECEIVING = :receiving
 
@@ -201,7 +172,6 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end

data/lib/modern_treasury/models/validation_validate_routing_number_params.rb

@@ -32,31 +32,13 @@ module ModernTreasury
 
       # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-      # @abstract
-      #
       # The type of routing number. See
       #   https://docs.moderntreasury.com/platform/reference/routing-detail-object for
       #   more details. In sandbox mode we currently only support `aba` and `swift` with
       #   routing numbers '123456789' and 'GRINUST0XXX' respectively.
-      #
-      # @example
-      # ```ruby
-      # case routing_number_type
-      # in :aba
-      #   # ...
-      # in :au_bsb
-      #   # ...
-      # in :br_codigo
-      #   # ...
-      # in :ca_cpa
-      #   # ...
-      # in :chips
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class RoutingNumberType < ModernTreasury::Enum
+      module RoutingNumberType
+        extend ModernTreasury::Enum
+
         ABA = :aba
         AU_BSB = :au_bsb
         BR_CODIGO = :br_codigo
@@ -83,7 +65,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/virtual_account_create_params.rb

@@ -167,29 +167,11 @@ module ModernTreasury
 
         # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-        # @abstract
-        #
         # One of `iban`, `clabe`, `wallet_address`, or `other`. Use `other` if the bank
         #   account number is in a generic format.
-        #
-        # @example
-        # ```ruby
-        # case account_number_type
-        # in :au_number
-        #   # ...
-        # in :clabe
-        #   # ...
-        # in :hk_number
-        #   # ...
-        # in :iban
-        #   # ...
-        # in :id_number
-        #   # ...
-        # in ...
-        #   #...
-        # end
-        # ```
-        class AccountNumberType < ModernTreasury::Enum
+        module AccountNumberType
+          extend ModernTreasury::Enum
+
           AU_NUMBER = :au_number
           CLABE = :clabe
           HK_NUMBER = :hk_number
@@ -205,7 +187,6 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end
@@ -327,26 +308,12 @@ module ModernTreasury
 
         # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-        # @abstract
-        #
         # If the ledger account links to another object in Modern Treasury, the type will
         #   be populated here, otherwise null. The value is one of internal_account or
         #   external_account.
-        #
-        # @example
-        # ```ruby
-        # case ledgerable_type
-        # in :counterparty
-        #   # ...
-        # in :external_account
-        #   # ...
-        # in :internal_account
-        #   # ...
-        # in :virtual_account
-        #   # ...
-        # end
-        # ```
-        class LedgerableType < ModernTreasury::Enum
+        module LedgerableType
+          extend ModernTreasury::Enum
+
           COUNTERPARTY = :counterparty
           EXTERNAL_ACCOUNT = :external_account
           INTERNAL_ACCOUNT = :internal_account
@@ -356,7 +323,6 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end
@@ -395,30 +361,12 @@ module ModernTreasury
 
         # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-        # @abstract
-        #
         # The type of routing number. See
         #   https://docs.moderntreasury.com/platform/reference/routing-detail-object for
         #   more details.
-        #
-        # @example
-        # ```ruby
-        # case routing_number_type
-        # in :aba
-        #   # ...
-        # in :au_bsb
-        #   # ...
-        # in :br_codigo
-        #   # ...
-        # in :ca_cpa
-        #   # ...
-        # in :chips
-        #   # ...
-        # in ...
-        #   #...
-        # end
-        # ```
-        class RoutingNumberType < ModernTreasury::Enum
+        module RoutingNumberType
+          extend ModernTreasury::Enum
+
           ABA = :aba
           AU_BSB = :au_bsb
           BR_CODIGO = :br_codigo
@@ -445,33 +393,14 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
 
-        # @abstract
-        #
         # If the routing detail is to be used for a specific payment type this field will
         #   be populated, otherwise null.
-        #
-        # @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::Enum
+
           ACH = :ach
           AU_BECS = :au_becs
           BACS = :bacs
@@ -507,7 +436,6 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end

data/lib/modern_treasury/models/wealth_and_employment_details.rb

@@ -163,26 +163,10 @@ module ModernTreasury
 
       # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-      # @abstract
-      #
       # The employment status of the individual.
-      #
-      # @example
-      # ```ruby
-      # case employment_status
-      # in :employed
-      #   # ...
-      # in :retired
-      #   # ...
-      # in :self_employed
-      #   # ...
-      # in :student
-      #   # ...
-      # in :unemployed
-      #   # ...
-      # end
-      # ```
-      class EmploymentStatus < ModernTreasury::Enum
+      module EmploymentStatus
+        extend ModernTreasury::Enum
+
         EMPLOYED = :employed
         RETIRED = :retired
         SELF_EMPLOYED = :self_employed
@@ -193,32 +177,13 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # The source of the individual's income.
-      #
-      # @example
-      # ```ruby
-      # case income_source
-      # in :family_support
-      #   # ...
-      # in :government_benefits
-      #   # ...
-      # in :inheritance
-      #   # ...
-      # in :investments
-      #   # ...
-      # in :rental_income
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class IncomeSource < ModernTreasury::Enum
+      module IncomeSource
+        extend ModernTreasury::Enum
+
         FAMILY_SUPPORT = :family_support
         GOVERNMENT_BENEFITS = :government_benefits
         INHERITANCE = :inheritance
@@ -232,32 +197,13 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # The industry of the individual.
-      #
-      # @example
-      # ```ruby
-      # case industry
-      # in :accounting
-      #   # ...
-      # in :agriculture
-      #   # ...
-      # in :automotive
-      #   # ...
-      # in :chemical_manufacturing
-      #   # ...
-      # in :construction
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class Industry < ModernTreasury::Enum
+      module Industry
+        extend ModernTreasury::Enum
+
         ACCOUNTING = :accounting
         AGRICULTURE = :agriculture
         AUTOMOTIVE = :automotive
@@ -296,32 +242,13 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # The occupation of the individual.
-      #
-      # @example
-      # ```ruby
-      # case occupation
-      # in :consulting
-      #   # ...
-      # in :executive
-      #   # ...
-      # in :finance_accounting
-      #   # ...
-      # in :food_services
-      #   # ...
-      # in :government
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class Occupation < ModernTreasury::Enum
+      module Occupation
+        extend ModernTreasury::Enum
+
         CONSULTING = :consulting
         EXECUTIVE = :executive
         FINANCE_ACCOUNTING = :finance_accounting
@@ -339,32 +266,13 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # The source of the individual's funds.
-      #
-      # @example
-      # ```ruby
-      # case source_of_funds
-      # in :alimony
-      #   # ...
-      # in :annuity
-      #   # ...
-      # in :business_owner
-      #   # ...
-      # in :general_employee
-      #   # ...
-      # in :government_benefits
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class SourceOfFunds < ModernTreasury::Enum
+      module SourceOfFunds
+        extend ModernTreasury::Enum
+
         ALIMONY = :alimony
         ANNUITY = :annuity
         BUSINESS_OWNER = :business_owner
@@ -387,32 +295,13 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # The source of the individual's wealth.
-      #
-      # @example
-      # ```ruby
-      # case wealth_source
-      # in :business_sale
-      #   # ...
-      # in :family_support
-      #   # ...
-      # in :government_benefits
-      #   # ...
-      # in :inheritance
-      #   # ...
-      # in :investments
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class WealthSource < ModernTreasury::Enum
+      module WealthSource
+        extend ModernTreasury::Enum
+
         BUSINESS_SALE = :business_sale
         FAMILY_SUPPORT = :family_support
         GOVERNMENT_BENEFITS = :government_benefits
@@ -428,7 +317,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end