increase 1.170.0 → 1.171.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fed3d4b381eac9f8e582a37e3ac2602c3a71ccd4772152f72cef6d7f9c49d154
-  data.tar.gz: 868f654aeeeef679d4bbefe93eb8cd1d64b286fe3b63476355ef9bc192532d68
+  metadata.gz: bf479961e101c6eb36453f95deedb7882d423857ef53e400994ba8fb510720b0
+  data.tar.gz: c0d4a15b9864b7bace063191707936cde539ca8da84a888c57ad6eb3e88656cb
 SHA512:
-  metadata.gz: 1264994393411d3f114a2385401049d0f94db09b9c22a638a670806323f17c8bafe392047b264fd42f363c126d01c76febba51071fa216ad7b9634ec474fffe5
-  data.tar.gz: 9339684a52a84d2e0daab0bb03671371225d84c760c4034e4f46f348319ad2914b28e312414536499d7f329416aa8d0a5d1b8bd8e994e2dfe4749492b3b7d4b5
+  metadata.gz: 64d64411025bdcc02e66f392f81d416f2e89fa2a4e0446b34c94181e36ffce9bc629adc254099beb9e2a6a86e553c734fc69e7db00ccb1b9691989ec7a8fbf4e
+  data.tar.gz: fbf30813d6b66bbbb705ec6fef5529e0c2030fe5e189dc8749d3b3426c89a68d8399656f1c4c9ca1de43b2d42b90818659b2931dfdf7242f421e57a92c9a9178

data/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)

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

data/lib/increase/models/card_dispute.rb

@@ -1576,6 +1576,13 @@ module Increase
           #   @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 @@ module Increase
                    -> { 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 @@ module Increase
           #
           #   @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

data/lib/increase/models/card_dispute_create_params.rb

@@ -37,6 +37,13 @@ module Increase
       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`.
@@ -44,7 +51,7 @@ module Increase
       #   @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 @@ module Increase
       #
       #   @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}]

data/lib/increase/models/card_dispute_submit_user_submission_params.rb

@@ -30,6 +30,13 @@ module Increase
       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`.
@@ -37,7 +44,7 @@ module Increase
       #   @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 @@ module Increase
       #
       #   @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}]

data/lib/increase/resources/card_disputes.rb

@@ -8,7 +8,7 @@ module Increase
       #
       # 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 @@ module Increase
       #
       # @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 @@ module Increase
       #
       # 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 @@ module Increase
       #
       # @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]

data/lib/increase/version.rb

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

data/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:

data/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
           }

data/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
           }

data/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,

data/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?,

data/sig/increase/models/card_dispute_create_params.rbs

@@ -6,6 +6,7 @@ module Increase
         network: Increase::Models::CardDisputeCreateParams::network,
         amount: Integer,
         attachment_files: ::Array[Increase::CardDisputeCreateParams::AttachmentFile],
+        explanation: String,
         visa: Increase::CardDisputeCreateParams::Visa
       }
       & Increase::Internal::Type::request_parameters
@@ -28,6 +29,10 @@ module Increase
         ::Array[Increase::CardDisputeCreateParams::AttachmentFile]
       ) -> ::Array[Increase::CardDisputeCreateParams::AttachmentFile]
 
+      attr_reader explanation: String?
+
+      def explanation=: (String) -> String
+
       attr_reader visa: Increase::CardDisputeCreateParams::Visa?
 
       def visa=: (
@@ -39,6 +44,7 @@ module Increase
         network: Increase::Models::CardDisputeCreateParams::network,
         ?amount: Integer,
         ?attachment_files: ::Array[Increase::CardDisputeCreateParams::AttachmentFile],
+        ?explanation: String,
         ?visa: Increase::CardDisputeCreateParams::Visa,
         ?request_options: Increase::request_opts
       ) -> void
@@ -48,6 +54,7 @@ module Increase
         network: Increase::Models::CardDisputeCreateParams::network,
         amount: Integer,
         attachment_files: ::Array[Increase::CardDisputeCreateParams::AttachmentFile],
+        explanation: String,
         visa: Increase::CardDisputeCreateParams::Visa,
         request_options: Increase::RequestOptions
       }

data/sig/increase/models/card_dispute_submit_user_submission_params.rbs

@@ -5,6 +5,7 @@ module Increase
         network: Increase::Models::CardDisputeSubmitUserSubmissionParams::network,
         amount: Integer,
         attachment_files: ::Array[Increase::CardDisputeSubmitUserSubmissionParams::AttachmentFile],
+        explanation: String,
         visa: Increase::CardDisputeSubmitUserSubmissionParams::Visa
       }
       & Increase::Internal::Type::request_parameters
@@ -25,6 +26,10 @@ module Increase
         ::Array[Increase::CardDisputeSubmitUserSubmissionParams::AttachmentFile]
       ) -> ::Array[Increase::CardDisputeSubmitUserSubmissionParams::AttachmentFile]
 
+      attr_reader explanation: String?
+
+      def explanation=: (String) -> String
+
       attr_reader visa: Increase::CardDisputeSubmitUserSubmissionParams::Visa?
 
       def visa=: (
@@ -35,6 +40,7 @@ module Increase
         network: Increase::Models::CardDisputeSubmitUserSubmissionParams::network,
         ?amount: Integer,
         ?attachment_files: ::Array[Increase::CardDisputeSubmitUserSubmissionParams::AttachmentFile],
+        ?explanation: String,
         ?visa: Increase::CardDisputeSubmitUserSubmissionParams::Visa,
         ?request_options: Increase::request_opts
       ) -> void
@@ -43,6 +49,7 @@ module Increase
         network: Increase::Models::CardDisputeSubmitUserSubmissionParams::network,
         amount: Integer,
         attachment_files: ::Array[Increase::CardDisputeSubmitUserSubmissionParams::AttachmentFile],
+        explanation: String,
         visa: Increase::CardDisputeSubmitUserSubmissionParams::Visa,
         request_options: Increase::RequestOptions
       }

data/sig/increase/resources/card_disputes.rbs

@@ -6,6 +6,7 @@ module Increase
         network: Increase::Models::CardDisputeCreateParams::network,
         ?amount: Integer,
         ?attachment_files: ::Array[Increase::CardDisputeCreateParams::AttachmentFile],
+        ?explanation: String,
         ?visa: Increase::CardDisputeCreateParams::Visa,
         ?request_options: Increase::request_opts
       ) -> Increase::CardDispute
@@ -29,6 +30,7 @@ module Increase
         network: Increase::Models::CardDisputeSubmitUserSubmissionParams::network,
         ?amount: Integer,
         ?attachment_files: ::Array[Increase::CardDisputeSubmitUserSubmissionParams::AttachmentFile],
+        ?explanation: String,
         ?visa: Increase::CardDisputeSubmitUserSubmissionParams::Visa,
         ?request_options: Increase::request_opts
       ) -> Increase::CardDispute

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: increase
 version: !ruby/object:Gem::Version
-  version: 1.170.0
+  version: 1.171.0
 platform: ruby
 authors:
 - Increase
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-01 00:00:00.000000000 Z
+date: 2026-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool