increase 1.229.0 → 1.230.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd594db233cdb40ffc077729f606ec67d6e095614065ef355e30e659587e048f
-  data.tar.gz: 4be85b5ab95cc8cb4f6e4facdc59c32f6b0caae0b8d35143c67296a0a1640a70
+  metadata.gz: 3c069c49ffaad5a87f57090b0daea50e24512280378abb5d295cbc5158fb23b2
+  data.tar.gz: 5fe14f953df93c9e39821b77478614c2b0c1a244022de5420f7ec2ed3dc8cb02
 SHA512:
-  metadata.gz: e6f9fa92612a64174b7715fcb5c5e459dddcda9a9b893b6d7734b0bc5b2bc51a72058b635154407eacc0bd60c52b0e5f0ae2449e3ce1c58c06c4cbc173ed28ed
-  data.tar.gz: 4520f64e15c90b22dedcb15ec4c77c18e2fafeb37f7dcf37ba6ef186d740015a80390d1123777206cbc489ebda246541cc1f04a76793c8885e8ff4d5d192301e
+  metadata.gz: '03206181a8662cd554c3fe8792e1797055d3b40506bba0d11c32cf313fe48afd2ea92a30ea178ef86e00d5b7de0bed9624030ba722536f1a922f3eebff2ab188'
+  data.tar.gz: 5f99e831d718444af4441e23505ddf64bd7f1626947c70d66170a8089a70f457eaef68790b072c0647843e2ee68062e678671d2eb88ca1261e1d46bfcf97d4d9

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.230.0 (2026-03-05)
+
+Full Changelog: [v1.229.0...v1.230.0](https://github.com/Increase/increase-ruby/compare/v1.229.0...v1.230.0)
+
+### Features
+
+* **api:** api update ([a02c155](https://github.com/Increase/increase-ruby/commit/a02c155f39f7f44a541ad2151e1dfa14cc21c287))
+
 ## 1.229.0 (2026-03-05)
 
 Full Changelog: [v1.228.0...v1.229.0](https://github.com/Increase/increase-ruby/compare/v1.228.0...v1.229.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.229.0"
+gem "increase", "~> 1.230.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/increase/models/simulations/check_deposit_adjustment_params.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    module Simulations
+      # @see Increase::Resources::Simulations::CheckDeposits#adjustment
+      class CheckDepositAdjustmentParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        # @!attribute check_deposit_id
+        #   The identifier of the Check Deposit you wish to adjust.
+        #
+        #   @return [String]
+        required :check_deposit_id, String
+
+        # @!attribute amount
+        #   The adjustment amount in the minor unit of the Check Deposit's currency (e.g.,
+        #   cents). A negative amount means that the funds are being clawed back by the
+        #   other bank and is a debit to your account. Defaults to the negative of the Check
+        #   Deposit amount.
+        #
+        #   @return [Integer, nil]
+        optional :amount, Integer
+
+        # @!attribute reason
+        #   The reason for the adjustment. Defaults to `non_conforming_item`, which is often
+        #   used for a low quality image that the recipient wasn't able to handle.
+        #
+        #   @return [Symbol, Increase::Models::Simulations::CheckDepositAdjustmentParams::Reason, nil]
+        optional :reason, enum: -> { Increase::Simulations::CheckDepositAdjustmentParams::Reason }
+
+        # @!method initialize(check_deposit_id:, amount: nil, reason: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::Simulations::CheckDepositAdjustmentParams} for more details.
+        #
+        #   @param check_deposit_id [String] The identifier of the Check Deposit you wish to adjust.
+        #
+        #   @param amount [Integer] The adjustment amount in the minor unit of the Check Deposit's currency (e.g., c
+        #
+        #   @param reason [Symbol, Increase::Models::Simulations::CheckDepositAdjustmentParams::Reason] The reason for the adjustment. Defaults to `non_conforming_item`, which is often
+        #
+        #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+        # The reason for the adjustment. Defaults to `non_conforming_item`, which is often
+        # used for a low quality image that the recipient wasn't able to handle.
+        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
+    end
+  end
+end

data/lib/increase/resources/simulations/check_deposits.rb

@@ -4,6 +4,38 @@ module Increase
   module Resources
     class Simulations
       class CheckDeposits
+        # Some parameter documentations has been truncated, see
+        # {Increase::Models::Simulations::CheckDepositAdjustmentParams} for more details.
+        #
+        # Simulates the creation of a
+        # [Check Deposit Adjustment](#check-deposit-adjustments) on a
+        # [Check Deposit](#check-deposits). This Check Deposit must first have a `status`
+        # of `submitted`.
+        #
+        # @overload adjustment(check_deposit_id, amount: nil, reason: nil, request_options: {})
+        #
+        # @param check_deposit_id [String] The identifier of the Check Deposit you wish to adjust.
+        #
+        # @param amount [Integer] The adjustment amount in the minor unit of the Check Deposit's currency (e.g., c
+        #
+        # @param reason [Symbol, Increase::Models::Simulations::CheckDepositAdjustmentParams::Reason] The reason for the adjustment. Defaults to `non_conforming_item`, which is often
+        #
+        # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Increase::Models::CheckDeposit]
+        #
+        # @see Increase::Models::Simulations::CheckDepositAdjustmentParams
+        def adjustment(check_deposit_id, params = {})
+          parsed, options = Increase::Simulations::CheckDepositAdjustmentParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["simulations/check_deposits/%1$s/adjustment", check_deposit_id],
+            body: parsed,
+            model: Increase::CheckDeposit,
+            options: options
+          )
+        end
+
         # Simulates the rejection of a [Check Deposit](#check-deposits) by Increase due to
         # factors like poor image quality. This Check Deposit must first have a `status`
         # of `pending`.

data/lib/increase/version.rb

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

data/lib/increase.rb

@@ -304,6 +304,7 @@ require_relative "increase/models/simulations/card_refund_create_params"
 require_relative "increase/models/simulations/card_reversal_create_params"
 require_relative "increase/models/simulations/card_settlement_create_params"
 require_relative "increase/models/simulations/card_token_create_params"
+require_relative "increase/models/simulations/check_deposit_adjustment_params"
 require_relative "increase/models/simulations/check_deposit_reject_params"
 require_relative "increase/models/simulations/check_deposit_return_params"
 require_relative "increase/models/simulations/check_deposit_submit_params"

data/rbi/increase/models/simulations/check_deposit_adjustment_params.rbi

@@ -0,0 +1,151 @@
+# typed: strong
+
+module Increase
+  module Models
+    module Simulations
+      class CheckDepositAdjustmentParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::Simulations::CheckDepositAdjustmentParams,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The identifier of the Check Deposit you wish to adjust.
+        sig { returns(String) }
+        attr_accessor :check_deposit_id
+
+        # The adjustment amount in the minor unit of the Check Deposit's currency (e.g.,
+        # cents). A negative amount means that the funds are being clawed back by the
+        # other bank and is a debit to your account. Defaults to the negative of the Check
+        # Deposit amount.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :amount
+
+        sig { params(amount: Integer).void }
+        attr_writer :amount
+
+        # The reason for the adjustment. Defaults to `non_conforming_item`, which is often
+        # used for a low quality image that the recipient wasn't able to handle.
+        sig do
+          returns(
+            T.nilable(
+              Increase::Simulations::CheckDepositAdjustmentParams::Reason::OrSymbol
+            )
+          )
+        end
+        attr_reader :reason
+
+        sig do
+          params(
+            reason:
+              Increase::Simulations::CheckDepositAdjustmentParams::Reason::OrSymbol
+          ).void
+        end
+        attr_writer :reason
+
+        sig do
+          params(
+            check_deposit_id: String,
+            amount: Integer,
+            reason:
+              Increase::Simulations::CheckDepositAdjustmentParams::Reason::OrSymbol,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The identifier of the Check Deposit you wish to adjust.
+          check_deposit_id:,
+          # The adjustment amount in the minor unit of the Check Deposit's currency (e.g.,
+          # cents). A negative amount means that the funds are being clawed back by the
+          # other bank and is a debit to your account. Defaults to the negative of the Check
+          # Deposit amount.
+          amount: nil,
+          # The reason for the adjustment. Defaults to `non_conforming_item`, which is often
+          # used for a low quality image that the recipient wasn't able to handle.
+          reason: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              check_deposit_id: String,
+              amount: Integer,
+              reason:
+                Increase::Simulations::CheckDepositAdjustmentParams::Reason::OrSymbol,
+              request_options: Increase::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The reason for the adjustment. Defaults to `non_conforming_item`, which is often
+        # used for a low quality image that the recipient wasn't able to handle.
+        module Reason
+          extend Increase::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Increase::Simulations::CheckDepositAdjustmentParams::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::Simulations::CheckDepositAdjustmentParams::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::Simulations::CheckDepositAdjustmentParams::Reason::TaggedSymbol
+            )
+
+          # The check was deposited with a different amount than what was written on the check.
+          ADJUSTED_AMOUNT =
+            T.let(
+              :adjusted_amount,
+              Increase::Simulations::CheckDepositAdjustmentParams::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::Simulations::CheckDepositAdjustmentParams::Reason::TaggedSymbol
+            )
+
+          # The check has already been deposited elsewhere and so this is a duplicate.
+          PAID =
+            T.let(
+              :paid,
+              Increase::Simulations::CheckDepositAdjustmentParams::Reason::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Increase::Simulations::CheckDepositAdjustmentParams::Reason::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/increase/resources/simulations/check_deposits.rbi

@@ -4,6 +4,34 @@ module Increase
   module Resources
     class Simulations
       class CheckDeposits
+        # Simulates the creation of a
+        # [Check Deposit Adjustment](#check-deposit-adjustments) on a
+        # [Check Deposit](#check-deposits). This Check Deposit must first have a `status`
+        # of `submitted`.
+        sig do
+          params(
+            check_deposit_id: String,
+            amount: Integer,
+            reason:
+              Increase::Simulations::CheckDepositAdjustmentParams::Reason::OrSymbol,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::CheckDeposit)
+        end
+        def adjustment(
+          # The identifier of the Check Deposit you wish to adjust.
+          check_deposit_id,
+          # The adjustment amount in the minor unit of the Check Deposit's currency (e.g.,
+          # cents). A negative amount means that the funds are being clawed back by the
+          # other bank and is a debit to your account. Defaults to the negative of the Check
+          # Deposit amount.
+          amount: nil,
+          # The reason for the adjustment. Defaults to `non_conforming_item`, which is often
+          # used for a low quality image that the recipient wasn't able to handle.
+          reason: nil,
+          request_options: {}
+        )
+        end
+
         # Simulates the rejection of a [Check Deposit](#check-deposits) by Increase due to
         # factors like poor image quality. This Check Deposit must first have a `status`
         # of `pending`.

data/sig/increase/models/simulations/check_deposit_adjustment_params.rbs

@@ -0,0 +1,72 @@
+module Increase
+  module Models
+    module Simulations
+      type check_deposit_adjustment_params =
+        {
+          check_deposit_id: String,
+          amount: Integer,
+          reason: Increase::Models::Simulations::CheckDepositAdjustmentParams::reason
+        }
+        & Increase::Internal::Type::request_parameters
+
+      class CheckDepositAdjustmentParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        attr_accessor check_deposit_id: String
+
+        attr_reader amount: Integer?
+
+        def amount=: (Integer) -> Integer
+
+        attr_reader reason: Increase::Models::Simulations::CheckDepositAdjustmentParams::reason?
+
+        def reason=: (
+          Increase::Models::Simulations::CheckDepositAdjustmentParams::reason
+        ) -> Increase::Models::Simulations::CheckDepositAdjustmentParams::reason
+
+        def initialize: (
+          check_deposit_id: String,
+          ?amount: Integer,
+          ?reason: Increase::Models::Simulations::CheckDepositAdjustmentParams::reason,
+          ?request_options: Increase::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          check_deposit_id: String,
+          amount: Integer,
+          reason: Increase::Models::Simulations::CheckDepositAdjustmentParams::reason,
+          request_options: Increase::RequestOptions
+        }
+
+        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::Simulations::CheckDepositAdjustmentParams::reason]
+        end
+      end
+    end
+  end
+end

data/sig/increase/resources/simulations/check_deposits.rbs

@@ -2,6 +2,13 @@ module Increase
   module Resources
     class Simulations
       class CheckDeposits
+        def adjustment: (
+          String check_deposit_id,
+          ?amount: Integer,
+          ?reason: Increase::Models::Simulations::CheckDepositAdjustmentParams::reason,
+          ?request_options: Increase::request_opts
+        ) -> Increase::CheckDeposit
+
         def reject: (
           String check_deposit_id,
           ?request_options: Increase::request_opts

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: increase
 version: !ruby/object:Gem::Version
-  version: 1.229.0
+  version: 1.230.0
 platform: ruby
 authors:
 - Increase
@@ -321,6 +321,7 @@ files:
 - lib/increase/models/simulations/card_reversal_create_params.rb
 - lib/increase/models/simulations/card_settlement_create_params.rb
 - lib/increase/models/simulations/card_token_create_params.rb
+- lib/increase/models/simulations/check_deposit_adjustment_params.rb
 - lib/increase/models/simulations/check_deposit_reject_params.rb
 - lib/increase/models/simulations/check_deposit_return_params.rb
 - lib/increase/models/simulations/check_deposit_submit_params.rb
@@ -730,6 +731,7 @@ files:
 - rbi/increase/models/simulations/card_reversal_create_params.rbi
 - rbi/increase/models/simulations/card_settlement_create_params.rbi
 - rbi/increase/models/simulations/card_token_create_params.rbi
+- rbi/increase/models/simulations/check_deposit_adjustment_params.rbi
 - rbi/increase/models/simulations/check_deposit_reject_params.rbi
 - rbi/increase/models/simulations/check_deposit_return_params.rbi
 - rbi/increase/models/simulations/check_deposit_submit_params.rbi
@@ -1138,6 +1140,7 @@ files:
 - sig/increase/models/simulations/card_reversal_create_params.rbs
 - sig/increase/models/simulations/card_settlement_create_params.rbs
 - sig/increase/models/simulations/card_token_create_params.rbs
+- sig/increase/models/simulations/check_deposit_adjustment_params.rbs
 - sig/increase/models/simulations/check_deposit_reject_params.rbs
 - sig/increase/models/simulations/check_deposit_return_params.rbs
 - sig/increase/models/simulations/check_deposit_submit_params.rbs