increase 1.139.0 → 1.140.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f17193032c6fcda732d2a41326d889d2e1c285919a9f7d52977ce57459c7aad7
-  data.tar.gz: 973f3990be3e29f96b400ee3f286d53dca986e3d1d1a8a3e4a981f160feb4815
+  metadata.gz: 9e755a0881b738341982dc434e6ac9efb9f059b216d5548ddd9e27469a203eb3
+  data.tar.gz: d10900bb08ebffaf19e964673d00a200e09673b59844a6172dc7572659fec125
 SHA512:
-  metadata.gz: 8593d80ed65498790779aec47112e443f9af71893d0ac8ef3af1742ffa41f5beb875d67fc87074d8248e6617623d031e2d98d3e092d1ce5d9bae032dde0707b0
-  data.tar.gz: 43df0991d8580a5ed7f3547947f90f15b05d27bd44e437d78da259875edb3727a9084e4b5e1fa8813ae9116ac7d6699e968d3c6e60601004d4af2c089d374275
+  metadata.gz: d54faf7b49c19cc898c637e8f094b6b00c2c5f208dcbd70fe2a5a1d77276887ff2f9bd3aaa772bddc2b543a178b68eb810a501489ae4e36414813cc5e42e2621
+  data.tar.gz: a18eb11df8254b186e2b33d93d1e477a34c05c67e6566492e15122f95c1e4bfc8696f26d29d09fa113e1bbf8468975275b44b2d97d636d240b01fc6bde3492aa

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.140.0 (2025-11-12)
+
+Full Changelog: [v1.139.0...v1.140.0](https://github.com/Increase/increase-ruby/compare/v1.139.0...v1.140.0)
+
+### Features
+
+* **api:** api update ([ec8f079](https://github.com/Increase/increase-ruby/commit/ec8f0799545f42cf6c1ab2281669744f469514a8))
+
 ## 1.139.0 (2025-11-10)
 
 Full Changelog: [v1.138.0...v1.139.0](https://github.com/Increase/increase-ruby/compare/v1.138.0...v1.139.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.139.0"
+gem "increase", "~> 1.140.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/increase/models/inbound_mail_item_action_params.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::InboundMailItems#action
+    class InboundMailItemActionParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute checks
+      #   The actions to perform on the Inbound Mail Item.
+      #
+      #   @return [Array<Increase::Models::InboundMailItemActionParams::Check>]
+      required :checks, -> { Increase::Internal::Type::ArrayOf[Increase::InboundMailItemActionParams::Check] }
+
+      # @!method initialize(checks:, request_options: {})
+      #   @param checks [Array<Increase::Models::InboundMailItemActionParams::Check>] The actions to perform on the Inbound Mail Item.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      class Check < Increase::Internal::Type::BaseModel
+        # @!attribute action
+        #   The action to perform on the Inbound Mail Item.
+        #
+        #   @return [Symbol, Increase::Models::InboundMailItemActionParams::Check::Action]
+        required :action, enum: -> { Increase::InboundMailItemActionParams::Check::Action }
+
+        # @!attribute account
+        #   The identifier of the Account to deposit the check into. If not provided, the
+        #   check will be deposited into the Account associated with the Lockbox.
+        #
+        #   @return [String, nil]
+        optional :account, String
+
+        # @!method initialize(action:, account: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::InboundMailItemActionParams::Check} for more details.
+        #
+        #   @param action [Symbol, Increase::Models::InboundMailItemActionParams::Check::Action] The action to perform on the Inbound Mail Item.
+        #
+        #   @param account [String] The identifier of the Account to deposit the check into. If not provided, the ch
+
+        # The action to perform on the Inbound Mail Item.
+        #
+        # @see Increase::Models::InboundMailItemActionParams::Check#action
+        module Action
+          extend Increase::Internal::Type::Enum
+
+          # The check will be deposited.
+          DEPOSIT = :deposit
+
+          # The check will be ignored.
+          IGNORE = :ignore
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/increase/models/lockbox.rb

@@ -161,6 +161,9 @@ module Increase
         # Checks mailed to this Lockbox will not be deposited.
         DISABLED = :disabled
 
+        # Checks mailed to this Lockbox will be pending until actioned.
+        PEND_FOR_PROCESSING = :pend_for_processing
+
         # @!method self.values
         #   @return [Array<Symbol>]
       end

data/lib/increase/models/lockbox_update_params.rb

@@ -44,6 +44,9 @@ module Increase
         # Checks mailed to this Lockbox will not be deposited.
         DISABLED = :disabled
 
+        # Checks mailed to this Lockbox will be pending until actioned.
+        PEND_FOR_PROCESSING = :pend_for_processing
+
         # @!method self.values
         #   @return [Array<Symbol>]
       end

data/lib/increase/models.rb

@@ -376,6 +376,8 @@ module Increase
 
   InboundMailItem = Increase::Models::InboundMailItem
 
+  InboundMailItemActionParams = Increase::Models::InboundMailItemActionParams
+
   InboundMailItemListParams = Increase::Models::InboundMailItemListParams
 
   InboundMailItemRetrieveParams = Increase::Models::InboundMailItemRetrieveParams

data/lib/increase/resources/inbound_mail_items.rb

@@ -55,6 +55,30 @@ module Increase
         )
       end
 
+      # Action a Inbound Mail Item
+      #
+      # @overload action(inbound_mail_item_id, checks:, request_options: {})
+      #
+      # @param inbound_mail_item_id [String] The identifier of the Inbound Mail Item to action.
+      #
+      # @param checks [Array<Increase::Models::InboundMailItemActionParams::Check>] The actions to perform on the Inbound Mail Item.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::InboundMailItem]
+      #
+      # @see Increase::Models::InboundMailItemActionParams
+      def action(inbound_mail_item_id, params)
+        parsed, options = Increase::InboundMailItemActionParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["inbound_mail_items/%1$s/action", inbound_mail_item_id],
+          body: parsed,
+          model: Increase::InboundMailItem,
+          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.139.0"
+  VERSION = "1.140.0"
 end

data/lib/increase.rb

@@ -220,6 +220,7 @@ require_relative "increase/models/inbound_fednow_transfer"
 require_relative "increase/models/inbound_fednow_transfer_list_params"
 require_relative "increase/models/inbound_fednow_transfer_retrieve_params"
 require_relative "increase/models/inbound_mail_item"
+require_relative "increase/models/inbound_mail_item_action_params"
 require_relative "increase/models/inbound_mail_item_list_params"
 require_relative "increase/models/inbound_mail_item_retrieve_params"
 require_relative "increase/models/inbound_real_time_payments_transfer"

data/rbi/increase/models/inbound_mail_item_action_params.rbi

@@ -0,0 +1,139 @@
+# typed: strong
+
+module Increase
+  module Models
+    class InboundMailItemActionParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::InboundMailItemActionParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      # The actions to perform on the Inbound Mail Item.
+      sig { returns(T::Array[Increase::InboundMailItemActionParams::Check]) }
+      attr_accessor :checks
+
+      sig do
+        params(
+          checks:
+            T::Array[Increase::InboundMailItemActionParams::Check::OrHash],
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The actions to perform on the Inbound Mail Item.
+        checks:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            checks: T::Array[Increase::InboundMailItemActionParams::Check],
+            request_options: Increase::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Check < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::InboundMailItemActionParams::Check,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The action to perform on the Inbound Mail Item.
+        sig do
+          returns(
+            Increase::InboundMailItemActionParams::Check::Action::OrSymbol
+          )
+        end
+        attr_accessor :action
+
+        # The identifier of the Account to deposit the check into. If not provided, the
+        # check will be deposited into the Account associated with the Lockbox.
+        sig { returns(T.nilable(String)) }
+        attr_reader :account
+
+        sig { params(account: String).void }
+        attr_writer :account
+
+        sig do
+          params(
+            action:
+              Increase::InboundMailItemActionParams::Check::Action::OrSymbol,
+            account: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The action to perform on the Inbound Mail Item.
+          action:,
+          # The identifier of the Account to deposit the check into. If not provided, the
+          # check will be deposited into the Account associated with the Lockbox.
+          account: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              action:
+                Increase::InboundMailItemActionParams::Check::Action::OrSymbol,
+              account: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The action to perform on the Inbound Mail Item.
+        module Action
+          extend Increase::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Increase::InboundMailItemActionParams::Check::Action
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # The check will be deposited.
+          DEPOSIT =
+            T.let(
+              :deposit,
+              Increase::InboundMailItemActionParams::Check::Action::TaggedSymbol
+            )
+
+          # The check will be ignored.
+          IGNORE =
+            T.let(
+              :ignore,
+              Increase::InboundMailItemActionParams::Check::Action::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Increase::InboundMailItemActionParams::Check::Action::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/increase/models/lockbox.rbi

@@ -214,6 +214,13 @@ module Increase
             Increase::Lockbox::CheckDepositBehavior::TaggedSymbol
           )
 
+        # Checks mailed to this Lockbox will be pending until actioned.
+        PEND_FOR_PROCESSING =
+          T.let(
+            :pend_for_processing,
+            Increase::Lockbox::CheckDepositBehavior::TaggedSymbol
+          )
+
         sig do
           override.returns(
             T::Array[Increase::Lockbox::CheckDepositBehavior::TaggedSymbol]

data/rbi/increase/models/lockbox_update_params.rbi

@@ -101,6 +101,13 @@ module Increase
             Increase::LockboxUpdateParams::CheckDepositBehavior::TaggedSymbol
           )
 
+        # Checks mailed to this Lockbox will be pending until actioned.
+        PEND_FOR_PROCESSING =
+          T.let(
+            :pend_for_processing,
+            Increase::LockboxUpdateParams::CheckDepositBehavior::TaggedSymbol
+          )
+
         sig do
           override.returns(
             T::Array[

data/rbi/increase/models.rbi

@@ -380,6 +380,8 @@ module Increase
 
   InboundMailItem = Increase::Models::InboundMailItem
 
+  InboundMailItemActionParams = Increase::Models::InboundMailItemActionParams
+
   InboundMailItemListParams = Increase::Models::InboundMailItemListParams
 
   InboundMailItemRetrieveParams =

data/rbi/increase/resources/inbound_mail_items.rbi

@@ -40,6 +40,24 @@ module Increase
       )
       end
 
+      # Action a Inbound Mail Item
+      sig do
+        params(
+          inbound_mail_item_id: String,
+          checks:
+            T::Array[Increase::InboundMailItemActionParams::Check::OrHash],
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::InboundMailItem)
+      end
+      def action(
+        # The identifier of the Inbound Mail Item to action.
+        inbound_mail_item_id,
+        # The actions to perform on the Inbound Mail Item.
+        checks:,
+        request_options: {}
+      )
+      end
+
       # @api private
       sig { params(client: Increase::Client).returns(T.attached_class) }
       def self.new(client:)

data/sig/increase/models/inbound_mail_item_action_params.rbs

@@ -0,0 +1,62 @@
+module Increase
+  module Models
+    type inbound_mail_item_action_params =
+      { checks: ::Array[Increase::InboundMailItemActionParams::Check] }
+      & Increase::Internal::Type::request_parameters
+
+    class InboundMailItemActionParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      attr_accessor checks: ::Array[Increase::InboundMailItemActionParams::Check]
+
+      def initialize: (
+        checks: ::Array[Increase::InboundMailItemActionParams::Check],
+        ?request_options: Increase::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        checks: ::Array[Increase::InboundMailItemActionParams::Check],
+        request_options: Increase::RequestOptions
+      }
+
+      type check =
+        {
+          action: Increase::Models::InboundMailItemActionParams::Check::action,
+          account: String
+        }
+
+      class Check < Increase::Internal::Type::BaseModel
+        attr_accessor action: Increase::Models::InboundMailItemActionParams::Check::action
+
+        attr_reader account: String?
+
+        def account=: (String) -> String
+
+        def initialize: (
+          action: Increase::Models::InboundMailItemActionParams::Check::action,
+          ?account: String
+        ) -> void
+
+        def to_hash: -> {
+          action: Increase::Models::InboundMailItemActionParams::Check::action,
+          account: String
+        }
+
+        type action = :deposit | :ignore
+
+        module Action
+          extend Increase::Internal::Type::Enum
+
+          # The check will be deposited.
+          DEPOSIT: :deposit
+
+          # The check will be ignored.
+          IGNORE: :ignore
+
+          def self?.values: -> ::Array[Increase::Models::InboundMailItemActionParams::Check::action]
+        end
+      end
+    end
+  end
+end

data/sig/increase/models/lockbox.rbs

@@ -98,7 +98,7 @@ module Increase
         }
       end
 
-      type check_deposit_behavior = :enabled | :disabled
+      type check_deposit_behavior = :enabled | :disabled | :pend_for_processing
 
       module CheckDepositBehavior
         extend Increase::Internal::Type::Enum
@@ -109,6 +109,9 @@ module Increase
         # Checks mailed to this Lockbox will not be deposited.
         DISABLED: :disabled
 
+        # Checks mailed to this Lockbox will be pending until actioned.
+        PEND_FOR_PROCESSING: :pend_for_processing
+
         def self?.values: -> ::Array[Increase::Models::Lockbox::check_deposit_behavior]
       end
 

data/sig/increase/models/lockbox_update_params.rbs

@@ -40,7 +40,7 @@ module Increase
         request_options: Increase::RequestOptions
       }
 
-      type check_deposit_behavior = :enabled | :disabled
+      type check_deposit_behavior = :enabled | :disabled | :pend_for_processing
 
       module CheckDepositBehavior
         extend Increase::Internal::Type::Enum
@@ -51,6 +51,9 @@ module Increase
         # Checks mailed to this Lockbox will not be deposited.
         DISABLED: :disabled
 
+        # Checks mailed to this Lockbox will be pending until actioned.
+        PEND_FOR_PROCESSING: :pend_for_processing
+
         def self?.values: -> ::Array[Increase::Models::LockboxUpdateParams::check_deposit_behavior]
       end
     end

data/sig/increase/models.rbs

@@ -335,6 +335,8 @@ module Increase
 
   class InboundMailItem = Increase::Models::InboundMailItem
 
+  class InboundMailItemActionParams = Increase::Models::InboundMailItemActionParams
+
   class InboundMailItemListParams = Increase::Models::InboundMailItemListParams
 
   class InboundMailItemRetrieveParams = Increase::Models::InboundMailItemRetrieveParams

data/sig/increase/resources/inbound_mail_items.rbs

@@ -14,6 +14,12 @@ module Increase
         ?request_options: Increase::request_opts
       ) -> Increase::Internal::Page[Increase::InboundMailItem]
 
+      def action: (
+        String inbound_mail_item_id,
+        checks: ::Array[Increase::InboundMailItemActionParams::Check],
+        ?request_options: Increase::request_opts
+      ) -> Increase::InboundMailItem
+
       def initialize: (client: Increase::Client) -> void
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: increase
 version: !ruby/object:Gem::Version
-  version: 1.139.0
+  version: 1.140.0
 platform: ruby
 authors:
 - Increase
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-10 00:00:00.000000000 Z
+date: 2025-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool
@@ -224,6 +224,7 @@ files:
 - lib/increase/models/inbound_fednow_transfer_list_params.rb
 - lib/increase/models/inbound_fednow_transfer_retrieve_params.rb
 - lib/increase/models/inbound_mail_item.rb
+- lib/increase/models/inbound_mail_item_action_params.rb
 - lib/increase/models/inbound_mail_item_list_params.rb
 - lib/increase/models/inbound_mail_item_retrieve_params.rb
 - lib/increase/models/inbound_real_time_payments_transfer.rb
@@ -625,6 +626,7 @@ files:
 - rbi/increase/models/inbound_fednow_transfer_list_params.rbi
 - rbi/increase/models/inbound_fednow_transfer_retrieve_params.rbi
 - rbi/increase/models/inbound_mail_item.rbi
+- rbi/increase/models/inbound_mail_item_action_params.rbi
 - rbi/increase/models/inbound_mail_item_list_params.rbi
 - rbi/increase/models/inbound_mail_item_retrieve_params.rbi
 - rbi/increase/models/inbound_real_time_payments_transfer.rbi
@@ -1025,6 +1027,7 @@ files:
 - sig/increase/models/inbound_fednow_transfer_list_params.rbs
 - sig/increase/models/inbound_fednow_transfer_retrieve_params.rbs
 - sig/increase/models/inbound_mail_item.rbs
+- sig/increase/models/inbound_mail_item_action_params.rbs
 - sig/increase/models/inbound_mail_item_list_params.rbs
 - sig/increase/models/inbound_mail_item_retrieve_params.rbs
 - sig/increase/models/inbound_real_time_payments_transfer.rbs