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

data/lib/modern_treasury/models/return_object.rb

@@ -2,7 +2,8 @@
 
 module ModernTreasury
   module Models
-    class ReturnObject < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::Returns#create
+    class ReturnObject < ModernTreasury::Internal::Type::BaseModel
       # @!attribute id
       #
       #   @return [String]
@@ -10,7 +11,7 @@ module ModernTreasury
 
       # @!attribute amount
       #   Value in specified currency's smallest unit. e.g. $10 would be represented
-      #     as 1000.
+      #   as 1000.
       #
       #   @return [Integer]
       required :amount, Integer
@@ -34,21 +35,21 @@ module ModernTreasury
 
       # @!attribute current_return
       #   If the return's status is `returned`, this will include the return object's data
-      #     that is returning this return.
+      #   that is returning this return.
       #
       #   @return [ModernTreasury::Models::ReturnObject, nil]
       required :current_return, -> { ModernTreasury::Models::ReturnObject }, nil?: true
 
       # @!attribute date_of_death
       #   If the return code is `R14` or `R15` this is the date the deceased counterparty
-      #     passed away.
+      #   passed away.
       #
       #   @return [Date, nil]
       required :date_of_death, Date, nil?: true
 
       # @!attribute failure_reason
       #   If an originating return failed to be processed by the bank, a description of
-      #     the failure reason will be available.
+      #   the failure reason will be available.
       #
       #   @return [String, nil]
       required :failure_reason, String, nil?: true
@@ -67,10 +68,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
       #
@@ -79,7 +80,7 @@ module ModernTreasury
 
       # @!attribute reason
       #   Often the bank will provide an explanation for the return, which is a short
-      #     human readable string.
+      #   human readable string.
       #
       #   @return [String, nil]
       required :reason, String, nil?: true
@@ -89,7 +90,7 @@ module ModernTreasury
       #
       #   @return [Array<ModernTreasury::Models::ReturnObject::ReferenceNumber>]
       required :reference_numbers,
-               -> { ModernTreasury::ArrayOf[ModernTreasury::Models::ReturnObject::ReferenceNumber] }
+               -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::Models::ReturnObject::ReferenceNumber] }
 
       # @!attribute returnable_id
       #   The ID of the object being returned or `null`.
@@ -129,7 +130,7 @@ module ModernTreasury
 
       # @!attribute type
       #   The type of return. Can be one of: `ach`, `ach_noc`, `au_becs`, `bacs`, `eft`,
-      #     `interac`, `manual`, `paper_item`, `wire`.
+      #   `interac`, `manual`, `paper_item`, `wire`.
       #
       #   @return [Symbol, ModernTreasury::Models::ReturnObject::Type]
       required :type, enum: -> { ModernTreasury::Models::ReturnObject::Type }
@@ -141,11 +142,17 @@ module ModernTreasury
 
       # @!attribute additional_information
       #   Some returns may include additional information from the bank. In these cases,
-      #     this string will be present.
+      #   this string will be present.
       #
       #   @return [String, nil]
       optional :additional_information, String, nil?: true
 
+      # @!attribute data
+      #   The raw data from the return file that we get from the bank.
+      #
+      #   @return [Object, nil]
+      optional :data, ModernTreasury::Internal::Type::Unknown, nil?: true
+
       # @!parse
       #   # @param id [String]
       #   # @param amount [Integer]
@@ -170,6 +177,7 @@ module ModernTreasury
       #   # @param type [Symbol, ModernTreasury::Models::ReturnObject::Type]
       #   # @param updated_at [Time]
       #   # @param additional_information [String, nil]
+      #   # @param data [Object, nil]
       #   #
       #   def initialize(
       #     id:,
@@ -195,47 +203,32 @@ module ModernTreasury
       #     type:,
       #     updated_at:,
       #     additional_information: nil,
+      #     data: nil,
       #     **
       #   )
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      # @abstract
-      #
       # The return code. For ACH returns, this is the required ACH return code.
       #
