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

data/lib/modern_treasury/models/payment_order.rb

@@ -489,24 +489,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
@@ -515,27 +503,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
 
@@ -543,26 +520,15 @@ module ModernTreasury
 
         # @!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
 
@@ -570,7 +536,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
@@ -637,22 +602,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
 
@@ -660,22 +615,12 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
-      # @example
-      # ```ruby
-      # case receiving_account_type
-      # in :internal_account
-      #   # ...
-      # in :external_account
-      #   # ...
-      # end
-      # ```
-      class ReceivingAccountType < ModernTreasury::Enum
+      module ReceivingAccountType
+        extend ModernTreasury::Enum
+
         INTERNAL_ACCOUNT = :internal_account
         EXTERNAL_ACCOUNT = :external_account
 
@@ -683,7 +628,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
@@ -741,28 +685,10 @@ module ModernTreasury
 
         # def initialize: (Hash | ModernTreasury::BaseModel) -> void
 
-        # @abstract
-        #
         # The type of the reference number. Referring to the vendor payment id.
-        #
-        # @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
@@ -773,7 +699,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
@@ -839,33 +766,14 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end
 
-      # @abstract
-      #
       # The current status of the payment order.
-      #
-      # @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
@@ -882,42 +790,26 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # The account to which the originating of this payment should be attributed to.
       #   Can be a `virtual_account` or `internal_account`.
-      #
-      # @example
-      # ```ruby
-      # case ultimate_originating_account
-      # in ModernTreasury::Models::VirtualAccount
-      #   # ...
-      # in ModernTreasury::Models::InternalAccount
-      #   # ...
-      # end
-      # ```
-      class UltimateOriginatingAccount < ModernTreasury::Union
+      module UltimateOriginatingAccount
+        extend ModernTreasury::Union
+
         variant -> { ModernTreasury::Models::VirtualAccount }
 
         variant -> { ModernTreasury::Models::InternalAccount }
+
+        # @!parse
+        #   # @return [Array(ModernTreasury::Models::VirtualAccount, ModernTreasury::Models::InternalAccount)]
+        #   def self.variants; end
       end
 
-      # @abstract
-      #
-      # @example
-      # ```ruby
-      # case ultimate_originating_account_type
-      # in :internal_account
-      #   # ...
-      # in :virtual_account
-      #   # ...
-      # end
-      # ```
-      class UltimateOriginatingAccountType < ModernTreasury::Enum
+      module UltimateOriginatingAccountType
+        extend ModernTreasury::Enum
+
         INTERNAL_ACCOUNT = :internal_account
         VIRTUAL_ACCOUNT = :virtual_account
 
@@ -925,7 +817,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end