modern_treasury 0.1.0.pre.alpha.20 → 0.1.0.pre.alpha.22

data/rbi/modern_treasury/models/payment_order.rbi

@@ -36,9 +36,9 @@ module ModernTreasury
       sig { returns(Integer) }
       attr_accessor :amount
 
-      # 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`.
+      # The party that will pay the fees for the payment order. See
+      # https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
+      # differences between the options.
       sig do
         returns(
           T.nilable(ModernTreasury::PaymentOrder::ChargeBearer::TaggedSymbol)
@@ -91,6 +91,10 @@ module ModernTreasury
       sig { returns(T.nilable(Time)) }
       attr_accessor :expires_at
 
+      # An optional user-defined 180 character unique identifier.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :external_id
+
       # If present, indicates a specific foreign exchange contract number that has been
       # generated by your financial institution.
       sig { returns(T.nilable(String)) }
@@ -304,6 +308,7 @@ module ModernTreasury
           direction: ModernTreasury::PaymentOrder::Direction::OrSymbol,
           effective_date: Date,
           expires_at: T.nilable(Time),
+          external_id: T.nilable(String),
           foreign_exchange_contract: T.nilable(String),
           foreign_exchange_indicator:
             T.nilable(
@@ -368,9 +373,9 @@ module ModernTreasury
         # Value in specified currency's smallest unit. e.g. $10 would be represented as
         # 1000 (cents). For RTP, the maximum amount allowed by the network is $100,000.
         amount:,
-        # 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`.
+        # The party that will pay the fees for the payment order. See
+        # https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
+        # differences between the options.
         charge_bearer:,
         # If the payment order is tied to a specific Counterparty, their id will appear,
         # otherwise `null`.
@@ -394,6 +399,8 @@ module ModernTreasury
         effective_date:,
         # RFP payments require an expires_at. This value must be past the effective_date.
         expires_at:,
+        # An optional user-defined 180 character unique identifier.
+        external_id:,
         # If present, indicates a specific foreign exchange contract number that has been
         # generated by your financial institution.
         foreign_exchange_contract:,
@@ -513,6 +520,7 @@ module ModernTreasury
             direction: ModernTreasury::PaymentOrder::Direction::TaggedSymbol,
             effective_date: Date,
             expires_at: T.nilable(Time),
+            external_id: T.nilable(String),
             foreign_exchange_contract: T.nilable(String),
             foreign_exchange_indicator:
               T.nilable(
@@ -611,9 +619,9 @@ module ModernTreasury
         end
       end
 
-      # 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`.
+      # The party that will pay the fees for the payment order. See
+      # https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
+      # differences between the options.
       module ChargeBearer
         extend ModernTreasury::Internal::Type::Enum
 
@@ -1044,6 +1052,16 @@ module ModernTreasury
               :column_transfer_id,
               ModernTreasury::PaymentOrder::ReferenceNumber::ReferenceNumberType::TaggedSymbol
             )
+          CROSS_RIVER_CORE_TRANSACTION_ID =
+            T.let(
+              :cross_river_core_transaction_id,
+              ModernTreasury::PaymentOrder::ReferenceNumber::ReferenceNumberType::TaggedSymbol
+            )
+          CROSS_RIVER_FED_BATCH_ID =
+            T.let(
+              :cross_river_fed_batch_id,
+              ModernTreasury::PaymentOrder::ReferenceNumber::ReferenceNumberType::TaggedSymbol
+            )
           CROSS_RIVER_PAYMENT_ID =
             T.let(
               :cross_river_payment_id,
@@ -1074,11 +1092,6 @@ module ModernTreasury
               :dc_bank_transaction_id,
               ModernTreasury::PaymentOrder::ReferenceNumber::ReferenceNumberType::TaggedSymbol
             )
-          DWOLLA_TRANSACTION_ID =
-            T.let(
-              :dwolla_transaction_id,
-              ModernTreasury::PaymentOrder::ReferenceNumber::ReferenceNumberType::TaggedSymbol
-            )
           EFT_TRACE_NUMBER =
             T.let(
               :eft_trace_number,
@@ -1129,6 +1142,16 @@ module ModernTreasury
               :goldman_sachs_unique_payment_id,
               ModernTreasury::PaymentOrder::ReferenceNumber::ReferenceNumberType::TaggedSymbol
             )
+          HIFI_OFFRAMP_ID =
+            T.let(
+              :hifi_offramp_id,
+              ModernTreasury::PaymentOrder::ReferenceNumber::ReferenceNumberType::TaggedSymbol
+            )
+          HIFI_TRANSFER_ID =
+            T.let(
+              :hifi_transfer_id,
+              ModernTreasury::PaymentOrder::ReferenceNumber::ReferenceNumberType::TaggedSymbol
+            )
           INTERAC_MESSAGE_ID =
             T.let(
               :interac_message_id,
@@ -1389,6 +1412,8 @@ module ModernTreasury
         REVERSED =
           T.let(:reversed, ModernTreasury::PaymentOrder::Status::TaggedSymbol)
         SENT = T.let(:sent, ModernTreasury::PaymentOrder::Status::TaggedSymbol)
+        STOPPED =
+          T.let(:stopped, ModernTreasury::PaymentOrder::Status::TaggedSymbol)
 
         sig do
           override.returns(

data/rbi/modern_treasury/models/payment_order_create_async_params.rbi

@@ -65,9 +65,9 @@ module ModernTreasury
       sig { returns(T.nilable(String)) }
       attr_accessor :accounting_ledger_class_id
 
-      # 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`.
+      # The party that will pay the fees for the payment order. See
+      # https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
+      # differences between the options.
       sig do
         returns(
           T.nilable(
@@ -403,9 +403,9 @@ module ModernTreasury
         # The ID of one of your accounting ledger classes. Note that these will only be
         # accessible if your accounting system has been connected.
         accounting_ledger_class_id: nil,
-        # 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`.
+        # The party that will pay the fees for the payment order. See
+        # https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
+        # differences between the options.
         charge_bearer: nil,
         # Defaults to the currency of the originating account.
         currency: nil,
@@ -649,9 +649,9 @@ module ModernTreasury
         end
       end
 
-      # 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`.
+      # The party that will pay the fees for the payment order. See
+      # https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
+      # differences between the options.
       module ChargeBearer
         extend ModernTreasury::Internal::Type::Enum
 
@@ -2211,6 +2211,11 @@ module ModernTreasury
                 :id_sknbi_code,
                 ModernTreasury::PaymentOrderCreateAsyncParams::ReceivingAccount::RoutingDetail::RoutingNumberType::TaggedSymbol
               )
+            IL_BANK_CODE =
+              T.let(
+                :il_bank_code,
+                ModernTreasury::PaymentOrderCreateAsyncParams::ReceivingAccount::RoutingDetail::RoutingNumberType::TaggedSymbol
+              )
             IN_IFSC =
               T.let(
                 :in_ifsc,

data/rbi/modern_treasury/models/payment_order_create_params.rbi

@@ -61,9 +61,9 @@ module ModernTreasury
       sig { returns(T.nilable(String)) }
       attr_accessor :accounting_ledger_class_id
 
-      # 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`.
+      # The party that will pay the fees for the payment order. See
+      # https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
+      # differences between the options.
       sig do
         returns(
           T.nilable(
@@ -415,9 +415,9 @@ module ModernTreasury
         # The ID of one of your accounting ledger classes. Note that these will only be
         # accessible if your accounting system has been connected.
         accounting_ledger_class_id: nil,
-        # 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`.
+        # The party that will pay the fees for the payment order. See
+        # https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
+        # differences between the options.
         charge_bearer: nil,
         # Defaults to the currency of the originating account.
         currency: nil,
@@ -662,9 +662,9 @@ module ModernTreasury
         end
       end
 
-      # 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`.
+      # The party that will pay the fees for the payment order. See
+      # https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
+      # differences between the options.
       module ChargeBearer
         extend ModernTreasury::Internal::Type::Enum
 
@@ -2369,6 +2369,11 @@ module ModernTreasury
                 :id_sknbi_code,
                 ModernTreasury::PaymentOrderCreateParams::ReceivingAccount::RoutingDetail::RoutingNumberType::TaggedSymbol
               )
+            IL_BANK_CODE =
+              T.let(
+                :il_bank_code,
+                ModernTreasury::PaymentOrderCreateParams::ReceivingAccount::RoutingDetail::RoutingNumberType::TaggedSymbol
+              )
             IN_IFSC =
               T.let(
                 :in_ifsc,

data/rbi/modern_treasury/models/payment_order_list_params.rbi

@@ -59,6 +59,12 @@ module ModernTreasury
       sig { params(effective_date_start: Date).void }
       attr_writer :effective_date_start
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :external_id
+
+      sig { params(external_id: String).void }
+      attr_writer :external_id
+
       # For example, if you want to query for records with metadata key `Type` and value
       # `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
       # parameters.
@@ -162,6 +168,7 @@ module ModernTreasury
           direction: ModernTreasury::TransactionDirection::OrSymbol,
           effective_date_end: Date,
           effective_date_start: Date,
+          external_id: String,
           metadata: T::Hash[Symbol, String],
           originating_account_id: String,
           per_page: Integer,
@@ -187,6 +194,7 @@ module ModernTreasury
         effective_date_end: nil,
         # An inclusive lower bound for searching effective_date
         effective_date_start: nil,
+        external_id: nil,
         # For example, if you want to query for records with metadata key `Type` and value
         # `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
         # parameters.
@@ -221,6 +229,7 @@ module ModernTreasury
             direction: ModernTreasury::TransactionDirection::OrSymbol,
             effective_date_end: Date,
             effective_date_start: Date,
+            external_id: String,
             metadata: T::Hash[Symbol, String],
             originating_account_id: String,
             per_page: Integer,
@@ -337,6 +346,11 @@ module ModernTreasury
             :sent,
             ModernTreasury::PaymentOrderListParams::Status::TaggedSymbol
           )
+        STOPPED =
+          T.let(
+            :stopped,
+            ModernTreasury::PaymentOrderListParams::Status::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/modern_treasury/models/payment_order_update_params.rbi

@@ -45,9 +45,9 @@ module ModernTreasury
       sig { params(amount: Integer).void }
       attr_writer :amount
 
-      # 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`.
+      # The party that will pay the fees for the payment order. See
+      # https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
+      # differences between the options.
       sig do
         returns(
           T.nilable(
@@ -392,9 +392,9 @@ module ModernTreasury
         # Value in specified currency's smallest unit. e.g. $10 would be represented as
         # 1000 (cents). For RTP, the maximum amount allowed by the network is $100,000.
         amount: nil,
-        # 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`.
+        # The party that will pay the fees for the payment order. See
+        # https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
+        # differences between the options.
         charge_bearer: nil,
         # Required when receiving_account_id is passed the ID of an external account.
         counterparty_id: nil,
@@ -609,9 +609,9 @@ module ModernTreasury
         end
       end
 
-      # 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`.
+      # The party that will pay the fees for the payment order. See
+      # https://docs.moderntreasury.com/payments/docs/charge-bearer to understand the
+      # differences between the options.
       module ChargeBearer
         extend ModernTreasury::Internal::Type::Enum
 
@@ -1795,6 +1795,11 @@ module ModernTreasury
                 :id_sknbi_code,
                 ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::RoutingDetail::RoutingNumberType::TaggedSymbol
               )
+            IL_BANK_CODE =
+              T.let(
+                :il_bank_code,
+                ModernTreasury::PaymentOrderUpdateParams::ReceivingAccount::RoutingDetail::RoutingNumberType::TaggedSymbol
+              )
             IN_IFSC =
               T.let(
                 :in_ifsc,
@@ -2120,6 +2125,11 @@ module ModernTreasury
             :sent,
             ModernTreasury::PaymentOrderUpdateParams::Status::TaggedSymbol
           )
+        STOPPED =
+          T.let(
+            :stopped,
+            ModernTreasury::PaymentOrderUpdateParams::Status::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/modern_treasury/models/payment_reference.rbi

@@ -210,6 +210,16 @@ module ModernTreasury
             :column_transfer_id,
             ModernTreasury::PaymentReference::ReferenceNumberType::TaggedSymbol
           )
+        CROSS_RIVER_CORE_TRANSACTION_ID =
+          T.let(
+            :cross_river_core_transaction_id,
+            ModernTreasury::PaymentReference::ReferenceNumberType::TaggedSymbol
+          )
+        CROSS_RIVER_FED_BATCH_ID =
+          T.let(
+            :cross_river_fed_batch_id,
+            ModernTreasury::PaymentReference::ReferenceNumberType::TaggedSymbol
+          )
         CROSS_RIVER_PAYMENT_ID =
           T.let(
             :cross_river_payment_id,
@@ -240,11 +250,6 @@ module ModernTreasury
             :dc_bank_transaction_id,
             ModernTreasury::PaymentReference::ReferenceNumberType::TaggedSymbol
           )
-        DWOLLA_TRANSACTION_ID =
-          T.let(
-            :dwolla_transaction_id,
-            ModernTreasury::PaymentReference::ReferenceNumberType::TaggedSymbol
-          )
         EFT_TRACE_NUMBER =
           T.let(
             :eft_trace_number,
@@ -295,6 +300,16 @@ module ModernTreasury
             :goldman_sachs_unique_payment_id,
             ModernTreasury::PaymentReference::ReferenceNumberType::TaggedSymbol
           )
+        HIFI_OFFRAMP_ID =
+          T.let(
+            :hifi_offramp_id,
+            ModernTreasury::PaymentReference::ReferenceNumberType::TaggedSymbol
+          )
+        HIFI_TRANSFER_ID =
+          T.let(
+            :hifi_transfer_id,
+            ModernTreasury::PaymentReference::ReferenceNumberType::TaggedSymbol
+          )
         INTERAC_MESSAGE_ID =
           T.let(
             :interac_message_id,

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