release: 1.171.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.170.0"
+  ".": "1.171.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 227
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-63db8a5872b6a112abfc879f75a53bc6975994025752e86b27ab327884d94655.yml
-openapi_spec_hash: b7ffb71e0102fcd040a575bf917656e3
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/increase%2Fincrease-4e978c9426fb846c81f3169f5c1bc7aad137577c13e52ac48fcc756e613a1557.yml
+openapi_spec_hash: b44f228e3feac325305cd744c072ebc9
 config_hash: ca52ca9a2968f330339fd50c1a386e05

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 1.171.0 (2026-01-05)
+
+Full Changelog: [v1.170.0...v1.171.0](https://github.com/Increase/increase-ruby/compare/v1.170.0...v1.171.0)
+
+### Features
+
+* **api:** api update ([e98ec1a](https://github.com/Increase/increase-ruby/commit/e98ec1aa3cefbfe4f8afea6a893b6d0c11123b58))
+
 ## 1.170.0 (2026-01-01)
 
 Full Changelog: [v1.169.0...v1.170.0](https://github.com/Increase/increase-ruby/compare/v1.169.0...v1.170.0)

Gemfile.lock

@@ -11,7 +11,7 @@ GIT
 PATH
   remote: .
   specs:
-    increase (1.170.0)
+    increase (1.171.0)
       connection_pool
 
 GEM

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

lib/increase/models/card_dispute.rb

@@ -1576,6 +1576,13 @@ class UserSubmission < Increase::Internal::Type::BaseModel
           #   @return [Time]
           required :created_at, Time
 
+          # @!attribute explanation
+          #   The free-form explanation provided to Increase to provide more context for the
+          #   user submission. This field is not sent directly to the card networks.
+          #
+          #   @return [String, nil]
+          required :explanation, String, nil?: true
+
           # @!attribute further_information_requested_at
           #   The date and time at which Increase requested further information from the user
           #   for the Visa Card Dispute.
@@ -1625,7 +1632,7 @@ class UserSubmission < Increase::Internal::Type::BaseModel
                    -> { Increase::CardDispute::Visa::UserSubmission::UserPrearbitration },
                    nil?: true
 
-          # @!method initialize(accepted_at:, amount:, attachment_files:, category:, chargeback:, created_at:, further_information_requested_at:, further_information_requested_reason:, merchant_prearbitration_decline:, status:, updated_at:, user_prearbitration:)
+          # @!method initialize(accepted_at:, amount:, attachment_files:, category:, chargeback:, created_at:, explanation:, further_information_requested_at:, further_information_requested_reason:, merchant_prearbitration_decline:, status:, updated_at:, user_prearbitration:)
           #   Some parameter documentations has been truncated, see
           #   {Increase::Models::CardDispute::Visa::UserSubmission} for more details.
           #
@@ -1641,6 +1648,8 @@ class UserSubmission < Increase::Internal::Type::BaseModel
           #
           #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
           #
+          #   @param explanation [String, nil] The free-form explanation provided to Increase to provide more context for the u
+          #
           #   @param further_information_requested_at [Time, nil] The date and time at which Increase requested further information from the user
           #
           #   @param further_information_requested_reason [String, nil] The reason for Increase requesting further information from the user for the Vis

lib/increase/models/card_dispute_create_params.rb

@@ -37,14 +37,21 @@ class CardDisputeCreateParams < Increase::Internal::Type::BaseModel
       optional :attachment_files,
                -> { Increase::Internal::Type::ArrayOf[Increase::CardDisputeCreateParams::AttachmentFile] }
 
+      # @!attribute explanation
+      #   The free-form explanation provided to Increase to provide more context for the
+      #   user submission. This field is not sent directly to the card networks.
+      #
+      #   @return [String, nil]
+      optional :explanation, String
+
       # @!attribute visa
       #   The Visa-specific parameters for the dispute. Required if and only if `network`
       #   is `visa`.
       #
       #   @return [Increase::Models::CardDisputeCreateParams::Visa, nil]
       optional :visa, -> { Increase::CardDisputeCreateParams::Visa }
 
-      # @!method initialize(disputed_transaction_id:, network:, amount: nil, attachment_files: nil, visa: nil, request_options: {})
+      # @!method initialize(disputed_transaction_id:, network:, amount: nil, attachment_files: nil, explanation: nil, visa: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Increase::Models::CardDisputeCreateParams} for more details.
       #
@@ -56,6 +63,8 @@ class CardDisputeCreateParams < Increase::Internal::Type::BaseModel
       #
       #   @param attachment_files [Array<Increase::Models::CardDisputeCreateParams::AttachmentFile>] The files to be attached to the initial dispute submission.
       #
+      #   @param explanation [String] The free-form explanation provided to Increase to provide more context for the u
+      #
       #   @param visa [Increase::Models::CardDisputeCreateParams::Visa] The Visa-specific parameters for the dispute. Required if and only if `network`
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]

lib/increase/models/card_dispute_submit_user_submission_params.rb

@@ -30,14 +30,21 @@ class CardDisputeSubmitUserSubmissionParams < Increase::Internal::Type::BaseMode
       optional :attachment_files,
                -> { Increase::Internal::Type::ArrayOf[Increase::CardDisputeSubmitUserSubmissionParams::AttachmentFile] }
 
+      # @!attribute explanation
+      #   The free-form explanation provided to Increase to provide more context for the
+      #   user submission. This field is not sent directly to the card networks.
+      #
+      #   @return [String, nil]
+      optional :explanation, String
+
       # @!attribute visa
       #   The Visa-specific parameters for the dispute. Required if and only if `network`
       #   is `visa`.
       #
       #   @return [Increase::Models::CardDisputeSubmitUserSubmissionParams::Visa, nil]
       optional :visa, -> { Increase::CardDisputeSubmitUserSubmissionParams::Visa }
 
-      # @!method initialize(network:, amount: nil, attachment_files: nil, visa: nil, request_options: {})
+      # @!method initialize(network:, amount: nil, attachment_files: nil, explanation: nil, visa: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Increase::Models::CardDisputeSubmitUserSubmissionParams} for more details.
       #
@@ -47,6 +54,8 @@ class CardDisputeSubmitUserSubmissionParams < Increase::Internal::Type::BaseMode
       #
       #   @param attachment_files [Array<Increase::Models::CardDisputeSubmitUserSubmissionParams::AttachmentFile>] The files to be attached to the user submission.
       #
+      #   @param explanation [String] The free-form explanation provided to Increase to provide more context for the u
+      #
       #   @param visa [Increase::Models::CardDisputeSubmitUserSubmissionParams::Visa] The Visa-specific parameters for the dispute. Required if and only if `network`
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]

lib/increase/resources/card_disputes.rb

@@ -8,7 +8,7 @@ class CardDisputes
       #
       # Create a Card Dispute
       #
-      # @overload create(disputed_transaction_id:, network:, amount: nil, attachment_files: nil, visa: nil, request_options: {})
+      # @overload create(disputed_transaction_id:, network:, amount: nil, attachment_files: nil, explanation: nil, visa: nil, request_options: {})
       #
       # @param disputed_transaction_id [String] The Transaction you wish to dispute. This Transaction must have a `source_type`
       #
@@ -18,6 +18,8 @@ class CardDisputes
       #
       # @param attachment_files [Array<Increase::Models::CardDisputeCreateParams::AttachmentFile>] The files to be attached to the initial dispute submission.
       #
+      # @param explanation [String] The free-form explanation provided to Increase to provide more context for the u
+      #
       # @param visa [Increase::Models::CardDisputeCreateParams::Visa] The Visa-specific parameters for the dispute. Required if and only if `network`
       #
       # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -95,7 +97,7 @@ def list(params = {})
       #
       # Submit a User Submission for a Card Dispute
       #
-      # @overload submit_user_submission(card_dispute_id, network:, amount: nil, attachment_files: nil, visa: nil, request_options: {})
+      # @overload submit_user_submission(card_dispute_id, network:, amount: nil, attachment_files: nil, explanation: nil, visa: nil, request_options: {})
       #
       # @param card_dispute_id [String] The identifier of the Card Dispute to submit a user submission for.
       #
@@ -105,6 +107,8 @@ def list(params = {})
       #
       # @param attachment_files [Array<Increase::Models::CardDisputeSubmitUserSubmissionParams::AttachmentFile>] The files to be attached to the user submission.
       #
+      # @param explanation [String] The free-form explanation provided to Increase to provide more context for the u
+      #
       # @param visa [Increase::Models::CardDisputeSubmitUserSubmissionParams::Visa] The Visa-specific parameters for the dispute. Required if and only if `network`
       #
       # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]

lib/increase/version.rb

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

rbi/increase/models/card_dispute.rbi

@@ -3256,6 +3256,11 @@ module Increase
           sig { returns(Time) }
           attr_accessor :created_at
 
+          # The free-form explanation provided to Increase to provide more context for the
+          # user submission. This field is not sent directly to the card networks.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :explanation
+
           # The date and time at which Increase requested further information from the user
           # for the Visa Card Dispute.
           sig { returns(T.nilable(Time)) }
@@ -3340,6 +3345,7 @@ module Increase
                   Increase::CardDispute::Visa::UserSubmission::Chargeback::OrHash
                 ),
               created_at: Time,
+              explanation: T.nilable(String),
               further_information_requested_at: T.nilable(Time),
               further_information_requested_reason: T.nilable(String),
               merchant_prearbitration_decline:
@@ -3376,6 +3382,9 @@ module Increase
             # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
             # the Visa Card Dispute User Submission was created.
             created_at:,
+            # The free-form explanation provided to Increase to provide more context for the
+            # user submission. This field is not sent directly to the card networks.
+            explanation:,
             # The date and time at which Increase requested further information from the user
             # for the Visa Card Dispute.
             further_information_requested_at:,
@@ -3416,6 +3425,7 @@ module Increase
                     Increase::CardDispute::Visa::UserSubmission::Chargeback
                   ),
                 created_at: Time,
