modern_treasury 0.6.0 → 0.8.0

data/rbi/modern_treasury/models/payment_order.rbi

@@ -58,6 +58,19 @@ module ModernTreasury
       sig { returns(ModernTreasury::Currency::TaggedSymbol) }
       attr_accessor :currency
 
+      # If the payment order's status is `held`, this will include the hold object's
+      # data.
+      sig { returns(T.nilable(ModernTreasury::PaymentOrder::CurrentHold)) }
+      attr_reader :current_hold
+
+      sig do
+        params(
+          current_hold:
+            T.nilable(ModernTreasury::PaymentOrder::CurrentHold::OrHash)
+        ).void
+      end
+      attr_writer :current_hold
+
       # If the payment order's status is `returned`, this will include the return
       # object's data.
       sig { returns(T.nilable(ModernTreasury::ReturnObject)) }
@@ -188,6 +201,14 @@ module ModernTreasury
       end
       attr_accessor :receiving_account_type
 
+      # One of `unreconciled`, `tentatively_reconciled` or `reconciled`.
+      sig do
+        returns(
+          ModernTreasury::PaymentOrder::ReconciliationStatus::TaggedSymbol
+        )
+      end
+      attr_accessor :reconciliation_status
+
       sig { returns(T::Array[ModernTreasury::PaymentOrder::ReferenceNumber]) }
       attr_accessor :reference_numbers
 
@@ -301,6 +322,8 @@ module ModernTreasury
           counterparty_id: T.nilable(String),
           created_at: Time,
           currency: ModernTreasury::Currency::OrSymbol,
+          current_hold:
+            T.nilable(ModernTreasury::PaymentOrder::CurrentHold::OrHash),
           current_return: T.nilable(ModernTreasury::ReturnObject::OrHash),
           description: T.nilable(String),
           direction: ModernTreasury::PaymentOrder::Direction::OrSymbol,
@@ -327,6 +350,8 @@ module ModernTreasury
           receiving_account_id: String,
           receiving_account_type:
             ModernTreasury::PaymentOrder::ReceivingAccountType::OrSymbol,
+          reconciliation_status:
+            ModernTreasury::PaymentOrder::ReconciliationStatus::OrSymbol,
           reference_numbers:
             T::Array[ModernTreasury::PaymentOrder::ReferenceNumber::OrHash],
           remittance_information: T.nilable(String),
@@ -379,6 +404,9 @@ module ModernTreasury
         created_at:,
         # Defaults to the currency of the originating account.
         currency:,
+        # If the payment order's status is `held`, this will include the hold object's
+        # data.
+        current_hold:,
         # If the payment order's status is `returned`, this will include the return
         # object's data.
         current_return:,
@@ -442,6 +470,8 @@ module ModernTreasury
         # The receiving account ID. Can be an `external_account` or `internal_account`.
         receiving_account_id:,
         receiving_account_type:,
+        # One of `unreconciled`, `tentatively_reconciled` or `reconciled`.
+        reconciliation_status:,
         reference_numbers:,
         # For `ach`, this field will be passed through on an addenda record. For `wire`
         # payments the field will be passed through as the "Originator to Beneficiary
@@ -511,6 +541,7 @@ module ModernTreasury
             counterparty_id: T.nilable(String),
             created_at: Time,
             currency: ModernTreasury::Currency::TaggedSymbol,
+            current_hold: T.nilable(ModernTreasury::PaymentOrder::CurrentHold),
             current_return: T.nilable(ModernTreasury::ReturnObject),
             description: T.nilable(String),
             direction: ModernTreasury::PaymentOrder::Direction::TaggedSymbol,
@@ -537,6 +568,8 @@ module ModernTreasury
             receiving_account_id: String,
             receiving_account_type:
               ModernTreasury::PaymentOrder::ReceivingAccountType::TaggedSymbol,
+            reconciliation_status:
+              ModernTreasury::PaymentOrder::ReconciliationStatus::TaggedSymbol,
             reference_numbers:
               T::Array[ModernTreasury::PaymentOrder::ReferenceNumber],
             remittance_information: T.nilable(String),
@@ -652,6 +685,235 @@ module ModernTreasury
         end
       end
 
