Class: Increase::Resources::Simulations::CardDisputes

Inherits:

Object

• Object
• Increase::Resources::Simulations::CardDisputes

Defined in:

lib/increase/resources/simulations/card_disputes.rb

Instance Method Summary

• #action(card_dispute_id, status: , explanation: nil, request_options: {}) ⇒ Increase::Models::CardDispute

  After a [Card Dispute](#card-disputes) is created in production, the dispute will be reviewed.

• #initialize(client:) ⇒ CardDisputes constructor private

  A new instance of CardDisputes.

Constructor Details

#initialize(client:) ⇒ CardDisputes

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of CardDisputes.

Parameters:

• client (Increase::Client)

# File 'lib/increase/resources/simulations/card_disputes.rb', line 39

def initialize(client:)
  @client = client
end

Instance Method Details

#action(card_dispute_id, status: , explanation: nil, request_options: {}) ⇒ Increase::Models::CardDispute

After a [Card Dispute](#card-disputes) is created in production, the dispute will be reviewed. Since no review happens in sandbox, this endpoint simulates moving a Card Dispute into a rejected or accepted state. A Card Dispute can only be actioned one time and must have a status of ‘pending_reviewing`.

Parameters:

• card_dispute_id (String) —

  The dispute you would like to action.

• status (Symbol, Increase::Models::Simulations::CardDisputeActionParams::Status) —

  The status to move the dispute to.

• explanation (String) —

  Why the dispute was rejected. Not required for accepting disputes.

• request_options (Increase::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Increase::Models::CardDispute)

See Also:

• Models::Simulations::CardDisputeActionParams

# File 'lib/increase/resources/simulations/card_disputes.rb', line 25

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