increase 1.98.0 → 1.99.0

data/lib/increase/models/card_dispute_withdraw_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::CardDisputes#withdraw
+    class CardDisputeWithdrawParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

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

@@ -0,0 +1,214 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    module Simulations
+      # @see Increase::Resources::Simulations::CardDisputes#action
+      class CardDisputeActionParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        # @!attribute network
+        #   The network of the Card Dispute. Details specific to the network are required
+        #   under the sub-object with the same identifier as the network.
+        #
+        #   @return [Symbol, Increase::Models::Simulations::CardDisputeActionParams::Network]
+        required :network, enum: -> { Increase::Simulations::CardDisputeActionParams::Network }
+
+        # @!attribute visa
+        #   The Visa-specific parameters for the taking action on the dispute. Required if
+        #   and only if `network` is `visa`.
+        #
+        #   @return [Increase::Models::Simulations::CardDisputeActionParams::Visa, nil]
+        optional :visa, -> { Increase::Simulations::CardDisputeActionParams::Visa }
+
+        # @!method initialize(network:, visa: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::Simulations::CardDisputeActionParams} for more details.
+        #
+        #   @param network [Symbol, Increase::Models::Simulations::CardDisputeActionParams::Network] The network of the Card Dispute. Details specific to the network are required un
+        #
+        #   @param visa [Increase::Models::Simulations::CardDisputeActionParams::Visa] The Visa-specific parameters for the taking action on the dispute. Required if a
+        #
+        #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+        # 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
+
+          # Visa
+          VISA = :visa
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        class Visa < Increase::Internal::Type::BaseModel
+          # @!attribute action
+          #   The action to take. Details specific to the action are required under the
+          #   sub-object with the same identifier as the action.
+          #
+          #   @return [Symbol, Increase::Models::Simulations::CardDisputeActionParams::Visa::Action]
+          required :action, enum: -> { Increase::Simulations::CardDisputeActionParams::Visa::Action }
+
+          # @!attribute accept_chargeback
+          #   The parameters for accepting the chargeback. Required if and only if `action` is
+          #   `accept_chargeback`.
+          #
+          #   @return [Object, nil]
+          optional :accept_chargeback, Increase::Internal::Type::Unknown
+
+          # @!attribute accept_user_submission
+          #   The parameters for accepting the user submission. Required if and only if
+          #   `action` is `accept_user_submission`.
+          #
+          #   @return [Object, nil]
+          optional :accept_user_submission, Increase::Internal::Type::Unknown
+
+          # @!attribute decline_user_prearbitration
+          #   The parameters for declining the prearbitration. Required if and only if
+          #   `action` is `decline_user_prearbitration`.
+          #
+          #   @return [Object, nil]
+          optional :decline_user_prearbitration, Increase::Internal::Type::Unknown
+
+          # @!attribute receive_merchant_prearbitration
+          #   The parameters for receiving the prearbitration. Required if and only if
+          #   `action` is `receive_merchant_prearbitration`.
+          #
+          #   @return [Object, nil]
+          optional :receive_merchant_prearbitration, Increase::Internal::Type::Unknown
+
+          # @!attribute represent
+          #   The parameters for re-presenting the dispute. Required if and only if `action`
+          #   is `represent`.
+          #
+          #   @return [Object, nil]
+          optional :represent, Increase::Internal::Type::Unknown
+
+          # @!attribute request_further_information
+          #   The parameters for requesting further information from the user. Required if and
+          #   only if `action` is `request_further_information`.
+          #
+          #   @return [Increase::Models::Simulations::CardDisputeActionParams::Visa::RequestFurtherInformation, nil]
+          optional :request_further_information,
+                   -> { Increase::Simulations::CardDisputeActionParams::Visa::RequestFurtherInformation }
+
+          # @!attribute time_out_chargeback
+          #   The parameters for timing out the chargeback. Required if and only if `action`
+          #   is `time_out_chargeback`.
+          #
+          #   @return [Object, nil]
+          optional :time_out_chargeback, Increase::Internal::Type::Unknown
+
+          # @!attribute time_out_merchant_prearbitration
+          #   The parameters for timing out the merchant prearbitration. Required if and only
+          #   if `action` is `time_out_merchant_prearbitration`.
+          #
+          #   @return [Object, nil]
+          optional :time_out_merchant_prearbitration, Increase::Internal::Type::Unknown
+
+          # @!attribute time_out_representment
+          #   The parameters for timing out the re-presentment. Required if and only if
+          #   `action` is `time_out_representment`.
+          #
+          #   @return [Object, nil]
+          optional :time_out_representment, Increase::Internal::Type::Unknown
+
+          # @!attribute time_out_user_prearbitration
+          #   The parameters for timing out the user prearbitration. Required if and only if
+          #   `action` is `time_out_user_prearbitration`.
+          #
+          #   @return [Object, nil]
+          optional :time_out_user_prearbitration, Increase::Internal::Type::Unknown
+
+          # @!method initialize(action:, accept_chargeback: nil, accept_user_submission: nil, decline_user_prearbitration: nil, receive_merchant_prearbitration: nil, represent: nil, request_further_information: nil, time_out_chargeback: nil, time_out_merchant_prearbitration: nil, time_out_representment: nil, time_out_user_prearbitration: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Increase::Models::Simulations::CardDisputeActionParams::Visa} for more details.
+          #
+          #   The Visa-specific parameters for the taking action on the dispute. Required if
+          #   and only if `network` is `visa`.
+          #
+          #   @param action [Symbol, Increase::Models::Simulations::CardDisputeActionParams::Visa::Action] The action to take. Details specific to the action are required under the sub-ob
+          #
+          #   @param accept_chargeback [Object] The parameters for accepting the chargeback. Required if and only if `action` is
+          #
+          #   @param accept_user_submission [Object] The parameters for accepting the user submission. Required if and only if `actio
+          #
+          #   @param decline_user_prearbitration [Object] The parameters for declining the prearbitration. Required if and only if `action
+          #
+          #   @param receive_merchant_prearbitration [Object] The parameters for receiving the prearbitration. Required if and only if `action
+          #
+          #   @param represent [Object] The parameters for re-presenting the dispute. Required if and only if `action` i
+          #
+          #   @param request_further_information [Increase::Models::Simulations::CardDisputeActionParams::Visa::RequestFurtherInformation] The parameters for requesting further information from the user. Required if and
+          #
+          #   @param time_out_chargeback [Object] The parameters for timing out the chargeback. Required if and only if `action` i
+          #
+          #   @param time_out_merchant_prearbitration [Object] The parameters for timing out the merchant prearbitration. Required if and only
+          #
+          #   @param time_out_representment [Object] The parameters for timing out the re-presentment. Required if and only if `actio
+          #
+          #   @param time_out_user_prearbitration [Object] The parameters for timing out the user prearbitration. Required if and only if `
+
+          # The action to take. Details specific to the action are required under the
+          # sub-object with the same identifier as the action.
+          #
+          # @see Increase::Models::Simulations::CardDisputeActionParams::Visa#action
+          module Action
+            extend Increase::Internal::Type::Enum
+
+            # Simulate the merchant accepting the chargeback. This will move the dispute to a `won` state.
+            ACCEPT_CHARGEBACK = :accept_chargeback
+
+            # Accept the user's submission and transmit it to the network. This will move the dispute to a `pending_response` state.
+            ACCEPT_USER_SUBMISSION = :accept_user_submission
+
+            # Simulate the merchant declining the user's pre-arbitration. This will move the dispute to a `lost` state.
+            DECLINE_USER_PREARBITRATION = :decline_user_prearbitration
+
+            # Simulate the merchant issuing pre-arbitration. This will move the dispute to a `user_submission_required` state.
+            RECEIVE_MERCHANT_PREARBITRATION = :receive_merchant_prearbitration
+
+            # Simulate the merchant re-presenting the dispute. This will move the dispute to a `user_submission_required` state.
+            REPRESENT = :represent
+
+            # Simulate further information being requested from the user. This will move the dispute to a `user_submission_required` state.
+            REQUEST_FURTHER_INFORMATION = :request_further_information
+
+            # Simulate the merchant timing out responding to the chargeback. This will move the dispute to a `won` state.
+            TIME_OUT_CHARGEBACK = :time_out_chargeback
+
+            # Simulate the user timing out responding to a merchant pre-arbitration. This will move the dispute to a `lost` state.
+            TIME_OUT_MERCHANT_PREARBITRATION = :time_out_merchant_prearbitration
+
+            # Simulate the user timing out responding to a merchant re-presentment. This will move the dispute to a `lost` state.
+            TIME_OUT_REPRESENTMENT = :time_out_representment
+
+            # Simulate the merchant timing out responding to a user pre-arbitration. This will move the dispute to a `win` state.
+            TIME_OUT_USER_PREARBITRATION = :time_out_user_prearbitration
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see Increase::Models::Simulations::CardDisputeActionParams::Visa#request_further_information
+          class RequestFurtherInformation < Increase::Internal::Type::BaseModel
+            # @!attribute reason
+            #   The reason for requesting further information from the user.
+            #
+            #   @return [String]
+            required :reason, String
+
+            # @!method initialize(reason:)
+            #   The parameters for requesting further information from the user. Required if and
+            #   only if `action` is `request_further_information`.
+            #
+            #   @param reason [String] The reason for requesting further information from the user.
+          end
+        end
+      end
+    end
+  end
+end