-      # @example
-      # ```ruby
-      # case code
-      # in :"901"
-      #   # ...
-      # in :"902"
-      #   # ...
-      # in :"903"
-      #   # ...
-      # in :"904"
-      #   # ...
-      # in :"905"
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class Code < ModernTreasury::Enum
-        NUMBER_901 = :"901"
-        NUMBER_902 = :"902"
-        NUMBER_903 = :"903"
-        NUMBER_904 = :"904"
-        NUMBER_905 = :"905"
-        NUMBER_907 = :"907"
-        NUMBER_908 = :"908"
-        NUMBER_909 = :"909"
-        NUMBER_910 = :"910"
-        NUMBER_911 = :"911"
-        NUMBER_912 = :"912"
-        NUMBER_914 = :"914"
+      # @see ModernTreasury::Models::ReturnObject#code
+      module Code
+        extend ModernTreasury::Internal::Type::Enum
+
+        CODE_901 = :"901"
+        CODE_902 = :"902"
+        CODE_903 = :"903"
+        CODE_904 = :"904"
+        CODE_905 = :"905"
+        CODE_907 = :"907"
+        CODE_908 = :"908"
+        CODE_909 = :"909"
+        CODE_910 = :"910"
+        CODE_911 = :"911"
+        CODE_912 = :"912"
+        CODE_914 = :"914"
         C01 = :C01
         C02 = :C02
         C03 = :C03
@@ -282,11 +275,10 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      class ReferenceNumber < ModernTreasury::BaseModel
+      class ReferenceNumber < ModernTreasury::Internal::Type::BaseModel
         # @!attribute id
         #
         #   @return [String]
@@ -299,10 +291,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
         #
@@ -338,30 +330,14 @@ module ModernTreasury
         #   #
         #   def initialize(id:, created_at:, live_mode:, object:, reference_number:, reference_number_type:, updated_at:, **) = super
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::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
+        # @see ModernTreasury::Models::ReturnObject::ReferenceNumber#reference_number_type
+        module ReferenceNumberType
+          extend ModernTreasury::Internal::Type::Enum
+
           ACH_ORIGINAL_TRACE_NUMBER = :ach_original_trace_number
           ACH_TRACE_NUMBER = :ach_trace_number
           BANKPROV_PAYMENT_ACTIVITY_DATE = :bankprov_payment_activity_date
@@ -372,7 +348,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
@@ -404,6 +381,7 @@ module ModernTreasury
           JPMC_PAYMENT_BATCH_ID = :jpmc_payment_batch_id
           JPMC_PAYMENT_INFORMATION_ID = :jpmc_payment_information_id
           JPMC_PAYMENT_RETURNED_DATETIME = :jpmc_payment_returned_datetime
+          JPMC_TRANSACTION_REFERENCE_NUMBER = :jpmc_transaction_reference_number
           LOB_CHECK_ID = :lob_check_id
           OTHER = :other
           PARTIAL_SWIFT_MIR = :partial_swift_mir
@@ -411,7 +389,9 @@ module ModernTreasury
           PNC_INSTRUCTION_ID = :pnc_instruction_id
           PNC_MULTIPAYMENT_ID = :pnc_multipayment_id
           PNC_PAYMENT_TRACE_ID = :pnc_payment_trace_id
+          PNC_REQUEST_FOR_PAYMENT_ID = :pnc_request_for_payment_id
           PNC_TRANSACTION_REFERENCE_NUMBER = :pnc_transaction_reference_number
+          RBC_WIRE_REFERENCE_ID = :rbc_wire_reference_id
           RSPEC_VENDOR_PAYMENT_ID = :rspec_vendor_payment_id
           RTP_INSTRUCTION_ID = :rtp_instruction_id
           SIGNET_API_REFERENCE_ID = :signet_api_reference_id
@@ -438,31 +418,16 @@ module ModernTreasury
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end
 
-      # @abstract
-      #
       # The type of object being returned or `null`.
       #
-      # @example
-      # ```ruby
-      # case returnable_type
-      # in :incoming_payment_detail
-      #   # ...
-      # in :paper_item
-      #   # ...
-      # in :payment_order
-      #   # ...
-      # in :return
-      #   # ...
-      # in :reversal
-      #   # ...
-      # end
-      # ```
-      class ReturnableType < ModernTreasury::Enum
+      # @see ModernTreasury::Models::ReturnObject#returnable_type
+      module ReturnableType
+        extend ModernTreasury::Internal::Type::Enum
+
         INCOMING_PAYMENT_DETAIL = :incoming_payment_detail
         PAPER_ITEM = :paper_item
         PAYMENT_ORDER = :payment_order
@@ -473,24 +438,15 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # The role of the return, can be `originating` or `receiving`.
       #
-      # @example
-      # ```ruby
-      # case role
-      # in :originating
-      #   # ...
-      # in :receiving
-      #   # ...
-      # end
-      # ```
-      class Role < ModernTreasury::Enum
+      # @see ModernTreasury::Models::ReturnObject#role
+      module Role
+        extend ModernTreasury::Internal::Type::Enum
+
         ORIGINATING = :originating
         RECEIVING = :receiving
 
