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

data/lib/modern_treasury/models/payment_order_update_params.rb

@@ -435,24 +435,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
@@ -461,27 +449,16 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @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
 
@@ -489,50 +466,30 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; 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
 
@@ -540,7 +497,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
@@ -587,22 +543,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
 
@@ -610,7 +556,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
@@ -799,26 +744,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
@@ -834,7 +762,6 @@ module ModernTreasury
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end
@@ -867,20 +794,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
@@ -889,7 +805,6 @@ module ModernTreasury
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end
@@ -1013,26 +928,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
@@ -1042,7 +943,6 @@ module ModernTreasury
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end
@@ -1097,20 +997,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
 
@@ -1118,7 +1008,6 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
 
@@ -1153,26 +1042,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
@@ -1199,30 +1071,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
@@ -1258,36 +1112,17 @@ module ModernTreasury
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end
       end
 
-      # @abstract
-      #
       # To cancel a payment order, use `cancelled`. To redraft a returned payment order,
       #   use `approved`. To undo approval on a denied or approved payment order, use
       #   `needs_approval`.
-      #
-      # @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
@@ -1304,7 +1139,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/payment_orders/reversal.rb

@@ -99,26 +99,10 @@ module ModernTreasury
 
         # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-        # @abstract
-        #
         # The reason for the reversal.
-        #
-        # @example
-        # ```ruby
-        # case reason
-        # in :duplicate
-        #   # ...
-        # in :incorrect_amount
-        #   # ...
-        # in :incorrect_receiving_account
-        #   # ...
-        # in :date_earlier_than_intended
-        #   # ...
-        # in :date_later_than_intended
-        #   # ...
-        # end
-        # ```
-        class Reason < ModernTreasury::Enum
+        module Reason
+          extend ModernTreasury::Enum
+
           DUPLICATE = :duplicate
           INCORRECT_AMOUNT = :incorrect_amount
           INCORRECT_RECEIVING_ACCOUNT = :incorrect_receiving_account
@@ -129,32 +113,13 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
 
-        # @abstract
-        #
         # The current status of the reversal.
-        #
-        # @example
-        # ```ruby
-        # case status
-        # in :completed
-        #   # ...
-        # in :failed
-        #   # ...
-        # in :pending
-        #   # ...
-        # in :processing
-        #   # ...
-        # in :returned
-        #   # ...
-        # in ...
-        #   #...
-        # end
-        # ```
-        class Status < ModernTreasury::Enum
+        module Status
+          extend ModernTreasury::Enum
+
           COMPLETED = :completed
           FAILED = :failed
           PENDING = :pending
@@ -166,7 +131,6 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end

data/lib/modern_treasury/models/payment_orders/reversal_create_params.rb

@@ -50,28 +50,12 @@ module ModernTreasury
 
         # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-        # @abstract
-        #
         # The reason for the reversal. Must be one of `duplicate`, `incorrect_amount`,
         #   `incorrect_receiving_account`, `date_earlier_than_intended`,
         #   `date_later_than_intended`.
-        #
-        # @example
-        # ```ruby
-        # case reason
-        # in :duplicate
-        #   # ...
-        # in :incorrect_amount
-        #   # ...
-        # in :incorrect_receiving_account
-        #   # ...
-        # in :date_earlier_than_intended
-        #   # ...
-        # in :date_later_than_intended
-        #   # ...
-        # end
-        # ```
-        class Reason < ModernTreasury::Enum
+        module Reason
+          extend ModernTreasury::Enum
+
           DUPLICATE = :duplicate
           INCORRECT_AMOUNT = :incorrect_amount
           INCORRECT_RECEIVING_ACCOUNT = :incorrect_receiving_account
@@ -82,7 +66,6 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
 
@@ -315,31 +298,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
@@ -351,26 +316,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
@@ -379,7 +331,6 @@ module ModernTreasury
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end

data/lib/modern_treasury/models/payment_reference.rb

@@ -85,28 +85,10 @@ module ModernTreasury
 
       # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-      # @abstract
-      #
       # The type of reference number.
-      #
-      # @example
-      # ```ruby
-      # case reference_number_type
-      # in :ach_original_trace_number
-      #   # ...
-      # in :ach_trace_number
-      #   # ...
-      # in :bankprov_payment_activity_date
-      #   # ...
-      # in :bankprov_payment_id
-      #   # ...
-      # in :bnk_dev_prenotification_id
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class ReferenceNumberType < ModernTreasury::Enum
+      module ReferenceNumberType
+        extend ModernTreasury::Enum
+
         ACH_ORIGINAL_TRACE_NUMBER = :ach_original_trace_number
         ACH_TRACE_NUMBER = :ach_trace_number
         BANKPROV_PAYMENT_ACTIVITY_DATE = :bankprov_payment_activity_date
@@ -117,7 +99,8 @@ module ModernTreasury
         BOFA_TRANSACTION_ID = :bofa_transaction_id
         CHECK_NUMBER = :check_number
         CITIBANK_REFERENCE_NUMBER = :citibank_reference_number
-        CITIBANK_WORLDLINK_CLEARING_SYSTEM_REFERENCE_NUMBER = :citibank_worldlink_clearing_system_reference_number
+        CITIBANK_WORLDLINK_CLEARING_SYSTEM_REFERENCE_NUMBER =
+          :citibank_worldlink_clearing_system_reference_number
         COLUMN_FX_QUOTE_ID = :column_fx_quote_id
         COLUMN_REVERSAL_PAIR_TRANSFER_ID = :column_reversal_pair_transfer_id
         COLUMN_TRANSFER_ID = :column_transfer_id
@@ -183,27 +166,14 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # One of the referenceable types. This must be accompanied by the id of the
       #   referenceable or will return an error.
-      #
-      # @example
-      # ```ruby
-      # case referenceable_type
-      # in :payment_order
-      #   # ...
-      # in :reversal
-      #   # ...
-      # in :return
-      #   # ...
-      # end
-      # ```
-      class ReferenceableType < ModernTreasury::Enum
+      module ReferenceableType
+        extend ModernTreasury::Enum
+
         PAYMENT_ORDER = :payment_order
         REVERSAL = :reversal
         RETURN = :return
@@ -212,7 +182,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/payment_reference_list_params.rb

@@ -76,23 +76,11 @@ module ModernTreasury
 
       # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-      # @abstract
-      #
       # One of the referenceable types. This must be accompanied by the id of the
       #   referenceable or will return an error.
-      #
-      # @example
-      # ```ruby
-      # case referenceable_type
-      # in :payment_order
-      #   # ...
-      # in :return
-      #   # ...
-      # in :reversal
-      #   # ...
-      # end
-      # ```
-      class ReferenceableType < ModernTreasury::Enum
+      module ReferenceableType
+        extend ModernTreasury::Enum
+
         PAYMENT_ORDER = :payment_order
         RETURN = :return
         REVERSAL = :reversal
@@ -101,7 +89,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end