+                explanation: T.nilable(String),
                 further_information_requested_at: T.nilable(Time),
                 further_information_requested_reason: T.nilable(String),
                 merchant_prearbitration_decline:

rbi/increase/models/card_dispute_create_params.rbi

@@ -47,6 +47,14 @@ module Increase
       end
       attr_writer :attachment_files
 
+      # The free-form explanation provided to Increase to provide more context for the
+      # user submission. This field is not sent directly to the card networks.
+      sig { returns(T.nilable(String)) }
+      attr_reader :explanation
+
+      sig { params(explanation: String).void }
+      attr_writer :explanation
+
       # The Visa-specific parameters for the dispute. Required if and only if `network`
       # is `visa`.
       sig { returns(T.nilable(Increase::CardDisputeCreateParams::Visa)) }
@@ -62,6 +70,7 @@ module Increase
           amount: Integer,
           attachment_files:
             T::Array[Increase::CardDisputeCreateParams::AttachmentFile::OrHash],
+          explanation: String,
           visa: Increase::CardDisputeCreateParams::Visa::OrHash,
           request_options: Increase::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -80,6 +89,9 @@ module Increase
         amount: nil,
         # The files to be attached to the initial dispute submission.
         attachment_files: nil,
+        # The free-form explanation provided to Increase to provide more context for the
+        # user submission. This field is not sent directly to the card networks.
+        explanation: nil,
         # The Visa-specific parameters for the dispute. Required if and only if `network`
         # is `visa`.
         visa: nil,
