modern_treasury 0.1.0.pre.alpha.21 → 0.1.0

data/rbi/modern_treasury/models/return_create_params.rbi

@@ -36,6 +36,22 @@ module ModernTreasury
       end
       attr_accessor :code
 
+      # Only relevant for ACH NOC returns. This is an object containing all of the new
+      # and corrected information provided by the bank that was previously incorrect on
+      # the original outgoing payment.
+      sig do
+        returns(T.nilable(ModernTreasury::ReturnCreateParams::Corrections))
+      end
+      attr_reader :corrections
+
+      sig do
+        params(
+          corrections:
+            T.nilable(ModernTreasury::ReturnCreateParams::Corrections::OrHash)
+        ).void
+      end
+      attr_writer :corrections
+
       # The raw data from the return file that we get from the bank.
       sig { returns(T.nilable(T.anything)) }
       attr_accessor :data
@@ -57,6 +73,8 @@ module ModernTreasury
             ModernTreasury::ReturnCreateParams::ReturnableType::OrSymbol,
           additional_information: T.nilable(String),
           code: T.nilable(ModernTreasury::ReturnCreateParams::Code::OrSymbol),
+          corrections:
+            T.nilable(ModernTreasury::ReturnCreateParams::Corrections::OrHash),
           data: T.nilable(T.anything),
           date_of_death: T.nilable(Date),
           reason: T.nilable(String),
@@ -74,6 +92,10 @@ module ModernTreasury
         additional_information: nil,
         # The return code. For ACH returns, this is the required ACH return code.
         code: nil,
+        # Only relevant for ACH NOC returns. This is an object containing all of the new
+        # and corrected information provided by the bank that was previously incorrect on
+        # the original outgoing payment.
+        corrections: nil,
         # The raw data from the return file that we get from the bank.
         data: nil,
         # If the return code is `R14` or `R15` this is the date the deceased counterparty
@@ -94,6 +116,8 @@ module ModernTreasury
               ModernTreasury::ReturnCreateParams::ReturnableType::OrSymbol,
             additional_information: T.nilable(String),
             code: T.nilable(ModernTreasury::ReturnCreateParams::Code::OrSymbol),
+            corrections:
+              T.nilable(ModernTreasury::ReturnCreateParams::Corrections),
             data: T.nilable(T.anything),
             date_of_death: T.nilable(Date),
             reason: T.nilable(String),
@@ -340,6 +364,96 @@ module ModernTreasury
         def self.values
         end
       end
