increase 1.230.0 → 1.231.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c069c49ffaad5a87f57090b0daea50e24512280378abb5d295cbc5158fb23b2
-  data.tar.gz: 5fe14f953df93c9e39821b77478614c2b0c1a244022de5420f7ec2ed3dc8cb02
+  metadata.gz: 58c7627a38937abda046072a88ffcc381eeb26bfba23b2c818c95c6f0087b5b9
+  data.tar.gz: 8c96c7d9bc15223b24874ce73d078415e3bd33ab114ee9c9a5b3644ef8374135
 SHA512:
-  metadata.gz: '03206181a8662cd554c3fe8792e1797055d3b40506bba0d11c32cf313fe48afd2ea92a30ea178ef86e00d5b7de0bed9624030ba722536f1a922f3eebff2ab188'
-  data.tar.gz: 5f99e831d718444af4441e23505ddf64bd7f1626947c70d66170a8089a70f457eaef68790b072c0647843e2ee68062e678671d2eb88ca1261e1d46bfcf97d4d9
+  metadata.gz: 5ac61d0f56eeec37239e9f59f5eab56a507999ba4307596f077f0d7cdfa0c1217b88d89f0f3f3362e528b8d995b08072de277f0eb3ad9b09a4fee04ff38ce880
+  data.tar.gz: 9eb19a7fac468dee2c4362b7e39f8b40959feff8730933f0c0c08808f16f84bd6d6e9b69d746b4834ca7699bfbc25d908595710147798c5c52fd3c7d1f8dd9b3

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.231.0 (2026-03-05)
+
+Full Changelog: [v1.230.0...v1.231.0](https://github.com/Increase/increase-ruby/compare/v1.230.0...v1.231.0)
+
+### Features
+
+* **api:** api update ([0924a4a](https://github.com/Increase/increase-ruby/commit/0924a4a54f1510a80b4bac5a2a282c36e94e08a4))
+
 ## 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)

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.230.0"
+gem "increase", "~> 1.231.0"
 ```
 
 <!-- x-release-please-end -->

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

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    module Simulations
+      # @see Increase::Resources::Simulations::InboundCheckDeposits#adjustment
+      class InboundCheckDepositAdjustmentParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        # @!attribute inbound_check_deposit_id
+        #   The identifier of the Inbound Check Deposit to adjust.
+        #
+        #   @return [String]
+        required :inbound_check_deposit_id, String
+
+        # @!attribute amount
+        #   The adjustment amount in cents. Defaults to the amount of the Inbound Check
+        #   Deposit.
+        #
+        #   @return [Integer, nil]
+        optional :amount, Integer
+
+        # @!attribute reason
+        #   The reason for the adjustment. Defaults to `wrong_payee_credit`.
+        #
+        #   @return [Symbol, Increase::Models::Simulations::InboundCheckDepositAdjustmentParams::Reason, nil]
+        optional :reason, enum: -> { Increase::Simulations::InboundCheckDepositAdjustmentParams::Reason }
+
+        # @!method initialize(inbound_check_deposit_id:, amount: nil, reason: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::Simulations::InboundCheckDepositAdjustmentParams} for more
+        #   details.
+        #
+        #   @param inbound_check_deposit_id [String] The identifier of the Inbound Check Deposit to adjust.
+        #
+        #   @param amount [Integer] The adjustment amount in cents. Defaults to the amount of the Inbound Check Depo
+        #
+        #   @param reason [Symbol, Increase::Models::Simulations::InboundCheckDepositAdjustmentParams::Reason] The reason for the adjustment. Defaults to `wrong_payee_credit`.
+        #
+        #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+        # The reason for the adjustment. Defaults to `wrong_payee_credit`.
+        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/inbound_check_deposits.rb

@@ -41,6 +41,37 @@ module Increase
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Increase::Models::Simulations::InboundCheckDepositAdjustmentParams} for more
+        # details.
+        #
+        # Simulates an adjustment on an Inbound Check Deposit. The Inbound Check Deposit
+        # must have a `status` of `accepted`.
+        #
+        # @overload adjustment(inbound_check_deposit_id, amount: nil, reason: nil, request_options: {})
+        #
+        # @param inbound_check_deposit_id [String] The identifier of the Inbound Check Deposit to adjust.
+        #
+        # @param amount [Integer] The adjustment amount in cents. Defaults to the amount of the Inbound Check Depo
+        #
+        # @param reason [Symbol, Increase::Models::Simulations::InboundCheckDepositAdjustmentParams::Reason] The reason for the adjustment. Defaults to `wrong_payee_credit`.
+        #
+        # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Increase::Models::InboundCheckDeposit]
+        #
+        # @see Increase::Models::Simulations::InboundCheckDepositAdjustmentParams
+        def adjustment(inbound_check_deposit_id, params = {})
+          parsed, options = Increase::Simulations::InboundCheckDepositAdjustmentParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["simulations/inbound_check_deposits/%1$s/adjustment", inbound_check_deposit_id],
+            body: parsed,
+            model: Increase::InboundCheckDeposit,
+            options: options
+          )
+        end
+
         # @api private
         #
         # @param client [Increase::Client]

data/lib/increase/version.rb

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

data/lib/increase.rb

@@ -313,6 +313,7 @@ require_relative "increase/models/simulations/digital_wallet_token_request_creat
 require_relative "increase/models/simulations/digital_wallet_token_request_create_response"
 require_relative "increase/models/simulations/export_create_params"
 require_relative "increase/models/simulations/inbound_ach_transfer_create_params"
+require_relative "increase/models/simulations/inbound_check_deposit_adjustment_params"
 require_relative "increase/models/simulations/inbound_check_deposit_create_params"
 require_relative "increase/models/simulations/inbound_fednow_transfer_create_params"
 require_relative "increase/models/simulations/inbound_mail_item_create_params"

data/rbi/increase/models/simulations/inbound_check_deposit_adjustment_params.rbi

@@ -0,0 +1,144 @@
+# typed: strong
+
+module Increase
+  module Models
+    module Simulations
+      class InboundCheckDepositAdjustmentParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::Simulations::InboundCheckDepositAdjustmentParams,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The identifier of the Inbound Check Deposit to adjust.
+        sig { returns(String) }
+        attr_accessor :inbound_check_deposit_id
+
+        # The adjustment amount in cents. Defaults to the amount of the Inbound Check
+        # Deposit.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :amount
+
+        sig { params(amount: Integer).void }
+        attr_writer :amount
+
+        # The reason for the adjustment. Defaults to `wrong_payee_credit`.
+        sig do
+          returns(
+            T.nilable(
+              Increase::Simulations::InboundCheckDepositAdjustmentParams::Reason::OrSymbol
+            )
+          )
+        end
+        attr_reader :reason
+
+        sig do
+          params(
+            reason:
+              Increase::Simulations::InboundCheckDepositAdjustmentParams::Reason::OrSymbol
+          ).void
+        end
+        attr_writer :reason
+
+        sig do
+          params(
+            inbound_check_deposit_id: String,
+            amount: Integer,
+            reason:
+              Increase::Simulations::InboundCheckDepositAdjustmentParams::Reason::OrSymbol,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The identifier of the Inbound Check Deposit to adjust.
+          inbound_check_deposit_id:,
+          # The adjustment amount in cents. Defaults to the amount of the Inbound Check
+          # Deposit.
+          amount: nil,
+          # The reason for the adjustment. Defaults to `wrong_payee_credit`.
+          reason: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              inbound_check_deposit_id: String,
+              amount: Integer,
+              reason:
+                Increase::Simulations::InboundCheckDepositAdjustmentParams::Reason::OrSymbol,
+              request_options: Increase::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The reason for the adjustment. Defaults to `wrong_payee_credit`.
+        module Reason
+          extend Increase::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Increase::Simulations::InboundCheckDepositAdjustmentParams::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::InboundCheckDepositAdjustmentParams::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::InboundCheckDepositAdjustmentParams::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::InboundCheckDepositAdjustmentParams::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::InboundCheckDepositAdjustmentParams::Reason::TaggedSymbol
+            )
+
+          # The check has already been deposited elsewhere and so this is a duplicate.
+          PAID =
+            T.let(
+              :paid,
+              Increase::Simulations::InboundCheckDepositAdjustmentParams::Reason::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Increase::Simulations::InboundCheckDepositAdjustmentParams::Reason::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/increase/resources/simulations/inbound_check_deposits.rbi

@@ -35,6 +35,29 @@ module Increase
         )
         end
 
+        # Simulates an adjustment on an Inbound Check Deposit. The Inbound Check Deposit
+        # must have a `status` of `accepted`.
+        sig do
+          params(
+            inbound_check_deposit_id: String,
+            amount: Integer,
+            reason:
+              Increase::Simulations::InboundCheckDepositAdjustmentParams::Reason::OrSymbol,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::InboundCheckDeposit)
+        end
+        def adjustment(
+          # The identifier of the Inbound Check Deposit to adjust.
+          inbound_check_deposit_id,
+          # The adjustment amount in cents. Defaults to the amount of the Inbound Check
+          # Deposit.
+          amount: nil,
+          # The reason for the adjustment. Defaults to `wrong_payee_credit`.
+          reason: nil,
+          request_options: {}
+        )
+        end
+
         # @api private
         sig { params(client: Increase::Client).returns(T.attached_class) }
         def self.new(client:)

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

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

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

@@ -10,6 +10,13 @@ module Increase
           ?request_options: Increase::request_opts
         ) -> Increase::InboundCheckDeposit
 
+        def adjustment: (
+          String inbound_check_deposit_id,
+          ?amount: Integer,
+          ?reason: Increase::Models::Simulations::InboundCheckDepositAdjustmentParams::reason,
+          ?request_options: Increase::request_opts
+        ) -> Increase::InboundCheckDeposit
+
         def initialize: (client: Increase::Client) -> void
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: increase
 version: !ruby/object:Gem::Version
-  version: 1.230.0
+  version: 1.231.0
 platform: ruby
 authors:
 - Increase
@@ -330,6 +330,7 @@ files:
 - lib/increase/models/simulations/digital_wallet_token_request_create_response.rb
 - lib/increase/models/simulations/export_create_params.rb
 - lib/increase/models/simulations/inbound_ach_transfer_create_params.rb
+- lib/increase/models/simulations/inbound_check_deposit_adjustment_params.rb
 - lib/increase/models/simulations/inbound_check_deposit_create_params.rb
 - lib/increase/models/simulations/inbound_fednow_transfer_create_params.rb
 - lib/increase/models/simulations/inbound_mail_item_create_params.rb
@@ -740,6 +741,7 @@ files:
 - rbi/increase/models/simulations/digital_wallet_token_request_create_response.rbi
 - rbi/increase/models/simulations/export_create_params.rbi
 - rbi/increase/models/simulations/inbound_ach_transfer_create_params.rbi
+- rbi/increase/models/simulations/inbound_check_deposit_adjustment_params.rbi
 - rbi/increase/models/simulations/inbound_check_deposit_create_params.rbi
 - rbi/increase/models/simulations/inbound_fednow_transfer_create_params.rbi
 - rbi/increase/models/simulations/inbound_mail_item_create_params.rbi
@@ -1149,6 +1151,7 @@ files:
 - sig/increase/models/simulations/digital_wallet_token_request_create_response.rbs
 - sig/increase/models/simulations/export_create_params.rbs
 - sig/increase/models/simulations/inbound_ach_transfer_create_params.rbs
+- sig/increase/models/simulations/inbound_check_deposit_adjustment_params.rbs
 - sig/increase/models/simulations/inbound_check_deposit_create_params.rbs
 - sig/increase/models/simulations/inbound_fednow_transfer_create_params.rbs
 - sig/increase/models/simulations/inbound_mail_item_create_params.rbs