increase 1.59.0 → 1.61.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a21ba7f7a2c4a5940c30d2820d06d5cc480bb6b44a6c35fce9099d9d25f145c
-  data.tar.gz: 0b5d6f6edde31e8e63202058a74c1a515d143b2e51759261e09a9de9053e5a2a
+  metadata.gz: d61f06f8d322ec0ac93a22a3a444de7cbc16fe7aeacb9c3c82dae74428bfe3d8
+  data.tar.gz: 220177203100129d7868c1f6ea867d8394667527861f9257666319b5f504c200
 SHA512:
-  metadata.gz: d107d1e35189805bab9c5d12aa40fec915aa447c645279932f2827c36ac40f9caa6ae66c99bbee1f107335b89dc5d0b13bd2b38068d0eb5ef47c068758bc121a
-  data.tar.gz: 9e4c2d0766c0e3a931f58c0f703ba6035740c58633d7776775f0412419bad73cf7c5792dc015e7ed6dd022ee7e5084032ca27c52fa9cc6b5ca1a9fba41f19934
+  metadata.gz: cb215c7dde710ab0ba7cccf8f15adaed3caf7122ca7d20ede754ffe80c371209e461295802c630e97b96b5d90c93e3f780ca216d57a4b95ebc78ab6e0a7e255f
+  data.tar.gz: 7a6f318027edda9d8ea543720873692adec01ae3729253fb50a926ec12f2cd0137b5074340973314b806b300f33cdcfb7edb056e81d8f34916e12ac1f4b3d983

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 1.61.0 (2025-08-29)
+
+Full Changelog: [v1.60.0...v1.61.0](https://github.com/Increase/increase-ruby/compare/v1.60.0...v1.61.0)
+
+### Features
+
+* **api:** api update ([c0ff18c](https://github.com/Increase/increase-ruby/commit/c0ff18c03231449f0ca49b9902e606528d4a8c3d))
+
+## 1.60.0 (2025-08-29)
+
+Full Changelog: [v1.59.0...v1.60.0](https://github.com/Increase/increase-ruby/compare/v1.59.0...v1.60.0)
+
+### Features
+
+* **api:** api update ([c4222d8](https://github.com/Increase/increase-ruby/commit/c4222d890092bb99d6c7226667dcc73f3ecea48c))
+
 ## 1.59.0 (2025-08-28)
 
 Full Changelog: [v1.58.0...v1.59.0](https://github.com/Increase/increase-ruby/compare/v1.58.0...v1.59.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.59.0"
+gem "increase", "~> 1.61.0"
 ```
 
 <!-- x-release-please-end -->

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

@@ -26,14 +26,48 @@ module Increase
         #   @return [String]
         required :check_number, String
 
-        # @!method initialize(account_number_id:, amount:, check_number:, request_options: {})
+        # @!attribute payee_name_analysis
+        #   Simulate the outcome of
+        #   [payee name checking](https://increase.com/documentation/positive-pay#payee-name-mismatches).
+        #   Defaults to `not_evaluated`.
+        #
+        #   @return [Symbol, Increase::Models::Simulations::InboundCheckDepositCreateParams::PayeeNameAnalysis, nil]
+        optional :payee_name_analysis,
+                 enum: -> { Increase::Simulations::InboundCheckDepositCreateParams::PayeeNameAnalysis }
+
+        # @!method initialize(account_number_id:, amount:, check_number:, payee_name_analysis: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::Simulations::InboundCheckDepositCreateParams} for more
+        #   details.
+        #
         #   @param account_number_id [String] The identifier of the Account Number the Inbound Check Deposit will be against.
         #
         #   @param amount [Integer] The check amount in cents.
         #
         #   @param check_number [String] The check number on the check to be deposited.
         #
+        #   @param payee_name_analysis [Symbol, Increase::Models::Simulations::InboundCheckDepositCreateParams::PayeeNameAnalysis] Simulate the outcome of [payee name checking](https://increase.com/documentation
+        #
         #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+        # Simulate the outcome of
+        # [payee name checking](https://increase.com/documentation/positive-pay#payee-name-mismatches).
+        # Defaults to `not_evaluated`.
+        module PayeeNameAnalysis
+          extend Increase::Internal::Type::Enum
+
+          # The details on the check match the recipient name of the check transfer.
+          NAME_MATCHES = :name_matches
+
+          # The details on the check do not match the recipient name of the check transfer.
+          DOES_NOT_MATCH = :does_not_match
+
+          # The payee name analysis was not evaluated.
+          NOT_EVALUATED = :not_evaluated
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
     end
   end

data/lib/increase/models/transaction.rb

@@ -5217,6 +5217,20 @@ module Increase
           #   @return [String, nil]
           required :return_reason_additional_information, String, nil?: true
 
+          # @!attribute return_reason_code
+          #   A code provided by the sending bank giving a reason for the reversal. It will
+          #   generally be one of the codes defined in the ISO20022
+          #   `ExternalReturnReason1Code` code set, but this is not enforced by the network.
+          #
+          #   @return [String, nil]
+          required :return_reason_code, String, nil?: true
+
+          # @!attribute return_reason_code_description
+          #   An Increase-generated description of the `return_reason_code`.
+          #
+          #   @return [String, nil]
+          required :return_reason_code_description, String, nil?: true
+
           # @!attribute transaction_id
           #   The ID for the Transaction associated with the transfer reversal.
           #
@@ -5229,7 +5243,7 @@ module Increase
           #   @return [String]
           required :wire_transfer_id, String
 
-          # @!method initialize(amount:, created_at:, debtor_routing_number:, description:, input_cycle_date:, input_message_accountability_data:, input_sequence_number:, input_source:, instruction_identification:, return_reason_additional_information:, transaction_id:, wire_transfer_id:)
+          # @!method initialize(amount:, created_at:, debtor_routing_number:, description:, input_cycle_date:, input_message_accountability_data:, input_sequence_number:, input_source:, instruction_identification:, return_reason_additional_information:, return_reason_code:, return_reason_code_description:, transaction_id:, wire_transfer_id:)
           #   Some parameter documentations has been truncated, see
           #   {Increase::Models::Transaction::Source::InboundWireReversal} for more details.
           #
@@ -5259,6 +5273,10 @@ module Increase
           #
           #   @param return_reason_additional_information [String, nil] Additional information about the reason for the reversal.
           #
+          #   @param return_reason_code [String, nil] A code provided by the sending bank giving a reason for the reversal. It will ge
+          #
+          #   @param return_reason_code_description [String, nil] An Increase-generated description of the `return_reason_code`.
+          #
           #   @param transaction_id [String] The ID for the Transaction associated with the transfer reversal.
           #
           #   @param wire_transfer_id [String] The ID for the Wire Transfer that is being reversed.

data/lib/increase/models/wire_transfer.rb

@@ -523,6 +523,20 @@ module Increase
         #   @return [String, nil]
         required :return_reason_additional_information, String, nil?: true
 
+        # @!attribute return_reason_code
+        #   A code provided by the sending bank giving a reason for the reversal. It will
+        #   generally be one of the codes defined in the ISO20022
+        #   `ExternalReturnReason1Code` code set, but this is not enforced by the network.
+        #
+        #   @return [String, nil]
+        required :return_reason_code, String, nil?: true
+
+        # @!attribute return_reason_code_description
+        #   An Increase-generated description of the `return_reason_code`.
+        #
+        #   @return [String, nil]
+        required :return_reason_code_description, String, nil?: true
+
         # @!attribute transaction_id
         #   The ID for the Transaction associated with the transfer reversal.
         #
@@ -535,7 +549,7 @@ module Increase
         #   @return [String]
         required :wire_transfer_id, String
 
-        # @!method initialize(amount:, created_at:, debtor_routing_number:, description:, input_cycle_date:, input_message_accountability_data:, input_sequence_number:, input_source:, instruction_identification:, return_reason_additional_information:, transaction_id:, wire_transfer_id:)
+        # @!method initialize(amount:, created_at:, debtor_routing_number:, description:, input_cycle_date:, input_message_accountability_data:, input_sequence_number:, input_source:, instruction_identification:, return_reason_additional_information:, return_reason_code:, return_reason_code_description:, transaction_id:, wire_transfer_id:)
         #   Some parameter documentations has been truncated, see
         #   {Increase::Models::WireTransfer::Reversal} for more details.
         #
@@ -561,6 +575,10 @@ module Increase
         #
         #   @param return_reason_additional_information [String, nil] Additional information about the reason for the reversal.
         #
+        #   @param return_reason_code [String, nil] A code provided by the sending bank giving a reason for the reversal. It will ge
+        #
+        #   @param return_reason_code_description [String, nil] An Increase-generated description of the `return_reason_code`.
+        #
         #   @param transaction_id [String] The ID for the Transaction associated with the transfer reversal.
         #
         #   @param wire_transfer_id [String] The ID for the Wire Transfer that is being reversed.

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

@@ -4,6 +4,10 @@ module Increase
   module Resources
     class Simulations
       class InboundCheckDeposits
+        # Some parameter documentations has been truncated, see
+        # {Increase::Models::Simulations::InboundCheckDepositCreateParams} for more
+        # details.
+        #
         # Simulates an Inbound Check Deposit against your account. This imitates someone
         # depositing a check at their bank that was issued from your account. It may or
         # may not be associated with a Check Transfer. Increase will evaluate the Check
@@ -11,7 +15,7 @@ module Increase
         # Transaction as a result. You can inspect the resulting Inbound Check Deposit
         # object to see the result.
         #
-        # @overload create(account_number_id:, amount:, check_number:, request_options: {})
+        # @overload create(account_number_id:, amount:, check_number:, payee_name_analysis: nil, request_options: {})
         #
         # @param account_number_id [String] The identifier of the Account Number the Inbound Check Deposit will be against.
         #
@@ -19,6 +23,8 @@ module Increase
         #
         # @param check_number [String] The check number on the check to be deposited.
         #
+        # @param payee_name_analysis [Symbol, Increase::Models::Simulations::InboundCheckDepositCreateParams::PayeeNameAnalysis] Simulate the outcome of [payee name checking](https://increase.com/documentation
+        #
         # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Increase::Models::InboundCheckDeposit]

data/lib/increase/version.rb

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

data/rbi/increase/models/simulations/inbound_check_deposit_create_params.rbi

@@ -27,11 +27,33 @@ module Increase
         sig { returns(String) }
         attr_accessor :check_number
 
+        # Simulate the outcome of
+        # [payee name checking](https://increase.com/documentation/positive-pay#payee-name-mismatches).
+        # Defaults to `not_evaluated`.
+        sig do
+          returns(
+            T.nilable(
+              Increase::Simulations::InboundCheckDepositCreateParams::PayeeNameAnalysis::OrSymbol
+            )
+          )
+        end
+        attr_reader :payee_name_analysis
+
+        sig do
+          params(
+            payee_name_analysis:
+              Increase::Simulations::InboundCheckDepositCreateParams::PayeeNameAnalysis::OrSymbol
+          ).void
+        end
+        attr_writer :payee_name_analysis
+
         sig do
           params(
             account_number_id: String,
             amount: Integer,
             check_number: String,
+            payee_name_analysis:
+              Increase::Simulations::InboundCheckDepositCreateParams::PayeeNameAnalysis::OrSymbol,
             request_options: Increase::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -42,6 +64,10 @@ module Increase
           amount:,
           # The check number on the check to be deposited.
           check_number:,
+          # Simulate the outcome of
+          # [payee name checking](https://increase.com/documentation/positive-pay#payee-name-mismatches).
+          # Defaults to `not_evaluated`.
+          payee_name_analysis: nil,
           request_options: {}
         )
         end
@@ -52,12 +78,61 @@ module Increase
               account_number_id: String,
               amount: Integer,
               check_number: String,
+              payee_name_analysis:
+                Increase::Simulations::InboundCheckDepositCreateParams::PayeeNameAnalysis::OrSymbol,
               request_options: Increase::RequestOptions
             }
           )
         end
         def to_hash
         end
+
+        # Simulate the outcome of
+        # [payee name checking](https://increase.com/documentation/positive-pay#payee-name-mismatches).
+        # Defaults to `not_evaluated`.
+        module PayeeNameAnalysis
+          extend Increase::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Increase::Simulations::InboundCheckDepositCreateParams::PayeeNameAnalysis
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # The details on the check match the recipient name of the check transfer.
+          NAME_MATCHES =
+            T.let(
+              :name_matches,
+              Increase::Simulations::InboundCheckDepositCreateParams::PayeeNameAnalysis::TaggedSymbol
+            )
+
+          # The details on the check do not match the recipient name of the check transfer.
+          DOES_NOT_MATCH =
+            T.let(
+              :does_not_match,
+              Increase::Simulations::InboundCheckDepositCreateParams::PayeeNameAnalysis::TaggedSymbol
+            )
+
+          # The payee name analysis was not evaluated.
+          NOT_EVALUATED =
+            T.let(
+              :not_evaluated,
+              Increase::Simulations::InboundCheckDepositCreateParams::PayeeNameAnalysis::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Increase::Simulations::InboundCheckDepositCreateParams::PayeeNameAnalysis::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
       end
     end
   end

data/rbi/increase/models/transaction.rbi

@@ -9623,6 +9623,16 @@ module Increase
           sig { returns(T.nilable(String)) }
           attr_accessor :return_reason_additional_information
 
+          # A code provided by the sending bank giving a reason for the reversal. It will
+          # generally be one of the codes defined in the ISO20022
+          # `ExternalReturnReason1Code` code set, but this is not enforced by the network.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :return_reason_code
+
+          # An Increase-generated description of the `return_reason_code`.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :return_reason_code_description
+
           # The ID for the Transaction associated with the transfer reversal.
           sig { returns(String) }
           attr_accessor :transaction_id
@@ -9648,6 +9658,8 @@ module Increase
               input_source: String,
               instruction_identification: T.nilable(String),
               return_reason_additional_information: T.nilable(String),
+              return_reason_code: T.nilable(String),
+              return_reason_code_description: T.nilable(String),
               transaction_id: String,
               wire_transfer_id: String
             ).returns(T.attached_class)
@@ -9675,6 +9687,12 @@ module Increase
             instruction_identification:,
             # Additional information about the reason for the reversal.
             return_reason_additional_information:,
+            # A code provided by the sending bank giving a reason for the reversal. It will
+            # generally be one of the codes defined in the ISO20022
+            # `ExternalReturnReason1Code` code set, but this is not enforced by the network.
+            return_reason_code:,
+            # An Increase-generated description of the `return_reason_code`.
+            return_reason_code_description:,
             # The ID for the Transaction associated with the transfer reversal.
             transaction_id:,
             # The ID for the Wire Transfer that is being reversed.
@@ -9695,6 +9713,8 @@ module Increase
                 input_source: String,
                 instruction_identification: T.nilable(String),
                 return_reason_additional_information: T.nilable(String),
+                return_reason_code: T.nilable(String),
+                return_reason_code_description: T.nilable(String),
                 transaction_id: String,
                 wire_transfer_id: String
               }

data/rbi/increase/models/wire_transfer.rbi

@@ -735,6 +735,16 @@ module Increase
         sig { returns(T.nilable(String)) }
         attr_accessor :return_reason_additional_information
 
+        # A code provided by the sending bank giving a reason for the reversal. It will
+        # generally be one of the codes defined in the ISO20022
+        # `ExternalReturnReason1Code` code set, but this is not enforced by the network.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :return_reason_code
+
+        # An Increase-generated description of the `return_reason_code`.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :return_reason_code_description
+
         # The ID for the Transaction associated with the transfer reversal.
         sig { returns(String) }
         attr_accessor :transaction_id
@@ -756,6 +766,8 @@ module Increase
             input_source: String,
             instruction_identification: T.nilable(String),
             return_reason_additional_information: T.nilable(String),
+            return_reason_code: T.nilable(String),
+            return_reason_code_description: T.nilable(String),
             transaction_id: String,
             wire_transfer_id: String
           ).returns(T.attached_class)
@@ -783,6 +795,12 @@ module Increase
           instruction_identification:,
           # Additional information about the reason for the reversal.
           return_reason_additional_information:,
+          # A code provided by the sending bank giving a reason for the reversal. It will
+          # generally be one of the codes defined in the ISO20022
+          # `ExternalReturnReason1Code` code set, but this is not enforced by the network.
+          return_reason_code:,
+          # An Increase-generated description of the `return_reason_code`.
+          return_reason_code_description:,
           # The ID for the Transaction associated with the transfer reversal.
           transaction_id:,
           # The ID for the Wire Transfer that is being reversed.
@@ -803,6 +821,8 @@ module Increase
               input_source: String,
               instruction_identification: T.nilable(String),
               return_reason_additional_information: T.nilable(String),
+              return_reason_code: T.nilable(String),
+              return_reason_code_description: T.nilable(String),
               transaction_id: String,
               wire_transfer_id: String
             }

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

@@ -15,6 +15,8 @@ module Increase
             account_number_id: String,
             amount: Integer,
             check_number: String,
+            payee_name_analysis:
+              Increase::Simulations::InboundCheckDepositCreateParams::PayeeNameAnalysis::OrSymbol,
             request_options: Increase::RequestOptions::OrHash
           ).returns(Increase::InboundCheckDeposit)
         end
@@ -25,6 +27,10 @@ module Increase
           amount:,
           # The check number on the check to be deposited.
           check_number:,
+          # Simulate the outcome of
+          # [payee name checking](https://increase.com/documentation/positive-pay#payee-name-mismatches).
+          # Defaults to `not_evaluated`.
+          payee_name_analysis: nil,
           request_options: {}
         )
         end

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

@@ -2,7 +2,12 @@ module Increase
   module Models
     module Simulations
       type inbound_check_deposit_create_params =
-        { account_number_id: String, amount: Integer, check_number: String }
+        {
+          account_number_id: String,
+          amount: Integer,
+          check_number: String,
+          payee_name_analysis: Increase::Models::Simulations::InboundCheckDepositCreateParams::payee_name_analysis
+        }
         & Increase::Internal::Type::request_parameters
 
       class InboundCheckDepositCreateParams < Increase::Internal::Type::BaseModel
@@ -15,10 +20,17 @@ module Increase
 
         attr_accessor check_number: String
 
+        attr_reader payee_name_analysis: Increase::Models::Simulations::InboundCheckDepositCreateParams::payee_name_analysis?
+
+        def payee_name_analysis=: (
+          Increase::Models::Simulations::InboundCheckDepositCreateParams::payee_name_analysis
+        ) -> Increase::Models::Simulations::InboundCheckDepositCreateParams::payee_name_analysis
+
         def initialize: (
           account_number_id: String,
           amount: Integer,
           check_number: String,
+          ?payee_name_analysis: Increase::Models::Simulations::InboundCheckDepositCreateParams::payee_name_analysis,
           ?request_options: Increase::request_opts
         ) -> void
 
@@ -26,8 +38,27 @@ module Increase
           account_number_id: String,
           amount: Integer,
           check_number: String,
+          payee_name_analysis: Increase::Models::Simulations::InboundCheckDepositCreateParams::payee_name_analysis,
           request_options: Increase::RequestOptions
         }
+
+        type payee_name_analysis =
+          :name_matches | :does_not_match | :not_evaluated
+
+        module PayeeNameAnalysis
+          extend Increase::Internal::Type::Enum
+
+          # The details on the check match the recipient name of the check transfer.
+          NAME_MATCHES: :name_matches
+
+          # The details on the check do not match the recipient name of the check transfer.
+          DOES_NOT_MATCH: :does_not_match
+
+          # The payee name analysis was not evaluated.
+          NOT_EVALUATED: :not_evaluated
+
+          def self?.values: -> ::Array[Increase::Models::Simulations::InboundCheckDepositCreateParams::payee_name_analysis]
+        end
       end
     end
   end

data/sig/increase/models/transaction.rbs

@@ -3946,6 +3946,8 @@ module Increase
             input_source: String,
             instruction_identification: String?,
             return_reason_additional_information: String?,
+            return_reason_code: String?,
+            return_reason_code_description: String?,
             transaction_id: String,
             wire_transfer_id: String
           }
@@ -3971,6 +3973,10 @@ module Increase
 
           attr_accessor return_reason_additional_information: String?
 
+          attr_accessor return_reason_code: String?
+
+          attr_accessor return_reason_code_description: String?
+
           attr_accessor transaction_id: String
 
           attr_accessor wire_transfer_id: String
@@ -3986,6 +3992,8 @@ module Increase
             input_source: String,
             instruction_identification: String?,
             return_reason_additional_information: String?,
+            return_reason_code: String?,
+            return_reason_code_description: String?,
             transaction_id: String,
             wire_transfer_id: String
           ) -> void
@@ -4001,6 +4009,8 @@ module Increase
             input_source: String,
             instruction_identification: String?,
             return_reason_additional_information: String?,
+            return_reason_code: String?,
+            return_reason_code_description: String?,
             transaction_id: String,
             wire_transfer_id: String
           }

data/sig/increase/models/wire_transfer.rbs

@@ -312,6 +312,8 @@ module Increase
           input_source: String,
           instruction_identification: String?,
           return_reason_additional_information: String?,
+          return_reason_code: String?,
+          return_reason_code_description: String?,
           transaction_id: String,
           wire_transfer_id: String
         }
@@ -337,6 +339,10 @@ module Increase
 
         attr_accessor return_reason_additional_information: String?
 
+        attr_accessor return_reason_code: String?
+
+        attr_accessor return_reason_code_description: String?
+
         attr_accessor transaction_id: String
 
         attr_accessor wire_transfer_id: String
@@ -352,6 +358,8 @@ module Increase
           input_source: String,
           instruction_identification: String?,
           return_reason_additional_information: String?,
+          return_reason_code: String?,
+          return_reason_code_description: String?,
           transaction_id: String,
           wire_transfer_id: String
         ) -> void
@@ -367,6 +375,8 @@ module Increase
           input_source: String,
           instruction_identification: String?,
           return_reason_additional_information: String?,
+          return_reason_code: String?,
+          return_reason_code_description: String?,
           transaction_id: String,
           wire_transfer_id: String
         }

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

@@ -6,6 +6,7 @@ module Increase
           account_number_id: String,
           amount: Integer,
           check_number: String,
+          ?payee_name_analysis: Increase::Models::Simulations::InboundCheckDepositCreateParams::payee_name_analysis,
           ?request_options: Increase::request_opts
         ) -> Increase::InboundCheckDeposit
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: increase
 version: !ruby/object:Gem::Version
-  version: 1.59.0
+  version: 1.61.0
 platform: ruby
 authors:
 - Increase
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-28 00:00:00.000000000 Z
+date: 2025-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool