increase 1.98.0 → 1.99.0

data/rbi/increase/models/card_dispute_withdraw_params.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Increase
+  module Models
+    class CardDisputeWithdrawParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Increase::CardDisputeWithdrawParams,
+            Increase::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: Increase::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Increase::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/increase/models/simulations/card_dispute_action_params.rbi

@@ -0,0 +1,419 @@
+# typed: strong
+
+module Increase
+  module Models
+    module Simulations
+      class CardDisputeActionParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::Simulations::CardDisputeActionParams,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The network of the Card Dispute. Details specific to the network are required
+        # under the sub-object with the same identifier as the network.
+        sig do
+          returns(
+            Increase::Simulations::CardDisputeActionParams::Network::OrSymbol
+          )
+        end
+        attr_accessor :network
+
+        # The Visa-specific parameters for the taking action on the dispute. Required if
+        # and only if `network` is `visa`.
+        sig do
+          returns(
+            T.nilable(Increase::Simulations::CardDisputeActionParams::Visa)
+          )
+        end
+        attr_reader :visa
+
+        sig do
+          params(
+            visa: Increase::Simulations::CardDisputeActionParams::Visa::OrHash
+          ).void
+        end
+        attr_writer :visa
+
+        sig do
+          params(
+            network:
+              Increase::Simulations::CardDisputeActionParams::Network::OrSymbol,
+            visa: Increase::Simulations::CardDisputeActionParams::Visa::OrHash,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The network of the Card Dispute. Details specific to the network are required
+          # under the sub-object with the same identifier as the network.
+          network:,
+          # The Visa-specific parameters for the taking action on the dispute. Required if
+          # and only if `network` is `visa`.
+          visa: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              network:
+                Increase::Simulations::CardDisputeActionParams::Network::OrSymbol,
+              visa: Increase::Simulations::CardDisputeActionParams::Visa,
+              request_options: Increase::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The network of the Card Dispute. Details specific to the network are required
+        # under the sub-object with the same identifier as the network.
+        module Network
+          extend Increase::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Increase::Simulations::CardDisputeActionParams::Network
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # Visa
+          VISA =
+            T.let(
+              :visa,
+              Increase::Simulations::CardDisputeActionParams::Network::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Increase::Simulations::CardDisputeActionParams::Network::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class Visa < Increase::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Increase::Simulations::CardDisputeActionParams::Visa,
+                Increase::Internal::AnyHash
+              )
+            end
+
+          # The action to take. Details specific to the action are required under the
+          # sub-object with the same identifier as the action.
+          sig do
+            returns(
+              Increase::Simulations::CardDisputeActionParams::Visa::Action::OrSymbol
+            )
+          end
+          attr_accessor :action
+
+          # The parameters for accepting the chargeback. Required if and only if `action` is
+          # `accept_chargeback`.
+          sig { returns(T.nilable(T.anything)) }
+          attr_reader :accept_chargeback
+
+          sig { params(accept_chargeback: T.anything).void }
+          attr_writer :accept_chargeback
+
+          # The parameters for accepting the user submission. Required if and only if
+          # `action` is `accept_user_submission`.
+          sig { returns(T.nilable(T.anything)) }
+          attr_reader :accept_user_submission
+
+          sig { params(accept_user_submission: T.anything).void }
+          attr_writer :accept_user_submission
+
+          # The parameters for declining the prearbitration. Required if and only if
+          # `action` is `decline_user_prearbitration`.
+          sig { returns(T.nilable(T.anything)) }
+          attr_reader :decline_user_prearbitration
+
+          sig { params(decline_user_prearbitration: T.anything).void }
+          attr_writer :decline_user_prearbitration
+
+          # The parameters for receiving the prearbitration. Required if and only if
+          # `action` is `receive_merchant_prearbitration`.
+          sig { returns(T.nilable(T.anything)) }
+          attr_reader :receive_merchant_prearbitration
+
+          sig { params(receive_merchant_prearbitration: T.anything).void }
+          attr_writer :receive_merchant_prearbitration
+
+          # The parameters for re-presenting the dispute. Required if and only if `action`
+          # is `represent`.
+          sig { returns(T.nilable(T.anything)) }
+          attr_reader :represent
+
+          sig { params(represent: T.anything).void }
+          attr_writer :represent
+
+          # The parameters for requesting further information from the user. Required if and
+          # only if `action` is `request_further_information`.
+          sig do
+            returns(
+              T.nilable(
+                Increase::Simulations::CardDisputeActionParams::Visa::RequestFurtherInformation
+              )
+            )
+          end
+          attr_reader :request_further_information
+
+          sig do
+            params(
+              request_further_information:
+                Increase::Simulations::CardDisputeActionParams::Visa::RequestFurtherInformation::OrHash
+            ).void
+          end
+          attr_writer :request_further_information
+
+          # The parameters for timing out the chargeback. Required if and only if `action`
+          # is `time_out_chargeback`.
+          sig { returns(T.nilable(T.anything)) }
+          attr_reader :time_out_chargeback
+
+          sig { params(time_out_chargeback: T.anything).void }
+          attr_writer :time_out_chargeback
+
+          # The parameters for timing out the merchant prearbitration. Required if and only
+          # if `action` is `time_out_merchant_prearbitration`.
+          sig { returns(T.nilable(T.anything)) }
+          attr_reader :time_out_merchant_prearbitration
+
+          sig { params(time_out_merchant_prearbitration: T.anything).void }
+          attr_writer :time_out_merchant_prearbitration
+
+          # The parameters for timing out the re-presentment. Required if and only if
+          # `action` is `time_out_representment`.
+          sig { returns(T.nilable(T.anything)) }
+          attr_reader :time_out_representment
+
+          sig { params(time_out_representment: T.anything).void }
+          attr_writer :time_out_representment
+
+          # The parameters for timing out the user prearbitration. Required if and only if
+          # `action` is `time_out_user_prearbitration`.
+          sig { returns(T.nilable(T.anything)) }
+          attr_reader :time_out_user_prearbitration
+
+          sig { params(time_out_user_prearbitration: T.anything).void }
+          attr_writer :time_out_user_prearbitration
+
+          # The Visa-specific parameters for the taking action on the dispute. Required if
+          # and only if `network` is `visa`.
+          sig do
+            params(
+              action:
+                Increase::Simulations::CardDisputeActionParams::Visa::Action::OrSymbol,
+              accept_chargeback: T.anything,
+              accept_user_submission: T.anything,
+              decline_user_prearbitration: T.anything,
+              receive_merchant_prearbitration: T.anything,
+              represent: T.anything,
+              request_further_information:
+                Increase::Simulations::CardDisputeActionParams::Visa::RequestFurtherInformation::OrHash,
+              time_out_chargeback: T.anything,
+              time_out_merchant_prearbitration: T.anything,
+              time_out_representment: T.anything,
+              time_out_user_prearbitration: T.anything
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The action to take. Details specific to the action are required under the
+            # sub-object with the same identifier as the action.
+            action:,
+            # The parameters for accepting the chargeback. Required if and only if `action` is
+            # `accept_chargeback`.
+            accept_chargeback: nil,
+            # The parameters for accepting the user submission. Required if and only if
+            # `action` is `accept_user_submission`.
+            accept_user_submission: nil,
+            # The parameters for declining the prearbitration. Required if and only if
+            # `action` is `decline_user_prearbitration`.
+            decline_user_prearbitration: nil,
+            # The parameters for receiving the prearbitration. Required if and only if
+            # `action` is `receive_merchant_prearbitration`.
+            receive_merchant_prearbitration: nil,
+            # The parameters for re-presenting the dispute. Required if and only if `action`
+            # is `represent`.
+            represent: nil,
+            # The parameters for requesting further information from the user. Required if and
+            # only if `action` is `request_further_information`.
+            request_further_information: nil,
+            # The parameters for timing out the chargeback. Required if and only if `action`
+            # is `time_out_chargeback`.
+            time_out_chargeback: nil,
+            # The parameters for timing out the merchant prearbitration. Required if and only
+            # if `action` is `time_out_merchant_prearbitration`.
+            time_out_merchant_prearbitration: nil,
+            # The parameters for timing out the re-presentment. Required if and only if
+            # `action` is `time_out_representment`.
+            time_out_representment: nil,
+            # The parameters for timing out the user prearbitration. Required if and only if
+            # `action` is `time_out_user_prearbitration`.
+            time_out_user_prearbitration: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                action:
+                  Increase::Simulations::CardDisputeActionParams::Visa::Action::OrSymbol,
+                accept_chargeback: T.anything,
+                accept_user_submission: T.anything,
+                decline_user_prearbitration: T.anything,
+                receive_merchant_prearbitration: T.anything,
+                represent: T.anything,
+                request_further_information:
+                  Increase::Simulations::CardDisputeActionParams::Visa::RequestFurtherInformation,
+                time_out_chargeback: T.anything,
+                time_out_merchant_prearbitration: T.anything,
+                time_out_representment: T.anything,
+                time_out_user_prearbitration: T.anything
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The action to take. Details specific to the action are required under the
+          # sub-object with the same identifier as the action.
+          module Action
+            extend Increase::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Increase::Simulations::CardDisputeActionParams::Visa::Action
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            # Simulate the merchant accepting the chargeback. This will move the dispute to a `won` state.
+            ACCEPT_CHARGEBACK =
+              T.let(
+                :accept_chargeback,
+                Increase::Simulations::CardDisputeActionParams::Visa::Action::TaggedSymbol
+              )
+
+            # Accept the user's submission and transmit it to the network. This will move the dispute to a `pending_response` state.
+            ACCEPT_USER_SUBMISSION =
+              T.let(
+                :accept_user_submission,
+                Increase::Simulations::CardDisputeActionParams::Visa::Action::TaggedSymbol
+              )
+
+            # Simulate the merchant declining the user's pre-arbitration. This will move the dispute to a `lost` state.
+            DECLINE_USER_PREARBITRATION =
+              T.let(
+                :decline_user_prearbitration,
+                Increase::Simulations::CardDisputeActionParams::Visa::Action::TaggedSymbol
+              )
+
+            # Simulate the merchant issuing pre-arbitration. This will move the dispute to a `user_submission_required` state.
+            RECEIVE_MERCHANT_PREARBITRATION =
+              T.let(
+                :receive_merchant_prearbitration,
+                Increase::Simulations::CardDisputeActionParams::Visa::Action::TaggedSymbol
+              )
+
+            # Simulate the merchant re-presenting the dispute. This will move the dispute to a `user_submission_required` state.
+            REPRESENT =
+              T.let(
+                :represent,
+                Increase::Simulations::CardDisputeActionParams::Visa::Action::TaggedSymbol
+              )
+
+            # Simulate further information being requested from the user. This will move the dispute to a `user_submission_required` state.
+            REQUEST_FURTHER_INFORMATION =
+              T.let(
+                :request_further_information,
+                Increase::Simulations::CardDisputeActionParams::Visa::Action::TaggedSymbol
+              )
+
+            # Simulate the merchant timing out responding to the chargeback. This will move the dispute to a `won` state.
+            TIME_OUT_CHARGEBACK =
+              T.let(
+                :time_out_chargeback,
+                Increase::Simulations::CardDisputeActionParams::Visa::Action::TaggedSymbol
+              )
+
+            # Simulate the user timing out responding to a merchant pre-arbitration. This will move the dispute to a `lost` state.
+            TIME_OUT_MERCHANT_PREARBITRATION =
+              T.let(
+                :time_out_merchant_prearbitration,
+                Increase::Simulations::CardDisputeActionParams::Visa::Action::TaggedSymbol
+              )
+
+            # Simulate the user timing out responding to a merchant re-presentment. This will move the dispute to a `lost` state.
+            TIME_OUT_REPRESENTMENT =
+              T.let(
+                :time_out_representment,
+                Increase::Simulations::CardDisputeActionParams::Visa::Action::TaggedSymbol
+              )
+
+            # Simulate the merchant timing out responding to a user pre-arbitration. This will move the dispute to a `win` state.
+            TIME_OUT_USER_PREARBITRATION =
+              T.let(
+                :time_out_user_prearbitration,
+                Increase::Simulations::CardDisputeActionParams::Visa::Action::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Increase::Simulations::CardDisputeActionParams::Visa::Action::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          class RequestFurtherInformation < Increase::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Increase::Simulations::CardDisputeActionParams::Visa::RequestFurtherInformation,
+                  Increase::Internal::AnyHash
+                )
+              end
+
+            # The reason for requesting further information from the user.
+            sig { returns(String) }
+            attr_accessor :reason
+
+            # The parameters for requesting further information from the user. Required if and
+            # only if `action` is `request_further_information`.
+            sig { params(reason: String).returns(T.attached_class) }
+            def self.new(
+              # The reason for requesting further information from the user.
+              reason:
+            )
+            end
+
+            sig { override.returns({ reason: String }) }
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/increase/models.rbi

@@ -113,6 +113,19 @@ module Increase
 
   CardDetailsParams = Increase::Models::CardDetailsParams
 
+  CardDispute = Increase::Models::CardDispute
+
+  CardDisputeCreateParams = Increase::Models::CardDisputeCreateParams
+
+  CardDisputeListParams = Increase::Models::CardDisputeListParams
+
+  CardDisputeRetrieveParams = Increase::Models::CardDisputeRetrieveParams
+
+  CardDisputeSubmitUserSubmissionParams =
+    Increase::Models::CardDisputeSubmitUserSubmissionParams
+
+  CardDisputeWithdrawParams = Increase::Models::CardDisputeWithdrawParams
+
   CardIframeURL = Increase::Models::CardIframeURL
 
   CardListParams = Increase::Models::CardListParams

data/rbi/increase/resources/card_disputes.rbi

@@ -0,0 +1,136 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class CardDisputes
+      # Create a Card Dispute
+      sig do
+        params(
+          disputed_transaction_id: String,
+          network: Increase::CardDisputeCreateParams::Network::OrSymbol,
+          amount: Integer,
+          attachment_files:
+            T::Array[Increase::CardDisputeCreateParams::AttachmentFile::OrHash],
+          visa: Increase::CardDisputeCreateParams::Visa::OrHash,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::CardDispute)
+      end
+      def create(
+        # The Transaction you wish to dispute. This Transaction must have a `source_type`
+        # of `card_settlement`.
+        disputed_transaction_id:,
+        # The network of the disputed transaction. Details specific to the network are
+        # required under the sub-object with the same identifier as the network.
+        network:,
+        # The monetary amount of the part of the transaction that is being disputed. This
+        # is optional and will default to the full amount of the transaction if not
+        # provided. If provided, the amount must be less than or equal to the amount of
+        # the transaction.
+        amount: nil,
+        # The files to be attached to the initial dispute submission.
+        attachment_files: nil,
+        # The Visa-specific parameters for the dispute. Required if and only if `network`
+        # is `visa`.
+        visa: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieve a Card Dispute
+      sig do
+        params(
+          card_dispute_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::CardDispute)
+      end
+      def retrieve(
+        # The identifier of the Card Dispute.
+        card_dispute_id,
+        request_options: {}
+      )
+      end
+
+      # List Card Disputes
+      sig do
+        params(
+          created_at: Increase::CardDisputeListParams::CreatedAt::OrHash,
+          cursor: String,
+          idempotency_key: String,
+          limit: Integer,
+          status: Increase::CardDisputeListParams::Status::OrHash,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::Internal::Page[Increase::CardDispute])
+      end
+      def list(
+        created_at: nil,
+        # Return the page of entries after this one.
+        cursor: nil,
+        # Filter records to the one with the specified `idempotency_key` you chose for
+        # that object. This value is unique across Increase and is used to ensure that a
+        # request is only processed once. Learn more about
+        # [idempotency](https://increase.com/documentation/idempotency-keys).
+        idempotency_key: nil,
+        # Limit the size of the list that is returned. The default (and maximum) is 100
+        # objects.
+        limit: nil,
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      # Submit a User Submission for a Card Dispute
+      sig do
+        params(
+          card_dispute_id: String,
+          network:
+            Increase::CardDisputeSubmitUserSubmissionParams::Network::OrSymbol,
+          amount: Integer,
+          attachment_files:
+            T::Array[
+              Increase::CardDisputeSubmitUserSubmissionParams::AttachmentFile::OrHash
+            ],
+          visa: Increase::CardDisputeSubmitUserSubmissionParams::Visa::OrHash,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::CardDispute)
+      end
+      def submit_user_submission(
+        # The identifier of the Card Dispute to submit a user submission for.
+        card_dispute_id,
+        # The network of the Card Dispute. Details specific to the network are required
+        # under the sub-object with the same identifier as the network.
+        network:,
+        # The adjusted monetary amount of the part of the transaction that is being
+        # disputed. This is optional and will default to the most recent amount provided.
+        # If provided, the amount must be less than or equal to the amount of the
+        # transaction.
+        amount: nil,
+        # The files to be attached to the user submission.
+        attachment_files: nil,
+        # The Visa-specific parameters for the dispute. Required if and only if `network`
+        # is `visa`.
+        visa: nil,
+        request_options: {}
+      )
+      end
+
+      # Withdraw a Card Dispute
+      sig do
+        params(
+          card_dispute_id: String,
+          request_options: Increase::RequestOptions::OrHash
+        ).returns(Increase::CardDispute)
+      end
+      def withdraw(
+        # The identifier of the Card Dispute to withdraw.
+        card_dispute_id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Increase::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/increase/resources/simulations/card_disputes.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class Simulations
+      class CardDisputes
+        # After a [Card Dispute](#card-disputes) is created in production, the dispute
+        # will initially be in a `pending_user_submission_reviewing` state. Since no
+        # review or further action happens in sandbox, this endpoint simulates moving a
+        # Card Dispute through its various states.
+        sig do
+          params(
+            card_dispute_id: String,
+            network:
+              Increase::Simulations::CardDisputeActionParams::Network::OrSymbol,
+            visa: Increase::Simulations::CardDisputeActionParams::Visa::OrHash,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::CardDispute)
+        end
+        def action(
+          # The dispute you would like to action.
+          card_dispute_id,
+          # The network of the Card Dispute. Details specific to the network are required
+          # under the sub-object with the same identifier as the network.
+          network:,
+          # The Visa-specific parameters for the taking action on the dispute. Required if
+          # and only if `network` is `visa`.
+          visa: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Increase::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/increase/resources/simulations.rbi

@@ -32,6 +32,9 @@ module Increase
       sig { returns(Increase::Resources::Simulations::CardRefunds) }
       attr_reader :card_refunds
 
+      sig { returns(Increase::Resources::Simulations::CardDisputes) }
+      attr_reader :card_disputes
+
       sig { returns(Increase::Resources::Simulations::PhysicalCards) }
       attr_reader :physical_cards
 

data/sig/increase/client.rbs

@@ -27,6 +27,8 @@ module Increase
 
     attr_reader card_purchase_supplements: Increase::Resources::CardPurchaseSupplements
 
+    attr_reader card_disputes: Increase::Resources::CardDisputes
+
     attr_reader physical_cards: Increase::Resources::PhysicalCards
 
     attr_reader digital_card_profiles: Increase::Resources::DigitalCardProfiles