increase 1.216.0 → 1.217.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a628b50c55d8f6d163404911418ff80453d85aeea98a4050a45baa34e6d1446a
-  data.tar.gz: a21df46d8d42efaa4942f1f48ef3fb609cb2ebf0de82f9ff12028220d8693631
+  metadata.gz: 26a77a23dc8c764bfa79aaa005456d2cffbcdc060e06c2a173633f60c786dfcc
+  data.tar.gz: 44b3637ec3aa79d2c92425d060e29b504447e13c37ce53856fde6519d910c582
 SHA512:
-  metadata.gz: 8b1db45353a1242ca57c68ca968cc34637eb334ec4647bf8e9176dc13acce01eac05d4b9e985ed6f7d9addcfa1f3a1ba4fa0c847dc506e2a0992c6535a1bf0bb
-  data.tar.gz: c9693477421ba34c0b2bb66a262f302dcf11bf2019eb8baaa47d1afb449cbf932b3d4d497a50490d891b69f396d6b17df29af7904addba0d2ebbe27ad19c33ac
+  metadata.gz: 367227a99e017c597f780711ff82345674734e5bbe07654c976bfc59fd0198148339c004ba9937b34c60f1194f6166c2a589f30db1062366a65a4c9f35888a11
+  data.tar.gz: 57988c078c09701afeb9a42f75872afc0ece49731cd38a9cae16ddfcd6cda8b19ee98e332015a9ddc7d5b1c1b3b8a162a40abf6419d68ae5c5a8f63bb92aefc3

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.217.0 (2026-03-02)
+
+Full Changelog: [v1.216.0...v1.217.0](https://github.com/Increase/increase-ruby/compare/v1.216.0...v1.217.0)
+
+### Features
+
+* **api:** api update ([e890f47](https://github.com/Increase/increase-ruby/commit/e890f473afbe526a119d61b8a356177ca5bf4d95))
+
 ## 1.216.0 (2026-03-02)
 
 Full Changelog: [v1.215.0...v1.216.0](https://github.com/Increase/increase-ruby/compare/v1.215.0...v1.216.0)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "increase", "~> 1.216.0"
+gem "increase", "~> 1.217.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/increase/models/check_deposit.rb

@@ -42,6 +42,14 @@ module Increase
       #   @return [Increase::Models::CheckDeposit::DepositAcceptance, nil]
       required :deposit_acceptance, -> { Increase::CheckDeposit::DepositAcceptance }, nil?: true
 
+      # @!attribute deposit_adjustments
+      #   If the deposit or the return was adjusted by the receiving institution, this
+      #   will contain details of the adjustments.
+      #
+      #   @return [Array<Increase::Models::CheckDeposit::DepositAdjustment>]
+      required :deposit_adjustments,
+               -> { Increase::Internal::Type::ArrayOf[Increase::CheckDeposit::DepositAdjustment] }
+
       # @!attribute deposit_rejection
       #   If your deposit is rejected by Increase, this will contain details as to why it
       #   was rejected.
@@ -123,7 +131,7 @@ module Increase
       #   @return [Symbol, Increase::Models::CheckDeposit::Type]
       required :type, enum: -> { Increase::CheckDeposit::Type }
 
-      # @!method initialize(id:, account_id:, amount:, back_image_file_id:, created_at:, deposit_acceptance:, deposit_rejection:, deposit_return:, deposit_submission:, description:, front_image_file_id:, idempotency_key:, inbound_funds_hold:, inbound_mail_item_id:, lockbox_id:, status:, transaction_id:, type:)
+      # @!method initialize(id:, account_id:, amount:, back_image_file_id:, created_at:, deposit_acceptance:, deposit_adjustments:, deposit_rejection:, deposit_return:, deposit_submission:, description:, front_image_file_id:, idempotency_key:, inbound_funds_hold:, inbound_mail_item_id:, lockbox_id:, status:, transaction_id:, type:)
       #   Some parameter documentations has been truncated, see
       #   {Increase::Models::CheckDeposit} for more details.
       #
@@ -141,6 +149,8 @@ module Increase
       #
       #   @param deposit_acceptance [Increase::Models::CheckDeposit::DepositAcceptance, nil] Once your deposit is successfully parsed and accepted by Increase, this will con
       #
+      #   @param deposit_adjustments [Array<Increase::Models::CheckDeposit::DepositAdjustment>] If the deposit or the return was adjusted by the receiving institution, this wil
+      #
       #   @param deposit_rejection [Increase::Models::CheckDeposit::DepositRejection, nil] If your deposit is rejected by Increase, this will contain details as to why it
       #
       #   @param deposit_return [Increase::Models::CheckDeposit::DepositReturn, nil] If your deposit is returned, this will contain details as to why it was returned
@@ -251,6 +261,66 @@ module Increase
         end
       end
 
+      class DepositAdjustment < Increase::Internal::Type::BaseModel
+        # @!attribute adjusted_at
+        #   The time at which the adjustment was received.
+        #
+        #   @return [Time]
+        required :adjusted_at, Time
+
+        # @!attribute amount
+        #   The amount of the adjustment.
+        #
+        #   @return [Integer]
+        required :amount, Integer
+
+        # @!attribute reason
+        #   The reason for the adjustment.
+        #
+        #   @return [Symbol, Increase::Models::CheckDeposit::DepositAdjustment::Reason]
+        required :reason, enum: -> { Increase::CheckDeposit::DepositAdjustment::Reason }
+
+        # @!attribute transaction_id
+        #   The id of the transaction for the adjustment.
+        #
+        #   @return [String]
+        required :transaction_id, String
+
+        # @!method initialize(adjusted_at:, amount:, reason:, transaction_id:)
+        #   @param adjusted_at [Time] The time at which the adjustment was received.
+        #
+        #   @param amount [Integer] The amount of the adjustment.
+        #
+        #   @param reason [Symbol, Increase::Models::CheckDeposit::DepositAdjustment::Reason] The reason for the adjustment.
+        #
+        #   @param transaction_id [String] The id of the transaction for the adjustment.
+
+        # The reason for the adjustment.
+        #
+        # @see Increase::Models::CheckDeposit::DepositAdjustment#reason
+        module Reason
+          extend Increase::Internal::Type::Enum
+
+          # The return was initiated too late and the receiving institution has responded with a Late Return Claim.
+          LATE_RETURN = :late_return
+
+          # The check was deposited to the wrong payee and the depositing institution has reimbursed the funds with a Wrong Payee Credit.
+          WRONG_PAYEE_CREDIT = :wrong_payee_credit
+
+          # The check was deposited with a different amount than what was written on the check.
+          ADJUSTED_AMOUNT = :adjusted_amount
+
+          # The recipient was not able to process the check. This usually happens for e.g., low quality images.
+          NON_CONFORMING_ITEM = :non_conforming_item
+
+          # The check has already been deposited elsewhere and so this is a duplicate.
+          PAID = :paid
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
       # @see Increase::Models::CheckDeposit#deposit_rejection
       class DepositRejection < Increase::Internal::Type::BaseModel
         # @!attribute amount

data/lib/increase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Increase
-  VERSION = "1.216.0"
+  VERSION = "1.217.0"
 end

data/rbi/increase/models/check_deposit.rbi

@@ -42,6 +42,11 @@ module Increase
       end
       attr_writer :deposit_acceptance
 
+      # If the deposit or the return was adjusted by the receiving institution, this
+      # will contain details of the adjustments.
+      sig { returns(T::Array[Increase::CheckDeposit::DepositAdjustment]) }
+      attr_accessor :deposit_adjustments
+
       # If your deposit is rejected by Increase, this will contain details as to why it
       # was rejected.
       sig { returns(T.nilable(Increase::CheckDeposit::DepositRejection)) }
@@ -141,6 +146,8 @@ module Increase
           created_at: Time,
           deposit_acceptance:
             T.nilable(Increase::CheckDeposit::DepositAcceptance::OrHash),
+          deposit_adjustments:
+            T::Array[Increase::CheckDeposit::DepositAdjustment::OrHash],
           deposit_rejection:
             T.nilable(Increase::CheckDeposit::DepositRejection::OrHash),
           deposit_return:
@@ -174,6 +181,9 @@ module Increase
         # Once your deposit is successfully parsed and accepted by Increase, this will
         # contain details of the parsed check.
         deposit_acceptance:,
+        # If the deposit or the return was adjusted by the receiving institution, this
+        # will contain details of the adjustments.
+        deposit_adjustments:,
         # If your deposit is rejected by Increase, this will contain details as to why it
         # was rejected.
         deposit_rejection:,
@@ -220,6 +230,8 @@ module Increase
             created_at: Time,
             deposit_acceptance:
               T.nilable(Increase::CheckDeposit::DepositAcceptance),
+            deposit_adjustments:
+              T::Array[Increase::CheckDeposit::DepositAdjustment],
             deposit_rejection:
               T.nilable(Increase::CheckDeposit::DepositRejection),
             deposit_return: T.nilable(Increase::CheckDeposit::DepositReturn),
@@ -373,6 +385,126 @@ module Increase
         end
       end
 
+      class DepositAdjustment < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::CheckDeposit::DepositAdjustment,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The time at which the adjustment was received.
+        sig { returns(Time) }
+        attr_accessor :adjusted_at
+
+        # The amount of the adjustment.
+        sig { returns(Integer) }
+        attr_accessor :amount
+
+        # The reason for the adjustment.
+        sig do
+          returns(
+            Increase::CheckDeposit::DepositAdjustment::Reason::TaggedSymbol
+          )
+        end
+        attr_accessor :reason
+
+        # The id of the transaction for the adjustment.
+        sig { returns(String) }
+        attr_accessor :transaction_id
+
+        sig do
+          params(
+            adjusted_at: Time,
+            amount: Integer,
+            reason: Increase::CheckDeposit::DepositAdjustment::Reason::OrSymbol,
+            transaction_id: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The time at which the adjustment was received.
+          adjusted_at:,
+          # The amount of the adjustment.
+          amount:,
+          # The reason for the adjustment.
+          reason:,
+          # The id of the transaction for the adjustment.
+          transaction_id:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              adjusted_at: Time,
+              amount: Integer,
+              reason:
+                Increase::CheckDeposit::DepositAdjustment::Reason::TaggedSymbol,
+              transaction_id: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The reason for the adjustment.
+        module Reason
+          extend Increase::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Increase::CheckDeposit::DepositAdjustment::Reason)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # The return was initiated too late and the receiving institution has responded with a Late Return Claim.
+          LATE_RETURN =
+            T.let(
+              :late_return,
+              Increase::CheckDeposit::DepositAdjustment::Reason::TaggedSymbol
+            )
+
+          # The check was deposited to the wrong payee and the depositing institution has reimbursed the funds with a Wrong Payee Credit.
+          WRONG_PAYEE_CREDIT =
+            T.let(
+              :wrong_payee_credit,
+              Increase::CheckDeposit::DepositAdjustment::Reason::TaggedSymbol
+            )
+
+          # The check was deposited with a different amount than what was written on the check.
+          ADJUSTED_AMOUNT =
+            T.let(
+              :adjusted_amount,
+              Increase::CheckDeposit::DepositAdjustment::Reason::TaggedSymbol
+            )
+
+          # The recipient was not able to process the check. This usually happens for e.g., low quality images.
+          NON_CONFORMING_ITEM =
+            T.let(
+              :non_conforming_item,
+              Increase::CheckDeposit::DepositAdjustment::Reason::TaggedSymbol
+            )
+
+          # The check has already been deposited elsewhere and so this is a duplicate.
+          PAID =
+            T.let(
+              :paid,
+              Increase::CheckDeposit::DepositAdjustment::Reason::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Increase::CheckDeposit::DepositAdjustment::Reason::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
       class DepositRejection < Increase::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

data/sig/increase/models/check_deposit.rbs

@@ -8,6 +8,7 @@ module Increase
         back_image_file_id: String?,
         created_at: Time,
         deposit_acceptance: Increase::CheckDeposit::DepositAcceptance?,
+        deposit_adjustments: ::Array[Increase::CheckDeposit::DepositAdjustment],
         deposit_rejection: Increase::CheckDeposit::DepositRejection?,
         deposit_return: Increase::CheckDeposit::DepositReturn?,
         deposit_submission: Increase::CheckDeposit::DepositSubmission?,
@@ -35,6 +36,8 @@ module Increase
 
       attr_accessor deposit_acceptance: Increase::CheckDeposit::DepositAcceptance?
 
+      attr_accessor deposit_adjustments: ::Array[Increase::CheckDeposit::DepositAdjustment]
+
       attr_accessor deposit_rejection: Increase::CheckDeposit::DepositRejection?
 
       attr_accessor deposit_return: Increase::CheckDeposit::DepositReturn?
@@ -66,6 +69,7 @@ module Increase
         back_image_file_id: String?,
         created_at: Time,
         deposit_acceptance: Increase::CheckDeposit::DepositAcceptance?,
+        deposit_adjustments: ::Array[Increase::CheckDeposit::DepositAdjustment],
         deposit_rejection: Increase::CheckDeposit::DepositRejection?,
         deposit_return: Increase::CheckDeposit::DepositReturn?,
         deposit_submission: Increase::CheckDeposit::DepositSubmission?,
@@ -87,6 +91,7 @@ module Increase
         back_image_file_id: String?,
         created_at: Time,
         deposit_acceptance: Increase::CheckDeposit::DepositAcceptance?,
+        deposit_adjustments: ::Array[Increase::CheckDeposit::DepositAdjustment],
         deposit_rejection: Increase::CheckDeposit::DepositRejection?,
         deposit_return: Increase::CheckDeposit::DepositReturn?,
         deposit_submission: Increase::CheckDeposit::DepositSubmission?,
@@ -159,6 +164,66 @@ module Increase
         end
       end
 
+      type deposit_adjustment =
+        {
+          adjusted_at: Time,
+          amount: Integer,
+          reason: Increase::Models::CheckDeposit::DepositAdjustment::reason,
+          transaction_id: String
+        }
+
+      class DepositAdjustment < Increase::Internal::Type::BaseModel
+        attr_accessor adjusted_at: Time
+
+        attr_accessor amount: Integer
+
+        attr_accessor reason: Increase::Models::CheckDeposit::DepositAdjustment::reason
+
+        attr_accessor transaction_id: String
+
+        def initialize: (
+          adjusted_at: Time,
+          amount: Integer,
+          reason: Increase::Models::CheckDeposit::DepositAdjustment::reason,
+          transaction_id: String
+        ) -> void
+
+        def to_hash: -> {
+          adjusted_at: Time,
+          amount: Integer,
+          reason: Increase::Models::CheckDeposit::DepositAdjustment::reason,
+          transaction_id: String
+        }
+
+        type reason =
+          :late_return
+          | :wrong_payee_credit
+          | :adjusted_amount
+          | :non_conforming_item
+          | :paid
+
+        module Reason
+          extend Increase::Internal::Type::Enum
+
+          # The return was initiated too late and the receiving institution has responded with a Late Return Claim.
+          LATE_RETURN: :late_return
+
+          # The check was deposited to the wrong payee and the depositing institution has reimbursed the funds with a Wrong Payee Credit.
+          WRONG_PAYEE_CREDIT: :wrong_payee_credit
+
+          # The check was deposited with a different amount than what was written on the check.
+          ADJUSTED_AMOUNT: :adjusted_amount
+
+          # The recipient was not able to process the check. This usually happens for e.g., low quality images.
+          NON_CONFORMING_ITEM: :non_conforming_item
+
+          # The check has already been deposited elsewhere and so this is a duplicate.
+          PAID: :paid
+
+          def self?.values: -> ::Array[Increase::Models::CheckDeposit::DepositAdjustment::reason]
+        end
+      end
+
       type deposit_rejection =
         {
           amount: Integer,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: increase
 version: !ruby/object:Gem::Version
-  version: 1.216.0
+  version: 1.217.0
 platform: ruby
 authors:
 - Increase