+
+      class Corrections < ModernTreasury::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ModernTreasury::ReturnCreateParams::Corrections,
+              ModernTreasury::Internal::AnyHash
+            )
+          end
+
+        # The updated account number that should replace the one originally used on the
+        # outgoing payment.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :account_number
+
+        # The updated company ID that should replace the one originally used on the
+        # outgoing payment.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :company_id
+
+        # The updated company name that should replace the one originally used on the
+        # outgoing payment.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :company_name
+
+        # The updated individual identification number that should replace the one
+        # originally used on the outgoing payment.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :individual_identification_number
+
+        # The updated routing number that should replace the one originally used on the
+        # outgoing payment.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :routing_number
+
+        # The updated account type code that should replace the one originally used on the
+        # outgoing payment.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :transaction_code
+
+        # Only relevant for ACH NOC returns. This is an object containing all of the new
+        # and corrected information provided by the bank that was previously incorrect on
+        # the original outgoing payment.
+        sig do
+          params(
+            account_number: T.nilable(String),
+            company_id: T.nilable(String),
+            company_name: T.nilable(String),
+            individual_identification_number: T.nilable(String),
+            routing_number: T.nilable(String),
+            transaction_code: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The updated account number that should replace the one originally used on the
+          # outgoing payment.
+          account_number: nil,
+          # The updated company ID that should replace the one originally used on the
+          # outgoing payment.
+          company_id: nil,
+          # The updated company name that should replace the one originally used on the
+          # outgoing payment.
+          company_name: nil,
+          # The updated individual identification number that should replace the one
+          # originally used on the outgoing payment.
+          individual_identification_number: nil,
+          # The updated routing number that should replace the one originally used on the
+          # outgoing payment.
+          routing_number: nil,
+          # The updated account type code that should replace the one originally used on the
+          # outgoing payment.
+          transaction_code: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              account_number: T.nilable(String),
+              company_id: T.nilable(String),
+              company_name: T.nilable(String),
+              individual_identification_number: T.nilable(String),
+              routing_number: T.nilable(String),
+              transaction_code: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/modern_treasury/models/return_list_params.rbi

@@ -46,8 +46,8 @@ module ModernTreasury
       sig { params(returnable_id: String).void }
       attr_writer :returnable_id
 
-      # One of `payment_order`, `paper_item`, `reversal`, or `incoming_payment_detail`.
-      # Must be accompanied by `returnable_id`.
+      # One of `payment_order`, `reversal`, or `incoming_payment_detail`. Must be
+      # accompanied by `returnable_id`.
       sig do
         returns(
           T.nilable(ModernTreasury::ReturnListParams::ReturnableType::OrSymbol)
@@ -86,8 +86,8 @@ module ModernTreasury
         per_page: nil,
         # The ID of a valid returnable. Must be accompanied by `returnable_type`.
         returnable_id: nil,
-        # One of `payment_order`, `paper_item`, `reversal`, or `incoming_payment_detail`.
-        # Must be accompanied by `returnable_id`.
+        # One of `payment_order`, `reversal`, or `incoming_payment_detail`. Must be
+        # accompanied by `returnable_id`.
         returnable_type: nil,
         request_options: {}
       )
@@ -110,8 +110,8 @@ module ModernTreasury
       def to_hash
       end
 
-      # One of `payment_order`, `paper_item`, `reversal`, or `incoming_payment_detail`.
-      # Must be accompanied by `returnable_id`.
+      # One of `payment_order`, `reversal`, or `incoming_payment_detail`. Must be
+      # accompanied by `returnable_id`.
       module ReturnableType
         extend ModernTreasury::Internal::Type::Enum
 
@@ -126,11 +126,6 @@ module ModernTreasury
             :incoming_payment_detail,
             ModernTreasury::ReturnListParams::ReturnableType::TaggedSymbol
           )
-        PAPER_ITEM =
-          T.let(
-            :paper_item,
-            ModernTreasury::ReturnListParams::ReturnableType::TaggedSymbol
-          )
         PAYMENT_ORDER =
           T.let(
             :payment_order,

data/rbi/modern_treasury/models/return_object.rbi

@@ -22,6 +22,20 @@ module ModernTreasury
       end
       attr_accessor :code
 
+      # Only relevant for ACH NOC returns. This is an object containing all of the new
+      # and corrected information provided by the bank that was previously incorrect on
+      # the original outgoing payment.
+      sig { returns(T.nilable(ModernTreasury::ReturnObject::Corrections)) }
+      attr_reader :corrections
+
+      sig do
+        params(
+          corrections:
+            T.nilable(ModernTreasury::ReturnObject::Corrections::OrHash)
+        ).void
+      end
+      attr_writer :corrections
+
       sig { returns(Time) }
       attr_accessor :created_at
 
@@ -127,6 +141,8 @@ module ModernTreasury
           id: String,
           amount: Integer,
           code: T.nilable(ModernTreasury::ReturnObject::Code::OrSymbol),
+          corrections:
+            T.nilable(ModernTreasury::ReturnObject::Corrections::OrHash),
           created_at: Time,
           currency: ModernTreasury::Currency::OrSymbol,
           current_return: T.nilable(ModernTreasury::ReturnObject),
@@ -160,6 +176,10 @@ module ModernTreasury
         amount:,
         # The return code. For ACH returns, this is the required ACH return code.
         code:,
+        # Only relevant for ACH NOC returns. This is an object containing all of the new
+        # and corrected information provided by the bank that was previously incorrect on
+        # the original outgoing payment.
+        corrections:,
         created_at:,
         # Currency that this transaction is denominated in.
         currency:,
@@ -216,6 +236,7 @@ module ModernTreasury
             id: String,
             amount: Integer,
             code: T.nilable(ModernTreasury::ReturnObject::Code::TaggedSymbol),
+            corrections: T.nilable(ModernTreasury::ReturnObject::Corrections),
             created_at: Time,
             currency: ModernTreasury::Currency::TaggedSymbol,
             current_return: T.nilable(ModernTreasury::ReturnObject),
@@ -375,6 +396,96 @@ module ModernTreasury
         end
       end
 
+      class Corrections < ModernTreasury::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ModernTreasury::ReturnObject::Corrections,
+              ModernTreasury::Internal::AnyHash
+            )
+          end
+
+        # The updated account number that should replace the one originally used on the
+        # outgoing payment.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :account_number
+
+        # The updated company ID that should replace the one originally used on the
+        # outgoing payment.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :company_id
+
+        # The updated company name that should replace the one originally used on the
+        # outgoing payment.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :company_name
+
+        # The updated individual identification number that should replace the one
+        # originally used on the outgoing payment.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :individual_identification_number
+
+        # The updated routing number that should replace the one originally used on the
+        # outgoing payment.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :routing_number
+
+        # The updated account type code that should replace the one originally used on the
+        # outgoing payment.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :transaction_code
+
+        # Only relevant for ACH NOC returns. This is an object containing all of the new
+        # and corrected information provided by the bank that was previously incorrect on
+        # the original outgoing payment.
+        sig do
+          params(
+            account_number: T.nilable(String),
+            company_id: T.nilable(String),
+            company_name: T.nilable(String),
+            individual_identification_number: T.nilable(String),
+            routing_number: T.nilable(String),
+            transaction_code: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The updated account number that should replace the one originally used on the
+          # outgoing payment.
+          account_number: nil,
+          # The updated company ID that should replace the one originally used on the
+          # outgoing payment.
+          company_id: nil,
+          # The updated company name that should replace the one originally used on the
+          # outgoing payment.
+          company_name: nil,
+          # The updated individual identification number that should replace the one
+          # originally used on the outgoing payment.
+          individual_identification_number: nil,
+          # The updated routing number that should replace the one originally used on the
+          # outgoing payment.
+          routing_number: nil,
+          # The updated account type code that should replace the one originally used on the
+          # outgoing payment.
+          transaction_code: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              account_number: T.nilable(String),
+              company_id: T.nilable(String),
+              company_name: T.nilable(String),
+              individual_identification_number: T.nilable(String),
+              routing_number: T.nilable(String),
+              transaction_code: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
       class ReferenceNumber < ModernTreasury::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
@@ -560,6 +671,16 @@ module ModernTreasury
               :column_transfer_id,
               ModernTreasury::ReturnObject::ReferenceNumber::ReferenceNumberType::TaggedSymbol
             )
