modern_treasury 0.10.0 → 0.12.0

data/rbi/modern_treasury/models/expected_payment_update_params.rbi

@@ -19,6 +19,38 @@ module ModernTreasury
       sig { returns(T.nilable(Integer)) }
       attr_accessor :amount_lower_bound
 
+      # The amount reconciled for this expected payment. Value in specified currency's
+      # smallest unit. e.g. $10 would be represented as 1000.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :amount_reconciled
+
+      # One of credit or debit. Indicates whether amount_reconciled is a credit or debit
+      # amount.
+      sig do
+        returns(
+          T.nilable(
+            ModernTreasury::ExpectedPaymentUpdateParams::AmountReconciledDirection::OrSymbol
+          )
+        )
+      end
+      attr_accessor :amount_reconciled_direction
+
+      # The amount that remains unreconciled for this expected payment. Value in
+      # specified currency's smallest unit. e.g. $10 would be represented as 1000.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :amount_unreconciled
+
+      # One of credit or debit. Indicates whether amount_unreconciled is a credit or
+      # debit amount.
+      sig do
+        returns(
+          T.nilable(
+            ModernTreasury::ExpectedPaymentUpdateParams::AmountUnreconciledDirection::OrSymbol
+          )
+        )
+      end
+      attr_accessor :amount_unreconciled_direction
+
       # The highest amount this expected payment may be equal to. Value in specified
       # currency's smallest unit. e.g. $10 would be represented as 1000.
       sig { returns(T.nilable(Integer)) }