@@ -95,6 +107,7 @@ module Increase
             amount: Integer,
             attachment_files:
               T::Array[Increase::CardDisputeCreateParams::AttachmentFile],
+            explanation: String,
             visa: Increase::CardDisputeCreateParams::Visa,
             request_options: Increase::RequestOptions
           }

rbi/increase/models/card_dispute_submit_user_submission_params.rbi

@@ -55,6 +55,14 @@ module Increase
       end
       attr_writer :attachment_files
 
+      # The free-form explanation provided to Increase to provide more context for the
+      # user submission. This field is not sent directly to the card networks.
+      sig { returns(T.nilable(String)) }
+      attr_reader :explanation
+
+      sig { params(explanation: String).void }
+      attr_writer :explanation
+
       # The Visa-specific parameters for the dispute. Required if and only if `network`
       # is `visa`.
       sig do
@@ -80,6 +88,7 @@ module Increase
             T::Array[
               Increase::CardDisputeSubmitUserSubmissionParams::AttachmentFile::OrHash
             ],
+          explanation: String,
           visa: Increase::CardDisputeSubmitUserSubmissionParams::Visa::OrHash,
           request_options: Increase::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -95,6 +104,9 @@ module Increase
         amount: nil,
         # The files to be attached to the user submission.
         attachment_files: nil,