+          CROSS_RIVER_CORE_TRANSACTION_ID =
+            T.let(
+              :cross_river_core_transaction_id,
+              ModernTreasury::ReturnObject::ReferenceNumber::ReferenceNumberType::TaggedSymbol
+            )
+          CROSS_RIVER_FED_BATCH_ID =
+            T.let(
+              :cross_river_fed_batch_id,
+              ModernTreasury::ReturnObject::ReferenceNumber::ReferenceNumberType::TaggedSymbol
+            )
           CROSS_RIVER_PAYMENT_ID =
             T.let(
               :cross_river_payment_id,
@@ -590,14 +711,24 @@ module ModernTreasury
               :dc_bank_transaction_id,
               ModernTreasury::ReturnObject::ReferenceNumber::ReferenceNumberType::TaggedSymbol
             )
-          DWOLLA_TRANSACTION_ID =
+          EFT_TRACE_NUMBER =
             T.let(
-              :dwolla_transaction_id,
+              :eft_trace_number,
               ModernTreasury::ReturnObject::ReferenceNumber::ReferenceNumberType::TaggedSymbol
             )
-          EFT_TRACE_NUMBER =
+          EVOLVE_CORE_BATCH =
             T.let(
-              :eft_trace_number,
+              :evolve_core_batch,
+              ModernTreasury::ReturnObject::ReferenceNumber::ReferenceNumberType::TaggedSymbol
+            )
+          EVOLVE_CORE_FILE_KEY =
+            T.let(
+              :evolve_core_file_key,
+              ModernTreasury::ReturnObject::ReferenceNumber::ReferenceNumberType::TaggedSymbol
+            )
+          EVOLVE_CORE_SEQ =
+            T.let(
+              :evolve_core_seq,
               ModernTreasury::ReturnObject::ReferenceNumber::ReferenceNumberType::TaggedSymbol
             )
           EVOLVE_TRANSACTION_ID =
@@ -605,6 +736,11 @@ module ModernTreasury
               :evolve_transaction_id,
               ModernTreasury::ReturnObject::ReferenceNumber::ReferenceNumberType::TaggedSymbol
             )
