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

data/lib/modern_treasury/models/payment_order_create_params.rb

@@ -421,23 +421,13 @@ module ModernTreasury
 
       # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-      # @abstract
-      #
       # One of `credit`, `debit`. Describes the direction money is flowing in the
       #   transaction. A `credit` moves money from your account to someone else's. A
       #   `debit` pulls money from someone else's account to your own. Note that wire,
       #   rtp, and check payments will always be `credit`.
-      #
-      # @example
-      # ```ruby
-      # case direction
-      # in :credit
-      #   # ...
-      # in :debit
-      #   # ...
-      # end
-      # ```
-      class Direction < ModernTreasury::Enum
+      module Direction
+        extend ModernTreasury::Enum
+
         CREDIT = :credit
         DEBIT = :debit
 
@@ -445,7 +435,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
@@ -474,24 +463,12 @@ module ModernTreasury
         # def initialize: (Hash | ModernTreasury::BaseModel) -> void
       end
 
-      # @abstract
-      #
       # The party that will pay the fees for the payment order. Only applies to wire
       #   payment orders. Can be one of shared, sender, or receiver, which correspond
       #   respectively with the SWIFT 71A values `SHA`, `OUR`, `BEN`.
-      #
-      # @example
-      # ```ruby
-      # case charge_bearer
-      # in :shared
-      #   # ...
-      # in :sender
-      #   # ...
-      # in :receiver
-      #   # ...
-      # end
-      # ```
-      class ChargeBearer < ModernTreasury::Enum
+      module ChargeBearer
+        extend ModernTreasury::Enum
+
         SHARED = :shared
         SENDER = :sender
         RECEIVER = :receiver
@@ -500,7 +477,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
@@ -542,26 +518,9 @@ module ModernTreasury
 
         # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-        # @abstract
-        #
-        # @example
-        # ```ruby
-        # case documentable_type
-        # in :cases
-        #   # ...
-        # in :counterparties
-        #   # ...
-        # in :expected_payments
-        #   # ...
-        # in :external_accounts
-        #   # ...
-        # in :incoming_payment_details
-        #   # ...
-        # in ...
-        #   #...
-        # end
-        # ```
-        class DocumentableType < ModernTreasury::Enum
+        module DocumentableType
+          extend ModernTreasury::Enum
+
           CASES = :cases
           COUNTERPARTIES = :counterparties
           EXPECTED_PAYMENTS = :expected_payments
@@ -579,51 +538,31 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end
 
-      # @abstract
-      #
       # A payment type to fallback to if the original type is not valid for the
       #   receiving account. Currently, this only supports falling back from RTP to ACH
       #   (type=rtp and fallback_type=ach)
-      #
-      # @example
-      # ```ruby
-      # case fallback_type
-      # in :ach
-      #   # ...
-      # end
-      # ```
-      class FallbackType < ModernTreasury::Enum
+      module FallbackType
+        extend ModernTreasury::Enum
+
         ACH = :ach
 
         finalize!
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # Indicates the type of FX transfer to initiate, can be either
       #   `variable_to_fixed`, `fixed_to_variable`, or `null` if the payment order
       #   currency matches the originating account currency.
-      #
-      # @example
-      # ```ruby
-      # case foreign_exchange_indicator
-      # in :fixed_to_variable
-      #   # ...
-      # in :variable_to_fixed
-      #   # ...
-      # end
-      # ```
-      class ForeignExchangeIndicator < ModernTreasury::Enum
+      module ForeignExchangeIndicator
+        extend ModernTreasury::Enum
+
         FIXED_TO_VARIABLE = :fixed_to_variable
         VARIABLE_TO_FIXED = :variable_to_fixed
 
@@ -631,7 +570,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
@@ -864,31 +802,13 @@ module ModernTreasury
           # def initialize: (Hash | ModernTreasury::BaseModel) -> void
         end
 