@@ -115,6 +147,16 @@ module ModernTreasury
       sig do
         params(
           amount_lower_bound: T.nilable(Integer),
+          amount_reconciled: T.nilable(Integer),
+          amount_reconciled_direction:
+            T.nilable(
+              ModernTreasury::ExpectedPaymentUpdateParams::AmountReconciledDirection::OrSymbol
+            ),
+          amount_unreconciled: T.nilable(Integer),
+          amount_unreconciled_direction:
+            T.nilable(
+              ModernTreasury::ExpectedPaymentUpdateParams::AmountUnreconciledDirection::OrSymbol
+            ),
           amount_upper_bound: T.nilable(Integer),
           counterparty_id: T.nilable(String),
           currency: T.nilable(ModernTreasury::Currency::OrSymbol),
@@ -146,6 +188,18 @@ module ModernTreasury
         # The lowest amount this expected payment may be equal to. Value in specified
         # currency's smallest unit. e.g. $10 would be represented as 1000.
         amount_lower_bound: nil,
+        # The amount reconciled for this expected payment. Value in specified currency's
+        # smallest unit. e.g. $10 would be represented as 1000.
+        amount_reconciled: nil,
+        # One of credit or debit. Indicates whether amount_reconciled is a credit or debit
+        # amount.
+        amount_reconciled_direction: nil,
+        # The amount that remains unreconciled for this expected payment. Value in
+        # specified currency's smallest unit. e.g. $10 would be represented as 1000.
+        amount_unreconciled: nil,
+        # One of credit or debit. Indicates whether amount_unreconciled is a credit or
+        # debit amount.
+        amount_unreconciled_direction: nil,
         # The highest amount this expected payment may be equal to. Value in specified
         # currency's smallest unit. e.g. $10 would be represented as 1000.
         amount_upper_bound: nil,
@@ -198,6 +252,16 @@ module ModernTreasury
         override.returns(
           {
             amount_lower_bound: T.nilable(Integer),
+            amount_reconciled: T.nilable(Integer),
+            amount_reconciled_direction:
+              T.nilable(
+                ModernTreasury::ExpectedPaymentUpdateParams::AmountReconciledDirection::OrSymbol
+              ),
+            amount_unreconciled: T.nilable(Integer),
+            amount_unreconciled_direction:
+              T.nilable(
+                ModernTreasury::ExpectedPaymentUpdateParams::AmountUnreconciledDirection::OrSymbol
+              ),
             amount_upper_bound: T.nilable(Integer),
             counterparty_id: T.nilable(String),
             currency: T.nilable(ModernTreasury::Currency::OrSymbol),
@@ -229,6 +293,78 @@ module ModernTreasury
       def to_hash
       end
 
+      # One of credit or debit. Indicates whether amount_reconciled is a credit or debit
+      # amount.
+      module AmountReconciledDirection
+        extend ModernTreasury::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              ModernTreasury::ExpectedPaymentUpdateParams::AmountReconciledDirection
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CREDIT =
+          T.let(
+            :credit,
+            ModernTreasury::ExpectedPaymentUpdateParams::AmountReconciledDirection::TaggedSymbol
+          )
+        DEBIT =
+          T.let(
+            :debit,
+            ModernTreasury::ExpectedPaymentUpdateParams::AmountReconciledDirection::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModernTreasury::ExpectedPaymentUpdateParams::AmountReconciledDirection::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # One of credit or debit. Indicates whether amount_unreconciled is a credit or
+      # debit amount.
+      module AmountUnreconciledDirection
+        extend ModernTreasury::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              ModernTreasury::ExpectedPaymentUpdateParams::AmountUnreconciledDirection
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CREDIT =
+          T.let(
+            :credit,
+            ModernTreasury::ExpectedPaymentUpdateParams::AmountUnreconciledDirection::TaggedSymbol
+          )
+        DEBIT =
+          T.let(
+            :debit,
+            ModernTreasury::ExpectedPaymentUpdateParams::AmountUnreconciledDirection::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModernTreasury::ExpectedPaymentUpdateParams::AmountUnreconciledDirection::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
       # One of credit or debit. When you are receiving money, use credit. When you are
       # being charged, use debit.
       module Direction

data/rbi/modern_treasury/models/hold_create_params.rbi

@@ -0,0 +1,125 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class HoldCreateParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::HoldCreateParams,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
+      # The status of the hold
+      sig { returns(ModernTreasury::HoldCreateParams::Status::OrSymbol) }
+      attr_accessor :status
+
+      # The ID of the target to hold
+      sig { returns(String) }
+      attr_accessor :target_id
+
+      # The type of target to hold
+      sig { returns(ModernTreasury::HoldCreateParams::TargetType::OrSymbol) }
+      attr_accessor :target_type
+
+      # 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
+
+      sig do
+        params(
+          status: ModernTreasury::HoldCreateParams::Status::OrSymbol,
+          target_id: String,
+          target_type: ModernTreasury::HoldCreateParams::TargetType::OrSymbol,
+          metadata: T.nilable(T::Hash[Symbol, String]),
+          reason: T.nilable(String),
+          request_options: ModernTreasury::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The status of the hold
+        status:,
+        # The ID of the target to hold
+        target_id:,
+        # The type of target to hold
+        target_type:,
+        # Additional metadata for the hold
+        metadata: nil,
+        # The reason for the hold
+        reason: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            status: ModernTreasury::HoldCreateParams::Status::OrSymbol,
+            target_id: String,
+            target_type: ModernTreasury::HoldCreateParams::TargetType::OrSymbol,
+            metadata: T.nilable(T::Hash[Symbol, String]),
+            reason: T.nilable(String),
+            request_options: ModernTreasury::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The status of the hold
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ModernTreasury::HoldCreateParams::Status)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE =
+          T.let(:active, ModernTreasury::HoldCreateParams::Status::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[ModernTreasury::HoldCreateParams::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # The type of target to hold
+      module TargetType
+        extend ModernTreasury::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ModernTreasury::HoldCreateParams::TargetType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PAYMENT_ORDER =
+          T.let(
+            :payment_order,
+            ModernTreasury::HoldCreateParams::TargetType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[ModernTreasury::HoldCreateParams::TargetType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/modern_treasury/models/hold_create_response.rbi

@@ -0,0 +1,232 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class HoldCreateResponse < ModernTreasury::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::Models::HoldCreateResponse,
+            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::Models::HoldCreateResponse::Object::TaggedSymbol
+        )
+      end
+      attr_accessor :object
+
+      # The status of the hold
+      sig do
+        returns(
+          ModernTreasury::Models::HoldCreateResponse::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::Models::HoldCreateResponse::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
+
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          object: ModernTreasury::Models::HoldCreateResponse::Object::OrSymbol,
+          status: ModernTreasury::Models::HoldCreateResponse::Status::OrSymbol,
+          target_id: String,
+          target_type:
+            ModernTreasury::Models::HoldCreateResponse::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::Models::HoldCreateResponse::Object::TaggedSymbol,
+            status:
+              ModernTreasury::Models::HoldCreateResponse::Status::TaggedSymbol,
+            target_id: String,
+            target_type:
+              ModernTreasury::Models::HoldCreateResponse::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::Models::HoldCreateResponse::Object)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        HOLD =
+          T.let(
+            :hold,
+            ModernTreasury::Models::HoldCreateResponse::Object::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModernTreasury::Models::HoldCreateResponse::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::Models::HoldCreateResponse::Status)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE =
+          T.let(
+            :active,
+            ModernTreasury::Models::HoldCreateResponse::Status::TaggedSymbol
+          )
+        RESOLVED =
+          T.let(
+            :resolved,
+            ModernTreasury::Models::HoldCreateResponse::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModernTreasury::Models::HoldCreateResponse::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::Models::HoldCreateResponse::TargetType
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PAYMENT_ORDER =
+          T.let(
+            :payment_order,
+            ModernTreasury::Models::HoldCreateResponse::TargetType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              ModernTreasury::Models::HoldCreateResponse::TargetType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/modern_treasury/models/hold_list_params.rbi

@@ -0,0 +1,150 @@
+# typed: strong
+
+module ModernTreasury
+  module Models
+    class HoldListParams < ModernTreasury::Internal::Type::BaseModel
+      extend ModernTreasury::Internal::Type::RequestParameters::Converter
+      include ModernTreasury::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            ModernTreasury::HoldListParams,
+            ModernTreasury::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :after_cursor
+
+      # 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.
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :metadata
+
+      sig { params(metadata: T::Hash[Symbol, String]).void }
+      attr_writer :metadata
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :per_page
+
+      sig { params(per_page: Integer).void }
+      attr_writer :per_page
+
+      # Translation missing: en.openapi.descriptions.payment_order.query_params.status
+      sig do
+        returns(T.nilable(ModernTreasury::HoldListParams::Status::OrSymbol))
+      end
+      attr_accessor :status
+
+      # Translation missing:
+      # en.openapi.descriptions.payment_order.query_params.target_id
+      sig { returns(T.nilable(String)) }
+      attr_accessor :target_id
+
+      # Translation missing:
+      # en.openapi.descriptions.payment_order.query_params.target_type
+      sig do
+        returns(T.nilable(ModernTreasury::HoldListParams::TargetType::OrSymbol))
+      end
+      attr_accessor :target_type
+
+      sig do
+        params(
+          after_cursor: T.nilable(String),
+          metadata: T::Hash[Symbol, String],
+          per_page: Integer,
+          status: T.nilable(ModernTreasury::HoldListParams::Status::OrSymbol),
+          target_id: T.nilable(String),
+          target_type:
+            T.nilable(ModernTreasury::HoldListParams::TargetType::OrSymbol),
+          request_options: ModernTreasury::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        after_cursor: 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.
+        metadata: nil,
+        per_page: nil,
+        # Translation missing: en.openapi.descriptions.payment_order.query_params.status
+        status: nil,
+        # Translation missing:
+        # en.openapi.descriptions.payment_order.query_params.target_id
+        target_id: nil,
+        # Translation missing:
+        # en.openapi.descriptions.payment_order.query_params.target_type
+        target_type: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            after_cursor: T.nilable(String),
+            metadata: T::Hash[Symbol, String],
+            per_page: Integer,
+            status: T.nilable(ModernTreasury::HoldListParams::Status::OrSymbol),
+            target_id: T.nilable(String),
+            target_type:
+              T.nilable(ModernTreasury::HoldListParams::TargetType::OrSymbol),
+            request_options: ModernTreasury::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Translation missing: en.openapi.descriptions.payment_order.query_params.status
+      module Status
+        extend ModernTreasury::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, ModernTreasury::HoldListParams::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ACTIVE =
+          T.let(:active, ModernTreasury::HoldListParams::Status::TaggedSymbol)
+        RESOLVED =
+          T.let(:resolved, ModernTreasury::HoldListParams::Status::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[ModernTreasury::HoldListParams::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Translation missing:
+      # en.openapi.descriptions.payment_order.query_params.target_type
+      module TargetType
+        extend ModernTreasury::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, ModernTreasury::HoldListParams::TargetType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PAYMENT_ORDER =
+          T.let(
+            :payment_order,
+            ModernTreasury::HoldListParams::TargetType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[ModernTreasury::HoldListParams::TargetType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end