+          FAKE_VENDOR_PAYMENT_ID =
+            T.let(
+              :fake_vendor_payment_id,
+              ModernTreasury::ReturnObject::ReferenceNumber::ReferenceNumberType::TaggedSymbol
+            )
           FEDWIRE_IMAD =
             T.let(
               :fedwire_imad,
@@ -645,6 +781,16 @@ module ModernTreasury
               :goldman_sachs_unique_payment_id,
               ModernTreasury::ReturnObject::ReferenceNumber::ReferenceNumberType::TaggedSymbol
             )
+          HIFI_OFFRAMP_ID =
+            T.let(
+              :hifi_offramp_id,
+              ModernTreasury::ReturnObject::ReferenceNumber::ReferenceNumberType::TaggedSymbol
+            )
+          HIFI_TRANSFER_ID =
+            T.let(
+              :hifi_transfer_id,
+              ModernTreasury::ReturnObject::ReferenceNumber::ReferenceNumberType::TaggedSymbol
+            )
           INTERAC_MESSAGE_ID =
             T.let(
               :interac_message_id,
@@ -755,11 +901,6 @@ module ModernTreasury
               :rbc_wire_reference_id,
               ModernTreasury::ReturnObject::ReferenceNumber::ReferenceNumberType::TaggedSymbol
             )
-          RSPEC_VENDOR_PAYMENT_ID =
-            T.let(
-              :rspec_vendor_payment_id,
-              ModernTreasury::ReturnObject::ReferenceNumber::ReferenceNumberType::TaggedSymbol
-            )
           RTP_INSTRUCTION_ID =
             T.let(
               :rtp_instruction_id,
@@ -860,6 +1001,21 @@ module ModernTreasury
               :wells_fargo_uetr,
               ModernTreasury::ReturnObject::ReferenceNumber::ReferenceNumberType::TaggedSymbol
             )
+          WESTERN_ALLIANCE_PAYMENT_ID =
+            T.let(
+              :western_alliance_payment_id,
+              ModernTreasury::ReturnObject::ReferenceNumber::ReferenceNumberType::TaggedSymbol
+            )
+          WESTERN_ALLIANCE_TRANSACTION_ID =
+            T.let(
+              :western_alliance_transaction_id,
+              ModernTreasury::ReturnObject::ReferenceNumber::ReferenceNumberType::TaggedSymbol
+            )
+          WESTERN_ALLIANCE_WIRE_CONFIRMATION_NUMBER =
+            T.let(
+              :western_alliance_wire_confirmation_number,
+              ModernTreasury::ReturnObject::ReferenceNumber::ReferenceNumberType::TaggedSymbol
+            )
 
           sig do
             override.returns(
@@ -888,11 +1044,6 @@ module ModernTreasury
             :incoming_payment_detail,
             ModernTreasury::ReturnObject::ReturnableType::TaggedSymbol
           )