@@ -498,32 +454,15 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # The current status of the return.
       #
-      # @example
-      # ```ruby
-      # case status
-      # in :completed
-      #   # ...
-      # in :failed
-      #   # ...
-      # in :pending
-      #   # ...
-      # in :processing
-      #   # ...
-      # in :returned
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class Status < ModernTreasury::Enum
+      # @see ModernTreasury::Models::ReturnObject#status
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
+
         COMPLETED = :completed
         FAILED = :failed
         PENDING = :pending
@@ -535,33 +474,16 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # The type of return. Can be one of: `ach`, `ach_noc`, `au_becs`, `bacs`, `eft`,
-      #   `interac`, `manual`, `paper_item`, `wire`.
+      # `interac`, `manual`, `paper_item`, `wire`.
       #
-      # @example
-      # ```ruby
-      # case type
-      # in :ach
-      #   # ...
-      # in :ach_noc
-      #   # ...
-      # in :au_becs
-      #   # ...
-      # in :bacs
-      #   # ...
-      # in :book
-      #   # ...
-      # in ...
-      #   #...
-      # end
-      # ```
-      class Type < ModernTreasury::Enum
+      # @see ModernTreasury::Models::ReturnObject#type
+      module Type
+        extend ModernTreasury::Internal::Type::Enum
+
         ACH = :ach
         ACH_NOC = :ach_noc
         AU_BECS = :au_becs
@@ -580,7 +502,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/modern_treasury/models/return_retrieve_params.rb

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

@@ -2,7 +2,8 @@
 
 module ModernTreasury
   module Models
-    class RoutingDetail < ModernTreasury::BaseModel
+    # @see ModernTreasury::Resources::RoutingDetails#create
+    class RoutingDetail < ModernTreasury::Internal::Type::BaseModel
       # @!attribute id
       #
       #   @return [String]
@@ -31,10 +32,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
       #
@@ -43,7 +44,7 @@ module ModernTreasury
 
       # @!attribute payment_type
       #   If the routing detail is to be used for a specific payment type this field will
-      #     be populated, otherwise null.
+      #   be populated, otherwise null.
       #
       #   @return [Symbol, ModernTreasury::Models::RoutingDetail::PaymentType, nil]
       required :payment_type, enum: -> { ModernTreasury::Models::RoutingDetail::PaymentType }, nil?: true
@@ -56,8 +57,8 @@ module ModernTreasury
 
       # @!attribute routing_number_type
       #   The type of routing number. See
-      #     https://docs.moderntreasury.com/platform/reference/routing-detail-object for
-      #     more details.
+      #   https://docs.moderntreasury.com/platform/reference/routing-detail-object for
+      #   more details.
       #
       #   @return [Symbol, ModernTreasury::Models::RoutingDetail::RoutingNumberType]
       required :routing_number_type, enum: -> { ModernTreasury::Models::RoutingDetail::RoutingNumberType }
@@ -97,9 +98,10 @@ module ModernTreasury
       #     super
       #   end
 
-      # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+      # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
 
-      class BankAddress < ModernTreasury::BaseModel
+      # @see ModernTreasury::Models::RoutingDetail#bank_address
+      class BankAddress < ModernTreasury::Internal::Type::BaseModel
         # @!attribute id
         #
         #   @return [String]
@@ -128,10 +130,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.
@@ -191,32 +193,16 @@ module ModernTreasury
         #     super
         #   end
 
-        # def initialize: (Hash | ModernTreasury::BaseModel) -> void
+        # def initialize: (Hash | ModernTreasury::Internal::Type::BaseModel) -> void
       end
 
-      # @abstract
-      #
       # If the routing detail is to be used for a specific payment type this field will
-      #   be populated, otherwise null.
+      # 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
+      # @see ModernTreasury::Models::RoutingDetail#payment_type
+      module PaymentType
+        extend ModernTreasury::Internal::Type::Enum
+
         ACH = :ach
         AU_BECS = :au_becs
         BACS = :bacs
@@ -252,34 +238,17 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # The type of routing number. See
-      #   https://docs.moderntreasury.com/platform/reference/routing-detail-object for
-      #   more details.
+      # 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
+      # @see ModernTreasury::Models::RoutingDetail#routing_number_type
+      module RoutingNumberType
+        extend ModernTreasury::Internal::Type::Enum
+
         ABA = :aba
         AU_BSB = :au_bsb
         BR_CODIGO = :br_codigo
@@ -306,7 +275,6 @@ module ModernTreasury
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end