-        # @abstract
-        #
         # If the ledger transaction can be reconciled to another object in Modern
         #   Treasury, the type will be populated here, otherwise null. This can be one of
         #   payment_order, incoming_payment_detail, expected_payment, return, paper_item, or
         #   reversal.
-        #
-        # @example
-        # ```ruby
-        # case ledgerable_type
-        # in :expected_payment
-        #   # ...
-        # in :incoming_payment_detail
-        #   # ...
-        # in :paper_item
-        #   # ...
-        # in :payment_order
-        #   # ...
-        # in :return
-        #   # ...
-        # in ...
-        #   #...
-        # end
-        # ```
-        class LedgerableType < ModernTreasury::Enum
+        module LedgerableType
+          extend ModernTreasury::Enum
+
           EXPECTED_PAYMENT = :expected_payment
           INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
           PAPER_ITEM = :paper_item
@@ -900,26 +820,13 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
 
-        # @abstract
-        #
         # To post a ledger transaction at creation, use `posted`.
-        #
-        # @example
-        # ```ruby
-        # case status
-        # in :archived
-        #   # ...
-        # in :pending
-        #   # ...
-        # in :posted
-        #   # ...
-        # end
-        # ```
-        class Status < ModernTreasury::Enum
+        module Status
+          extend ModernTreasury::Enum
+
           ARCHIVED = :archived
           PENDING = :pending
           POSTED = :posted
@@ -928,7 +835,6 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end
@@ -976,22 +882,12 @@ module ModernTreasury
         # def initialize: (Hash | ModernTreasury::BaseModel) -> void
       end
 
-      # @abstract
-      #
       # Either `normal` or `high`. For ACH and EFT payments, `high` represents a
       #   same-day ACH or EFT transfer, respectively. For check payments, `high` can mean
       #   an overnight check rather than standard mail.
-      #
-      # @example
-      # ```ruby
-      # case priority
-      # in :high
-      #   # ...
-      # in :normal
-      #   # ...
-      # end
-      # ```
-      class Priority < ModernTreasury::Enum
+      module Priority
+        extend ModernTreasury::Enum
+
         HIGH = :high
         NORMAL = :normal
 
@@ -999,7 +895,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
@@ -1188,26 +1083,9 @@ module ModernTreasury
 
           # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-          # @abstract
-          #
-          # @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
@@ -1223,7 +1101,6 @@ module ModernTreasury
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end
@@ -1256,20 +1133,9 @@ module ModernTreasury
 
           # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-          # @abstract
-          #
-          # @example
-          # ```ruby
-          # case contact_identifier_type
-          # in :email
-          #   # ...
-          # in :phone_number
-          #   # ...
-          # in :website
-          #   # ...
-          # end
-          # ```
-          class ContactIdentifierType < ModernTreasury::Enum
+          module ContactIdentifierType
+            extend ModernTreasury::Enum
+
             EMAIL = :email
             PHONE_NUMBER = :phone_number
             WEBSITE = :website
@@ -1278,7 +1144,6 @@ module ModernTreasury
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end
@@ -1402,26 +1267,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
@@ -1431,7 +1282,6 @@ module ModernTreasury
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end
@@ -1486,20 +1336,10 @@ module ModernTreasury
           # def initialize: (Hash | ModernTreasury::BaseModel) -> void
         end
 
-        # @abstract
-        #
         # Either `individual` or `business`.
-        #
-        # @example
-        # ```ruby
-        # case party_type
-        # in :business
-        #   # ...
-        # in :individual
-        #   # ...
-        # end
-        # ```
-        class PartyType < ModernTreasury::Enum
+        module PartyType
+          extend ModernTreasury::Enum
+
           BUSINESS = :business
           INDIVIDUAL = :individual
 
@@ -1507,7 +1347,6 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
 
@@ -1542,26 +1381,9 @@ module ModernTreasury
 
           # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-          # @abstract
-          #
-          # @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
@@ -1588,30 +1410,12 @@ module ModernTreasury
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
 