-        PAPER_ITEM =
-          T.let(
-            :paper_item,
-            ModernTreasury::ReturnObject::ReturnableType::TaggedSymbol
-          )
         PAYMENT_ORDER =
           T.let(
             :payment_order,
@@ -993,8 +1144,6 @@ module ModernTreasury
           T.let(:interac, ModernTreasury::ReturnObject::Type::TaggedSymbol)
         MANUAL =
           T.let(:manual, ModernTreasury::ReturnObject::Type::TaggedSymbol)
-        PAPER_ITEM =
-          T.let(:paper_item, ModernTreasury::ReturnObject::Type::TaggedSymbol)
         SEPA = T.let(:sepa, ModernTreasury::ReturnObject::Type::TaggedSymbol)
         WIRE = T.let(:wire, ModernTreasury::ReturnObject::Type::TaggedSymbol)
 

data/rbi/modern_treasury/models/routing_detail.rbi

@@ -14,14 +14,11 @@ module ModernTreasury
       sig { returns(String) }
       attr_accessor :id
 
-      sig { returns(T.nilable(ModernTreasury::RoutingDetail::BankAddress)) }
+      sig { returns(T.nilable(ModernTreasury::Address)) }
       attr_reader :bank_address
 
       sig do
-        params(
-          bank_address:
-            T.nilable(ModernTreasury::RoutingDetail::BankAddress::OrHash)
-        ).void
+        params(bank_address: T.nilable(ModernTreasury::Address::OrHash)).void
       end
       attr_writer :bank_address
 
@@ -70,8 +67,7 @@ module ModernTreasury
       sig do
         params(
           id: String,
-          bank_address:
-            T.nilable(ModernTreasury::RoutingDetail::BankAddress::OrHash),
+          bank_address: T.nilable(ModernTreasury::Address::OrHash),
           bank_name: String,
           created_at: Time,
           discarded_at: T.nilable(Time),
@@ -113,7 +109,7 @@ module ModernTreasury
         override.returns(
           {
             id: String,
-            bank_address: T.nilable(ModernTreasury::RoutingDetail::BankAddress),
+            bank_address: T.nilable(ModernTreasury::Address),
             bank_name: String,
             created_at: Time,
             discarded_at: T.nilable(Time),
@@ -133,111 +129,6 @@ module ModernTreasury
       def to_hash
       end
 
-      class BankAddress < ModernTreasury::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              ModernTreasury::RoutingDetail::BankAddress,
-              ModernTreasury::Internal::AnyHash
-            )
-          end
-
-        sig { returns(String) }
-        attr_accessor :id
-
-        # Country code conforms to [ISO 3166-1 alpha-2]
-        sig { returns(T.nilable(String)) }
-        attr_accessor :country
-
-        sig { returns(Time) }
-        attr_accessor :created_at
-
-        sig { returns(T.nilable(String)) }
-        attr_accessor :line1
-
-        sig { returns(T.nilable(String)) }
-        attr_accessor :line2
-
-        # This field will be true if this object exists in the live environment or false
-        # if it exists in the test environment.
-        sig { returns(T::Boolean) }
-        attr_accessor :live_mode
-
-        # Locality or City.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :locality
-
-        sig { returns(String) }
-        attr_accessor :object
-
-        # The postal code of the address.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :postal_code
-
-        # Region or State.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :region
-
-        sig { returns(Time) }
-        attr_accessor :updated_at
-
-        sig do
-          params(
-            id: String,
-            country: T.nilable(String),
-            created_at: Time,
-            line1: T.nilable(String),
-            line2: T.nilable(String),
-            live_mode: T::Boolean,
-            locality: T.nilable(String),
-            object: String,
-            postal_code: T.nilable(String),
-            region: T.nilable(String),
-            updated_at: Time
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          id:,
-          # Country code conforms to [ISO 3166-1 alpha-2]
-          country:,
-          created_at:,
-          line1:,
-          line2:,
-          # This field will be true if this object exists in the live environment or false
-          # if it exists in the test environment.
-          live_mode:,
-          # Locality or City.
-          locality:,
-          object:,
-          # The postal code of the address.
-          postal_code:,
-          # Region or State.
-          region:,
-          updated_at:
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              id: String,
-              country: T.nilable(String),
-              created_at: Time,
-              line1: T.nilable(String),
-              line2: T.nilable(String),
-              live_mode: T::Boolean,
-              locality: T.nilable(String),
-              object: String,
-              postal_code: T.nilable(String),
-              region: T.nilable(String),
-              updated_at: Time
-            }
-          )
-        end
-        def to_hash
-        end
-      end
-
       # If the routing detail is to be used for a specific payment type this field will
       # be populated, otherwise null.
       module PaymentType
@@ -457,6 +348,11 @@ module ModernTreasury
             :id_sknbi_code,
             ModernTreasury::RoutingDetail::RoutingNumberType::TaggedSymbol
           )
+        IL_BANK_CODE =
+          T.let(
+            :il_bank_code,
+            ModernTreasury::RoutingDetail::RoutingNumberType::TaggedSymbol
+          )
         IN_IFSC =
           T.let(
             :in_ifsc,

data/rbi/modern_treasury/models/routing_detail_create_params.rbi

@@ -193,6 +193,11 @@ module ModernTreasury
             :id_sknbi_code,
             ModernTreasury::RoutingDetailCreateParams::RoutingNumberType::TaggedSymbol
           )
+        IL_BANK_CODE =
+          T.let(
+            :il_bank_code,
+            ModernTreasury::RoutingDetailCreateParams::RoutingNumberType::TaggedSymbol
+          )
         IN_IFSC =
           T.let(
             :in_ifsc,