+      class CurrentHold < ModernTreasury::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ModernTreasury::PaymentOrder::CurrentHold,
+              ModernTreasury::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # The type of object
+        sig do
+          returns(
+            ModernTreasury::PaymentOrder::CurrentHold::Object::TaggedSymbol
+          )
+        end
+        attr_accessor :object
+
+        # The status of the hold
+        sig do
+          returns(
+            ModernTreasury::PaymentOrder::CurrentHold::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        # The ID of the target being held
+        sig { returns(String) }
+        attr_accessor :target_id
+
+        # The type of target being held
+        sig do
+          returns(
+            ModernTreasury::PaymentOrder::CurrentHold::TargetType::TaggedSymbol
+          )
+        end
+        attr_accessor :target_type
+
+        sig { returns(Time) }
+        attr_accessor :updated_at
+
+        # 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.nilable(T::Boolean)) }
+        attr_reader :live_mode
+
+        sig { params(live_mode: T::Boolean).void }
+        attr_writer :live_mode
+
+        # Additional metadata for the hold
+        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        attr_accessor :metadata
+
+        # The reason for the hold
+        sig { returns(T.nilable(String)) }
+        attr_accessor :reason
+
+        # The resolution of the hold
+        sig { returns(T.nilable(String)) }
+        attr_accessor :resolution
+
+        # When the hold was resolved
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :resolved_at
+
+        # If the payment order's status is `held`, this will include the hold object's
+        # data.
+        sig do
+          params(
+            id: String,
+            created_at: Time,
+            object: ModernTreasury::PaymentOrder::CurrentHold::Object::OrSymbol,
+            status: ModernTreasury::PaymentOrder::CurrentHold::Status::OrSymbol,
+            target_id: String,
+            target_type:
+              ModernTreasury::PaymentOrder::CurrentHold::TargetType::OrSymbol,
+            updated_at: Time,
+            live_mode: T::Boolean,
+            metadata: T.nilable(T::Hash[Symbol, String]),
+            reason: T.nilable(String),
+            resolution: T.nilable(String),
+            resolved_at: T.nilable(Time)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          created_at:,
+          # The type of object
+          object:,
+          # The status of the hold
+          status:,
+          # The ID of the target being held
+          target_id:,
+          # The type of target being held
+          target_type:,
+          updated_at:,
+          # This field will be true if this object exists in the live environment or false
+          # if it exists in the test environment.
+          live_mode: nil,
+          # Additional metadata for the hold
+          metadata: nil,
+          # The reason for the hold
+          reason: nil,
+          # The resolution of the hold
+          resolution: nil,
+          # When the hold was resolved
+          resolved_at: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Time,
+              object:
+                ModernTreasury::PaymentOrder::CurrentHold::Object::TaggedSymbol,
+              status:
+                ModernTreasury::PaymentOrder::CurrentHold::Status::TaggedSymbol,
+              target_id: String,
+              target_type:
+                ModernTreasury::PaymentOrder::CurrentHold::TargetType::TaggedSymbol,
+              updated_at: Time,
+              live_mode: T::Boolean,
+              metadata: T.nilable(T::Hash[Symbol, String]),
+              reason: T.nilable(String),
+              resolution: T.nilable(String),
+              resolved_at: T.nilable(Time)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The type of object
+        module Object
+          extend ModernTreasury::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, ModernTreasury::PaymentOrder::CurrentHold::Object)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          HOLD =
+            T.let(
+              :hold,
+              ModernTreasury::PaymentOrder::CurrentHold::Object::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ModernTreasury::PaymentOrder::CurrentHold::Object::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # The status of the hold
+        module Status
+          extend ModernTreasury::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, ModernTreasury::PaymentOrder::CurrentHold::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ACTIVE =
+            T.let(
+              :active,
+              ModernTreasury::PaymentOrder::CurrentHold::Status::TaggedSymbol
+            )
+          RESOLVED =
+            T.let(
+              :resolved,
+              ModernTreasury::PaymentOrder::CurrentHold::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ModernTreasury::PaymentOrder::CurrentHold::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # The type of target being held
+        module TargetType
+          extend ModernTreasury::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ModernTreasury::PaymentOrder::CurrentHold::TargetType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PAYMENT_ORDER =
+            T.let(
+              :payment_order,
+              ModernTreasury::PaymentOrder::CurrentHold::TargetType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ModernTreasury::PaymentOrder::CurrentHold::TargetType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
       # 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,
@@ -771,6 +1033,43 @@ module ModernTreasury
         end
       end
 
+      # One of `unreconciled`, `tentatively_reconciled` or `reconciled`.
+      module ReconciliationStatus
+        extend ModernTreasury::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ModernTreasury::PaymentOrder::ReconciliationStatus)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        UNRECONCILED =
+          T.let(
+            :unreconciled,
+            ModernTreasury::PaymentOrder::ReconciliationStatus::TaggedSymbol
+          )
+        TENTATIVELY_RECONCILED =
+          T.let(
+            :tentatively_reconciled,
+            ModernTreasury::PaymentOrder::ReconciliationStatus::TaggedSymbol
+          )
+        RECONCILED =
+          T.let(
+            :reconciled,
+            ModernTreasury::PaymentOrder::ReconciliationStatus::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModernTreasury::PaymentOrder::ReconciliationStatus::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
       class ReferenceNumber < ModernTreasury::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
@@ -916,21 +1215,6 @@ module ModernTreasury
               :brale_transfer_id,
               ModernTreasury::PaymentOrder::ReferenceNumber::ReferenceNumberType::TaggedSymbol
             )
-          BRIDGE_DESTINATION_TRANSACTION_HASH =
-            T.let(
-              :bridge_destination_transaction_hash,
-              ModernTreasury::PaymentOrder::ReferenceNumber::ReferenceNumberType::TaggedSymbol
-            )
-          BRIDGE_SOURCE_TRANSACTION_HASH =
-            T.let(
-              :bridge_source_transaction_hash,
-              ModernTreasury::PaymentOrder::ReferenceNumber::ReferenceNumberType::TaggedSymbol
-            )
-          BRIDGE_TRANSFER_ID =
-            T.let(
-              :bridge_transfer_id,
-              ModernTreasury::PaymentOrder::ReferenceNumber::ReferenceNumberType::TaggedSymbol
-            )
           CHECK_NUMBER =
             T.let(
               :check_number,
@@ -1146,6 +1430,11 @@ module ModernTreasury
               :lob_check_id,
               ModernTreasury::PaymentOrder::ReferenceNumber::ReferenceNumberType::TaggedSymbol
             )
+          MT_FOF_TRANSFER_ID =
+            T.let(
+              :mt_fof_transfer_id,
+              ModernTreasury::PaymentOrder::ReferenceNumber::ReferenceNumberType::TaggedSymbol
+            )
           OTHER =
             T.let(
               :other,
@@ -1337,6 +1626,7 @@ module ModernTreasury
           T.let(:denied, ModernTreasury::PaymentOrder::Status::TaggedSymbol)
         FAILED =
           T.let(:failed, ModernTreasury::PaymentOrder::Status::TaggedSymbol)
+        HELD = T.let(:held, ModernTreasury::PaymentOrder::Status::TaggedSymbol)
         NEEDS_APPROVAL =
           T.let(
             :needs_approval,

data/rbi/modern_treasury/models/payment_order_create_async_params.rbi

@@ -269,6 +269,24 @@ module ModernTreasury
       sig { params(receiving_account_id: String).void }
       attr_writer :receiving_account_id
 
+      # One of `unreconciled`, `tentatively_reconciled` or `reconciled`.
+      sig do
+        returns(
+          T.nilable(
+            ModernTreasury::PaymentOrderCreateAsyncParams::ReconciliationStatus::OrSymbol
+          )
+        )
+      end
+      attr_reader :reconciliation_status
+
+      sig do
+        params(
+          reconciliation_status:
+            ModernTreasury::PaymentOrderCreateAsyncParams::ReconciliationStatus::OrSymbol
+        ).void
+      end
+      attr_writer :reconciliation_status
+
       # For `ach`, this field will be passed through on an addenda record. For `wire`
       # payments the field will be passed through as the "Originator to Beneficiary
       # Information", also known as OBI or Fedwire tag 6000.
@@ -363,6 +381,8 @@ module ModernTreasury
           receiving_account:
             ModernTreasury::PaymentOrderCreateAsyncParams::ReceivingAccount::OrHash,
           receiving_account_id: String,
+          reconciliation_status:
+            ModernTreasury::PaymentOrderCreateAsyncParams::ReconciliationStatus::OrSymbol,
           remittance_information: T.nilable(String),
           send_remittance_advice: T.nilable(T::Boolean),
           statement_descriptor: T.nilable(String),
@@ -467,6 +487,8 @@ module ModernTreasury
         # `receiving_account_id`, you may pass the id of an external account or an
         # internal account.
         receiving_account_id: nil,
+        # One of `unreconciled`, `tentatively_reconciled` or `reconciled`.
+        reconciliation_status: nil,
         # For `ach`, this field will be passed through on an addenda record. For `wire`
         # payments the field will be passed through as the "Originator to Beneficiary
         # Information", also known as OBI or Fedwire tag 6000.
@@ -542,6 +564,8 @@ module ModernTreasury
             receiving_account:
               ModernTreasury::PaymentOrderCreateAsyncParams::ReceivingAccount,
             receiving_account_id: String,
+            reconciliation_status:
+              ModernTreasury::PaymentOrderCreateAsyncParams::ReconciliationStatus::OrSymbol,
             remittance_information: T.nilable(String),
             send_remittance_advice: T.nilable(T::Boolean),
             statement_descriptor: T.nilable(String),
@@ -1681,6 +1705,46 @@ module ModernTreasury
           end
         end
       end
+
+      # One of `unreconciled`, `tentatively_reconciled` or `reconciled`.
+      module ReconciliationStatus
+        extend ModernTreasury::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              ModernTreasury::PaymentOrderCreateAsyncParams::ReconciliationStatus
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        UNRECONCILED =
+          T.let(
+            :unreconciled,
+            ModernTreasury::PaymentOrderCreateAsyncParams::ReconciliationStatus::TaggedSymbol
+          )
+        TENTATIVELY_RECONCILED =
+          T.let(
+            :tentatively_reconciled,
+            ModernTreasury::PaymentOrderCreateAsyncParams::ReconciliationStatus::TaggedSymbol
+          )
+        RECONCILED =
+          T.let(
+            :reconciled,
+            ModernTreasury::PaymentOrderCreateAsyncParams::ReconciliationStatus::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModernTreasury::PaymentOrderCreateAsyncParams::ReconciliationStatus::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/modern_treasury/models/payment_order_create_params.rbi

@@ -279,6 +279,24 @@ module ModernTreasury
       sig { params(receiving_account_id: String).void }
       attr_writer :receiving_account_id
 
+      # One of `unreconciled`, `tentatively_reconciled` or `reconciled`.
+      sig do
+        returns(
+          T.nilable(
+            ModernTreasury::PaymentOrderCreateParams::ReconciliationStatus::OrSymbol
+          )
+        )
+      end
+      attr_reader :reconciliation_status
+
+      sig do
+        params(
+          reconciliation_status:
+            ModernTreasury::PaymentOrderCreateParams::ReconciliationStatus::OrSymbol
+        ).void
+      end
+      attr_writer :reconciliation_status
+
       # For `ach`, this field will be passed through on an addenda record. For `wire`
       # payments the field will be passed through as the "Originator to Beneficiary
       # Information", also known as OBI or Fedwire tag 6000.
@@ -377,6 +395,8 @@ module ModernTreasury
           receiving_account:
             ModernTreasury::PaymentOrderCreateParams::ReceivingAccount::OrHash,
           receiving_account_id: String,
+          reconciliation_status:
+            ModernTreasury::PaymentOrderCreateParams::ReconciliationStatus::OrSymbol,
           remittance_information: T.nilable(String),
           send_remittance_advice: T.nilable(T::Boolean),
           statement_descriptor: T.nilable(String),
@@ -484,6 +504,8 @@ module ModernTreasury
         # `receiving_account_id`, you may pass the id of an external account or an
         # internal account.
         receiving_account_id: nil,
+        # One of `unreconciled`, `tentatively_reconciled` or `reconciled`.
+        reconciliation_status: nil,
         # For `ach`, this field will be passed through on an addenda record. For `wire`
         # payments the field will be passed through as the "Originator to Beneficiary
         # Information", also known as OBI or Fedwire tag 6000.
@@ -560,6 +582,8 @@ module ModernTreasury
             receiving_account:
               ModernTreasury::PaymentOrderCreateParams::ReceivingAccount,
             receiving_account_id: String,
+            reconciliation_status:
+              ModernTreasury::PaymentOrderCreateParams::ReconciliationStatus::OrSymbol,
             remittance_information: T.nilable(String),
             send_remittance_advice: T.nilable(T::Boolean),
             statement_descriptor: T.nilable(String),
@@ -1831,6 +1855,46 @@ module ModernTreasury
           end
         end
       end
+
+      # One of `unreconciled`, `tentatively_reconciled` or `reconciled`.
+      module ReconciliationStatus
+        extend ModernTreasury::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              ModernTreasury::PaymentOrderCreateParams::ReconciliationStatus
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        UNRECONCILED =
+          T.let(
+            :unreconciled,
+            ModernTreasury::PaymentOrderCreateParams::ReconciliationStatus::TaggedSymbol
+          )
+        TENTATIVELY_RECONCILED =
+          T.let(
+            :tentatively_reconciled,
+            ModernTreasury::PaymentOrderCreateParams::ReconciliationStatus::TaggedSymbol
+          )
+        RECONCILED =
+          T.let(
+            :reconciled,
+            ModernTreasury::PaymentOrderCreateParams::ReconciliationStatus::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModernTreasury::PaymentOrderCreateParams::ReconciliationStatus::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/modern_treasury/models/payment_order_list_params.rbi

@@ -316,6 +316,11 @@ module ModernTreasury
             :failed,
             ModernTreasury::PaymentOrderListParams::Status::TaggedSymbol
           )
+        HELD =
+          T.let(
+            :held,
+            ModernTreasury::PaymentOrderListParams::Status::TaggedSymbol
+          )
         NEEDS_APPROVAL =
           T.let(
             :needs_approval,