-          # @abstract
-          #
-          # @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
@@ -1647,7 +1451,6 @@ module ModernTreasury
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end

data/lib/modern_treasury/models/payment_order_list_params.rb

@@ -216,22 +216,12 @@ module ModernTreasury
 
       # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-      # @abstract
-      #
       # Either `normal` or `high`. For ACH and EFT payments, `high` represents a
       #   same-day ACH or EFT transfer, respectively. For check payments, `high` can mean
       #   an overnight check rather than standard mail.
-      #
-      # @example
-      # ```ruby
-      # case priority
-      # in :high
-      #   # ...
-      # in :normal
-      #   # ...
-      # end
-      # ```
-      class Priority < ModernTreasury::Enum
+      module Priority
+        extend ModernTreasury::Enum
+
         HIGH = :high
         NORMAL = :normal
 
@@ -239,30 +229,12 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
-      # @example
-      # ```ruby
-      # case status
-      # in :approved
-      #   # ...
-      # in :cancelled
-      #   # ...
-      # in :completed
-      #   # ...
-      # in :denied
-      #   # ...
-      # in :failed
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class Status < ModernTreasury::Enum
+      module Status
+        extend ModernTreasury::Enum
+
         APPROVED = :approved
         CANCELLED = :cancelled
         COMPLETED = :completed
@@ -279,30 +251,12 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
-      # @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
@@ -338,7 +292,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/payment_order_subtype.rb

@@ -2,31 +2,13 @@
 
 module ModernTreasury
   module Models
-    # @abstract
-    #
     # An additional layer of classification for the type of payment order you are
     #   doing. This field is only used for `ach` payment orders currently. For `ach`
     #   payment orders, the `subtype` represents the SEC code. We currently support
     #   `CCD`, `PPD`, `IAT`, `CTX`, `WEB`, `CIE`, and `TEL`.
-    #
-    # @example
-    # ```ruby
-    # case payment_order_subtype
-    # in :"0C"
-    #   # ...
-    # in :"0N"
-    #   # ...
-    # in :"0S"
-    #   # ...
-    # in :CCD
-    #   # ...
-    # in :CIE
-    #   # ...
-    # in ...
-    #   #...
-    # end
-    # ```
-    class PaymentOrderSubtype < ModernTreasury::Enum
+    module PaymentOrderSubtype
+      extend ModernTreasury::Enum
+
       BACS_NEW_INSTRUCTION = :"0C"
       BACS_CANCELLATION_INSTRUCTION = :"0N"
       BACS_CONVERSION_INSTRUCTION = :"0S"
@@ -61,7 +43,6 @@ module ModernTreasury
 
       # @!parse
       #   # @return [Array<Symbol>]
-      #   #
       #   def self.values; end
     end
   end

data/lib/modern_treasury/models/payment_order_type.rb

@@ -2,30 +2,12 @@
 
 module ModernTreasury
   module Models
-    # @abstract
-    #
     # One of `ach`, `se_bankgirot`, `eft`, `wire`, `check`, `sen`, `book`, `rtp`,
     #   `sepa`, `bacs`, `au_becs`, `interac`, `neft`, `nics`,
     #   `nz_national_clearing_code`, `sic`, `signet`, `provexchange`, `zengin`.
-    #
-    # @example
-    # ```ruby
-    # case payment_order_type
-    # in :ach
-    #   # ...
-    # in :au_becs
-    #   # ...
-    # in :bacs
-    #   # ...
-    # in :book
-    #   # ...
-    # in :card
-    #   # ...
-    # in ...
-    #   #...
-    # end
-    # ```
-    class PaymentOrderType < ModernTreasury::Enum
+    module PaymentOrderType
+      extend ModernTreasury::Enum
+
       ACH = :ach
       AU_BECS = :au_becs
       BACS = :bacs
@@ -61,7 +43,6 @@ module ModernTreasury
 
       # @!parse
       #   # @return [Array<Symbol>]
-      #   #
       #   def self.values; end
     end
   end