Class: Increase::Resources::CardDisputes

Inherits:
Object
  • Object
show all
Defined in:
lib/increase/resources/card_disputes.rb

Instance Method Summary collapse

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:



158
159
160
 
# File 'lib/increase/resources/card_disputes.rb', line 158

def initialize(client:)
  @client = client
end

Instance Method Details

#create(disputed_transaction_id:, network:, amount: nil, attachment_files: nil, explanation: nil, visa: nil, request_options: {}) ⇒ Increase::Models::CardDispute

Some parameter documentations has been truncated, see Models::CardDisputeCreateParams for more details.

Create a Card Dispute

Parameters:

Returns:

See Also:



30
31
32
33
34
35
36
37
38
39
 
# File 'lib/increase/resources/card_disputes.rb', line 30

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

#list(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {}) ⇒ Increase::Internal::Page<Increase::Models::CardDispute>

Some parameter documentations has been truncated, see Models::CardDisputeListParams for more details.

List Card Disputes

Parameters:

Returns:

See Also:



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/increase/resources/card_disputes.rb', line 83

def list(params = {})
  parsed, options = Increase::CardDisputeListParams.dump_request(params)
  query = Increase::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "card_disputes",
    query: query,
    page: Increase::Internal::Page,
    model: Increase::CardDispute,
    options: options
  )
end

#retrieve(card_dispute_id, request_options: {}) ⇒ Increase::Models::CardDispute

Retrieve a Card Dispute

Parameters:

  • card_dispute_id (String) —

    The identifier of the Card Dispute.

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

Returns:

See Also:



52
53
54
55
56
57
58
59
 
# File 'lib/increase/resources/card_disputes.rb', line 52

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

#submit_user_submission(card_dispute_id, network:, amount: nil, attachment_files: nil, explanation: nil, visa: nil, request_options: {}) ⇒ Increase::Models::CardDispute

Some parameter documentations has been truncated, see Models::CardDisputeSubmitUserSubmissionParams for more details.

Submit a User Submission for a Card Dispute

Parameters:

Returns:

See Also:



120
121
122
123
124
125
126
127
128
129
 
# File 'lib/increase/resources/card_disputes.rb', line 120

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(card_dispute_id, explanation: nil, request_options: {}) ⇒ Increase::Models::CardDispute

Withdraw a Card Dispute

Parameters:

  • card_dispute_id (String) —

    The identifier of the Card Dispute to withdraw.

  • explanation (String) —

    The explanation for withdrawing the Card Dispute.

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

Returns:

See Also:



144
145
146
147
148
149
150
151
152
153
 
# File 'lib/increase/resources/card_disputes.rb', line 144

def withdraw(card_dispute_id, params = {})
  parsed, options = Increase::CardDisputeWithdrawParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["card_disputes/%1$s/withdraw", card_dispute_id],
    body: parsed,
    model: Increase::CardDispute,
    options: options
  )
end