data/lib/increase/models.rb

@@ -139,6 +139,18 @@ 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/lib/increase/resources/card_disputes.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class CardDisputes
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::CardDisputeCreateParams} for more details.
+      #
+      # Create a Card Dispute
+      #
+      # @overload create(disputed_transaction_id:, network:, amount: nil, attachment_files: nil, visa: nil, request_options: {})
+      #
+      # @param disputed_transaction_id [String] The Transaction you wish to dispute. This Transaction must have a `source_type`
+      #
+      # @param network [Symbol, Increase::Models::CardDisputeCreateParams::Network] The network of the disputed transaction. Details specific to the network are req
+      #
+      # @param amount [Integer] The monetary amount of the part of the transaction that is being disputed. This
+      #
+      # @param attachment_files [Array<Increase::Models::CardDisputeCreateParams::AttachmentFile>] The files to be attached to the initial dispute submission.
+      #
+      # @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]
+      #
+      # @return [Increase::Models::CardDispute]
+      #
+      # @see Increase::Models::CardDisputeCreateParams
+      def create(params)
+        parsed, options = Increase::CardDisputeCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "card_disputes",
+          body: parsed,
+          model: Increase::CardDispute,
+          options: options
+        )
+      end
+
+      # Retrieve a Card Dispute
+      #
+      # @overload retrieve(card_dispute_id, request_options: {})
+      #
+      # @param card_dispute_id [String] The identifier of the Card Dispute.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::CardDispute]
+      #
+      # @see Increase::Models::CardDisputeRetrieveParams
+      def retrieve(card_dispute_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["card_disputes/%1$s", card_dispute_id],
+          model: Increase::CardDispute,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::CardDisputeListParams} for more details.
+      #
+      # List Card Disputes
+      #
+      # @overload list(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
+      #
+      # @param created_at [Increase::Models::CardDisputeListParams::CreatedAt]
+      #
+      # @param cursor [String] Return the page of entries after this one.
+      #
+      # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
+      #
+      # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #
+      # @param status [Increase::Models::CardDisputeListParams::Status]
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Internal::Page<Increase::Models::CardDispute>]
+      #
+      # @see Increase::Models::CardDisputeListParams
+      def list(params = {})
+        parsed, options = Increase::CardDisputeListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "card_disputes",
+          query: parsed,
+          page: Increase::Internal::Page,
+          model: Increase::CardDispute,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::CardDisputeSubmitUserSubmissionParams} for more details.
+      #
+      # 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: {})
+      #
+      # @param card_dispute_id [String] The identifier of the Card Dispute to submit a user submission for.
+      #
+      # @param network [Symbol, Increase::Models::CardDisputeSubmitUserSubmissionParams::Network] The network of the Card Dispute. Details specific to the network are required un
+      #
+      # @param amount [Integer] The adjusted monetary amount of the part of the transaction that is being disput
+      #
+      # @param attachment_files [Array<Increase::Models::CardDisputeSubmitUserSubmissionParams::AttachmentFile>] The files to be attached to the user submission.
+      #
+      # @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]
+      #
+      # @return [Increase::Models::CardDispute]
+      #
+      # @see Increase::Models::CardDisputeSubmitUserSubmissionParams
+      def submit_user_submission(card_dispute_id, params)
+        parsed, options = Increase::CardDisputeSubmitUserSubmissionParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["card_disputes/%1$s/submit_user_submission", card_dispute_id],
+          body: parsed,
+          model: Increase::CardDispute,
+          options: options
+        )
+      end
+
+      # Withdraw a Card Dispute
+      #
+      # @overload withdraw(card_dispute_id, request_options: {})
+      #
+      # @param card_dispute_id [String] The identifier of the Card Dispute to withdraw.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::CardDispute]
+      #
+      # @see Increase::Models::CardDisputeWithdrawParams
+      def withdraw(card_dispute_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["card_disputes/%1$s/withdraw", card_dispute_id],
+          model: Increase::CardDispute,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Increase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class Simulations
+      class CardDisputes
+        # Some parameter documentations has been truncated, see
+        # {Increase::Models::Simulations::CardDisputeActionParams} for more details.
+        #
+        # 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.
+        #
+        # @overload action(card_dispute_id, network:, visa: nil, request_options: {})
+        #
+        # @param card_dispute_id [String] The dispute you would like to action.
+        #
+        # @param network [Symbol, Increase::Models::Simulations::CardDisputeActionParams::Network] The network of the Card Dispute. Details specific to the network are required un
+        #
+        # @param visa [Increase::Models::Simulations::CardDisputeActionParams::Visa] The Visa-specific parameters for the taking action on the dispute. Required if a
+        #
+        # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Increase::Models::CardDispute]
+        #
+        # @see Increase::Models::Simulations::CardDisputeActionParams
+        def action(card_dispute_id, params)
+          parsed, options = Increase::Simulations::CardDisputeActionParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: ["simulations/card_disputes/%1$s/action", card_dispute_id],
+            body: parsed,
+            model: Increase::CardDispute,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Increase::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/increase/resources/simulations.rb

@@ -30,6 +30,9 @@ module Increase
       # @return [Increase::Resources::Simulations::CardRefunds]
       attr_reader :card_refunds
 
+      # @return [Increase::Resources::Simulations::CardDisputes]
+      attr_reader :card_disputes
+
       # @return [Increase::Resources::Simulations::PhysicalCards]
       attr_reader :physical_cards
 
@@ -102,6 +105,7 @@ module Increase
         @card_increments = Increase::Resources::Simulations::CardIncrements.new(client: client)
         @card_fuel_confirmations = Increase::Resources::Simulations::CardFuelConfirmations.new(client: client)
         @card_refunds = Increase::Resources::Simulations::CardRefunds.new(client: client)
+        @card_disputes = Increase::Resources::Simulations::CardDisputes.new(client: client)
         @physical_cards = Increase::Resources::Simulations::PhysicalCards.new(client: client)
         @digital_wallet_token_requests =
           Increase::Resources::Simulations::DigitalWalletTokenRequests.new(client: client)

data/lib/increase/version.rb

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

data/lib/increase.rb

@@ -101,6 +101,12 @@ require_relative "increase/models/card_create_details_iframe_params"
 require_relative "increase/models/card_create_params"
 require_relative "increase/models/card_details"
 require_relative "increase/models/card_details_params"
+require_relative "increase/models/card_dispute"
+require_relative "increase/models/card_dispute_create_params"
+require_relative "increase/models/card_dispute_list_params"
+require_relative "increase/models/card_dispute_retrieve_params"
+require_relative "increase/models/card_dispute_submit_user_submission_params"
+require_relative "increase/models/card_dispute_withdraw_params"
 require_relative "increase/models/card_iframe_url"
 require_relative "increase/models/card_list_params"
 require_relative "increase/models/card_payment"
@@ -281,6 +287,7 @@ require_relative "increase/models/simulations/ach_transfer_submit_params"
 require_relative "increase/models/simulations/card_authorization_create_params"
 require_relative "increase/models/simulations/card_authorization_create_response"
 require_relative "increase/models/simulations/card_authorization_expiration_create_params"
+require_relative "increase/models/simulations/card_dispute_action_params"
 require_relative "increase/models/simulations/card_fuel_confirmation_create_params"
 require_relative "increase/models/simulations/card_increment_create_params"
 require_relative "increase/models/simulations/card_refund_create_params"
@@ -335,6 +342,7 @@ require_relative "increase/resources/ach_transfers"
 require_relative "increase/resources/bookkeeping_accounts"
 require_relative "increase/resources/bookkeeping_entries"
 require_relative "increase/resources/bookkeeping_entry_sets"
+require_relative "increase/resources/card_disputes"
 require_relative "increase/resources/card_payments"
 require_relative "increase/resources/card_purchase_supplements"
 require_relative "increase/resources/card_push_transfers"
@@ -381,6 +389,7 @@ require_relative "increase/resources/simulations/account_transfers"
 require_relative "increase/resources/simulations/ach_transfers"
 require_relative "increase/resources/simulations/card_authorization_expirations"
 require_relative "increase/resources/simulations/card_authorizations"
+require_relative "increase/resources/simulations/card_disputes"
 require_relative "increase/resources/simulations/card_fuel_confirmations"
 require_relative "increase/resources/simulations/card_increments"
 require_relative "increase/resources/simulations/card_refunds"

data/rbi/increase/client.rbi

@@ -40,6 +40,9 @@ module Increase
     sig { returns(Increase::Resources::CardPurchaseSupplements) }
     attr_reader :card_purchase_supplements
 
+    sig { returns(Increase::Resources::CardDisputes) }
+    attr_reader :card_disputes
+
     sig { returns(Increase::Resources::PhysicalCards) }
     attr_reader :physical_cards