+        # The free-form explanation provided to Increase to provide more context for the
+        # user submission. This field is not sent directly to the card networks.
+        explanation: nil,
         # The Visa-specific parameters for the dispute. Required if and only if `network`
         # is `visa`.
         visa: nil,
@@ -112,6 +124,7 @@ module Increase
               T::Array[
                 Increase::CardDisputeSubmitUserSubmissionParams::AttachmentFile
               ],
+            explanation: String,
             visa: Increase::CardDisputeSubmitUserSubmissionParams::Visa,
             request_options: Increase::RequestOptions
           }

rbi/increase/resources/card_disputes.rbi

@@ -11,6 +11,7 @@ module Increase
           amount: Integer,
           attachment_files:
             T::Array[Increase::CardDisputeCreateParams::AttachmentFile::OrHash],
+          explanation: String,
           visa: Increase::CardDisputeCreateParams::Visa::OrHash,
           request_options: Increase::RequestOptions::OrHash
         ).returns(Increase::CardDispute)
@@ -29,6 +30,9 @@ module Increase
         amount: nil,
         # The files to be attached to the initial dispute submission.
         attachment_files: nil,
+        # The free-form explanation provided to Increase to provide more context for the
+        # user submission. This field is not sent directly to the card networks.
+        explanation: nil,
         # The Visa-specific parameters for the dispute. Required if and only if `network`
         # is `visa`.
         visa: nil,
@@ -89,6 +93,7 @@ module Increase
             T::Array[
               Increase::CardDisputeSubmitUserSubmissionParams::AttachmentFile::OrHash
             ],
+          explanation: String,
           visa: Increase::CardDisputeSubmitUserSubmissionParams::Visa::OrHash,
           request_options: Increase::RequestOptions::OrHash
         ).returns(Increase::CardDispute)
@@ -106,6 +111,9 @@ module Increase
         amount: nil,
         # The files to be attached to the user submission.
         attachment_files: nil,
+        # The free-form explanation provided to Increase to provide more context for the
+        # user submission. This field is not sent directly to the card networks.
+        explanation: nil,
         # The Visa-specific parameters for the dispute. Required if and only if `network`
         # is `visa`.
         visa: nil,

sig/increase/models/card_dispute.rbs

@@ -1150,6 +1150,7 @@ module Increase
             category: Increase::Models::CardDispute::Visa::UserSubmission::category,
             chargeback: Increase::CardDispute::Visa::UserSubmission::Chargeback?,
             created_at: Time,
+            explanation: String?,
             further_information_requested_at: Time?,
             further_information_requested_reason: String?,
             merchant_prearbitration_decline: Increase::CardDispute::Visa::UserSubmission::MerchantPrearbitrationDecline?,
@@ -1171,6 +1172,8 @@ module Increase
 
           attr_accessor created_at: Time
 
+          attr_accessor explanation: String?
+
           attr_accessor further_information_requested_at: Time?
 
           attr_accessor further_information_requested_reason: String?
@@ -1190,6 +1193,7 @@ module Increase
             category: Increase::Models::CardDispute::Visa::UserSubmission::category,
             chargeback: Increase::CardDispute::Visa::UserSubmission::Chargeback?,
             created_at: Time,
+            explanation: String?,
             further_information_requested_at: Time?,
             further_information_requested_reason: String?,
             merchant_prearbitration_decline: Increase::CardDispute::Visa::UserSubmission::MerchantPrearbitrationDecline?,
@@ -1205,6 +1209,7 @@ module Increase
             category: Increase::Models::CardDispute::Visa::UserSubmission::category,
             chargeback: Increase::CardDispute::Visa::UserSubmission::Chargeback?,
             created_at: Time,
+            explanation: String?,
             further_information_requested_at: Time?,
             further_information_requested_reason: String?,
             merchant_prearbitration_decline: Increase::CardDispute::Visa::UserSubmission::MerchantPrearbitrationDecline?,