Class: Lithic::Resources::Disputes

Inherits:
Object
  • Object
show all
Defined in:
lib/lithic/resources/disputes.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Disputes

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 Disputes.

Parameters:



262
263
264
 
# File 'lib/lithic/resources/disputes.rb', line 262

def initialize(client:)
  @client = client
end

Instance Method Details

#create(amount:, reason:, transaction_token:, customer_filed_date: nil, customer_note: nil, request_options: {}) ⇒ Lithic::Models::Dispute

Request a chargeback.

Parameters:

  • amount (Integer) —

    Amount for chargeback

  • reason (Symbol, Lithic::Models::DisputeCreateParams::Reason) —

    Reason for chargeback

  • transaction_token (String) —

    Transaction for chargeback

  • customer_filed_date (Time) —

    Date the customer filed the chargeback request

  • customer_note (String) —

    Customer description

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

Returns:

See Also:



25
26
27
28
29
30
31
32
33
34
 
# File 'lib/lithic/resources/disputes.rb', line 25

def create(params)
  parsed, options = Lithic::DisputeCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "v1/disputes",
    body: parsed,
    model: Lithic::Dispute,
    options: options
  )
end

#delete(dispute_token, request_options: {}) ⇒ Lithic::Models::Dispute

Withdraw chargeback request.

Parameters:

Returns:

See Also:



134
135
136
137
138
139
140
141
 
# File 'lib/lithic/resources/disputes.rb', line 134

def delete(dispute_token, params = {})
  @client.request(
    method: :delete,
    path: ["v1/disputes/%1$s", dispute_token],
    model: Lithic::Dispute,
    options: params[:request_options]
  )
end

#delete_evidence(evidence_token, dispute_token:, request_options: {}) ⇒ Lithic::Models::DisputeEvidence

Soft delete evidence for a chargeback request. Evidence will not be reviewed or submitted by Lithic after it is withdrawn.

Parameters:

  • evidence_token (String)
  • dispute_token (String)
  • request_options (Lithic::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/lithic/resources/disputes.rb', line 155

def delete_evidence(evidence_token, params)
  parsed, options = Lithic::DisputeDeleteEvidenceParams.dump_request(params)
  dispute_token =
    parsed.delete(:dispute_token) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: ["v1/disputes/%1$s/evidences/%2$s", dispute_token, evidence_token],
    model: Lithic::DisputeEvidence,
    options: options
  )
end

#initiate_evidence_upload(dispute_token, filename: nil, request_options: {}) ⇒ Lithic::Models::DisputeEvidence

Use this endpoint to upload evidence for a chargeback request. It will return a URL to upload your documents to. The URL will expire in 30 minutes.

Uploaded documents must either be a ‘jpg`, `png` or `pdf` file, and each must be less than 5 GiB.

Parameters:

  • dispute_token (String)
  • filename (String) —

    Filename of the evidence.

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

Returns:

See Also:



186
187
188
189
190
191
192
193
194
195
 
# File 'lib/lithic/resources/disputes.rb', line 186

def initiate_evidence_upload(dispute_token, params = {})
  parsed, options = Lithic::DisputeInitiateEvidenceUploadParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["v1/disputes/%1$s/evidences", dispute_token],
    body: parsed,
    model: Lithic::DisputeEvidence,
    options: options
  )
end

#list(begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, status: nil, transaction_tokens: nil, request_options: {}) ⇒ Lithic::Internal::CursorPage<Lithic::Models::Dispute>

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

List chargeback requests.

Parameters:

  • begin_ (Time) —

    Date string in RFC 3339 format. Only entries created after the specified time wi

  • end_ (Time) —

    Date string in RFC 3339 format. Only entries created before the specified time w

  • ending_before (String) —

    A cursor representing an item’s token before which a page of results should end.

  • page_size (Integer) —

    Page size (for pagination).

  • starting_after (String) —

    A cursor representing an item’s token after which a page of results should begin

  • status (Symbol, Lithic::Models::DisputeListParams::Status) —

    Filter by status.

  • transaction_tokens (Array<String>) —

    Transaction tokens to filter by.

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

Returns:

See Also:



111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/lithic/resources/disputes.rb', line 111

def list(params = {})
  parsed, options = Lithic::DisputeListParams.dump_request(params)
  query = Lithic::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "v1/disputes",
    query: query.transform_keys(begin_: "begin", end_: "end"),
    page: Lithic::Internal::CursorPage,
    model: Lithic::Dispute,
    options: options
  )
end

#list_evidences(dispute_token, begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, request_options: {}) ⇒ Lithic::Internal::CursorPage<Lithic::Models::DisputeEvidence>

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

List evidence for a chargeback request.

Parameters:

  • dispute_token (String)
  • begin_ (Time) —

    Date string in RFC 3339 format. Only entries created after the specified time wi

  • end_ (Time) —

    Date string in RFC 3339 format. Only entries created before the specified time w

  • ending_before (String) —

    A cursor representing an item’s token before which a page of results should end.

  • page_size (Integer) —

    Page size (for pagination).

  • starting_after (String) —

    A cursor representing an item’s token after which a page of results should begin

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

Returns:

See Also:



221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/lithic/resources/disputes.rb', line 221

def list_evidences(dispute_token, params = {})
  parsed, options = Lithic::DisputeListEvidencesParams.dump_request(params)
  query = Lithic::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["v1/disputes/%1$s/evidences", dispute_token],
    query: query.transform_keys(begin_: "begin", end_: "end"),
    page: Lithic::Internal::CursorPage,
    model: Lithic::DisputeEvidence,
    options: options
  )
end

#retrieve(dispute_token, request_options: {}) ⇒ Lithic::Models::Dispute

Get chargeback request.

Parameters:

Returns:

See Also:



46
47
48
49
50
51
52
53
 
# File 'lib/lithic/resources/disputes.rb', line 46

def retrieve(dispute_token, params = {})
  @client.request(
    method: :get,
    path: ["v1/disputes/%1$s", dispute_token],
    model: Lithic::Dispute,
    options: params[:request_options]
  )
end

#retrieve_evidence(evidence_token, dispute_token:, request_options: {}) ⇒ Lithic::Models::DisputeEvidence

Get evidence for a chargeback request.

Parameters:

  • evidence_token (String)
  • dispute_token (String)
  • request_options (Lithic::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/lithic/resources/disputes.rb', line 245

def retrieve_evidence(evidence_token, params)
  parsed, options = Lithic::DisputeRetrieveEvidenceParams.dump_request(params)
  dispute_token =
    parsed.delete(:dispute_token) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["v1/disputes/%1$s/evidences/%2$s", dispute_token, evidence_token],
    model: Lithic::DisputeEvidence,
    options: options
  )
end

#update(dispute_token, amount: nil, customer_filed_date: nil, customer_note: nil, reason: nil, request_options: {}) ⇒ Lithic::Models::Dispute

Update chargeback request. Can only be modified if status is ‘NEW`.

Parameters:

  • dispute_token (String)
  • amount (Integer) —

    Amount for chargeback

  • customer_filed_date (Time) —

    Date the customer filed the chargeback request

  • customer_note (String) —

    Customer description

  • reason (Symbol, Lithic::Models::DisputeUpdateParams::Reason) —

    Reason for chargeback

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

Returns:

See Also:



74
75
76
77
78
79
80
81
82
83
 
# File 'lib/lithic/resources/disputes.rb', line 74

def update(dispute_token, params = {})
  parsed, options = Lithic::DisputeUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["v1/disputes/%1$s", dispute_token],
    body: parsed,
    model: Lithic::Dispute,
    options: options
  )
end