Class: Square::DisputesApi

Inherits:
BaseApi
  • Object
show all
Defined in:
lib/square/api/disputes_api.rb

Overview

DisputesApi

Instance Attribute Summary

Attributes inherited from BaseApi

#config, #http_call_back

Instance Method Summary collapse

Methods inherited from BaseApi

#execute_request, #get_user_agent, #validate_parameters

Constructor Details

#initialize(config, http_call_back: nil) ⇒ DisputesApi

Returns a new instance of DisputesApi.



4
5
6
 
# File 'lib/square/api/disputes_api.rb', line 4

def initialize(config, http_call_back: nil)
  super(config, http_call_back: http_call_back)
end

Instance Method Details

#accept_dispute(dispute_id:) ⇒ AcceptDisputeResponse Hash

Accepts the loss on a dispute. Square returns the disputed amount to the cardholder and updates the dispute state to ACCEPTED. Square debits the disputed amount from the seller’s Square account. If the Square account does not have sufficient funds, Square debits the associated bank account. want to accept.

Parameters:

  • dispute_id (String) —

    Required parameter: The ID of the dispute you

Returns:

  • (AcceptDisputeResponse Hash) —

    response from the API call



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/square/api/disputes_api.rb', line 101

def accept_dispute(dispute_id:)
  # Prepare query url.
  _query_builder = config.get_base_uri
  _query_builder << '/v2/disputes/{dispute_id}/accept'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'dispute_id' => { 'value' => dispute_id, 'encode' => true }
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json'
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.post(
    _query_url,
    headers: _headers
  )
  OAuth2.apply(config, _request)
  _response = execute_request(_request)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_response.raw_body)
  _errors = APIHelper.map_response(decoded, ['errors'])
  ApiResponse.new(
    _response, data: decoded, errors: _errors
  )
end

#create_dispute_evidence_file(dispute_id:, request: nil, image_file: nil) ⇒ CreateDisputeEvidenceFileResponse Hash

Uploads a file to use as evidence in a dispute challenge. The endpoint accepts HTTP multipart/form-data file uploads in HEIC, HEIF, JPEG, PDF, PNG, and TIFF formats. want to upload evidence for. Defines the parameters for a ‘CreateDisputeEvidenceFile` request.

Parameters:

  • dispute_id (String) —

    Required parameter: The ID of the dispute you

  • request (CreateDisputeEvidenceFileRequest) (defaults to: nil) —

    Optional parameter:

  • image_file (File | UploadIO) (defaults to: nil) —

    Optional parameter: Example:

Returns:

  • (CreateDisputeEvidenceFileResponse Hash) —

    response from the API call



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/square/api/disputes_api.rb', line 186

def create_dispute_evidence_file(dispute_id:,
                                 request: nil,
                                 image_file: nil)
  # Prepare query url.
  _query_builder = config.get_base_uri
  _query_builder << '/v2/disputes/{dispute_id}/evidence-files'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'dispute_id' => { 'value' => dispute_id, 'encode' => true }
  )
  _query_url = APIHelper.clean_url _query_builder

  if image_file.is_a? FileWrapper
    image_file_wrapper = image_file.file
    image_file_content_type = image_file.content_type
  else
    image_file_wrapper = image_file
    image_file_content_type = 'image/jpeg'
  end

  # Prepare headers.
  _headers = {
    'accept' => 'application/json'
  }

  # Prepare form parameters.
  _parameters = {
    'request' => Faraday::UploadIO.new(
      StringIO.new(request.to_json),
      'application/json'
    ),
    'image_file' => Faraday::UploadIO.new(
      image_file_wrapper,
      image_file_content_type
    )
  }
  _parameters = APIHelper.form_encode_parameters(_parameters)

  # Prepare and execute HttpRequest.
  _request = config.http_client.post(
    _query_url,
    headers: _headers,
    parameters: _parameters
  )
  OAuth2.apply(config, _request)
  _response = execute_request(_request)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_response.raw_body)
  _errors = APIHelper.map_response(decoded, ['errors'])
  ApiResponse.new(
    _response, data: decoded, errors: _errors
  )
end

#create_dispute_evidence_text(dispute_id:, body:) ⇒ CreateDisputeEvidenceTextResponse Hash

Uploads text to use as evidence for a dispute challenge. want to upload evidence for. object containing the fields to POST for the request. See the corresponding object definition for field details.

Parameters:

  • dispute_id (String) —

    Required parameter: The ID of the dispute you

  • body (CreateDisputeEvidenceTextRequest) —

    Required parameter: An

Returns:

  • (CreateDisputeEvidenceTextResponse Hash) —

    response from the API call



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/square/api/disputes_api.rb', line 248

def create_dispute_evidence_text(dispute_id:,
                                 body:)
  # Prepare query url.
  _query_builder = config.get_base_uri
  _query_builder << '/v2/disputes/{dispute_id}/evidence-text'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'dispute_id' => { 'value' => dispute_id, 'encode' => true }
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json',
    'Content-Type' => 'application/json'
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.post(
    _query_url,
    headers: _headers,
    parameters: body.to_json
  )
  OAuth2.apply(config, _request)
  _response = execute_request(_request)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_response.raw_body)
  _errors = APIHelper.map_response(decoded, ['errors'])
  ApiResponse.new(
    _response, data: decoded, errors: _errors
  )
end

#delete_dispute_evidence(dispute_id:, evidence_id:) ⇒ DeleteDisputeEvidenceResponse Hash

Removes specified evidence from a dispute. Square does not send the bank any evidence that is removed. Also, you cannot remove evidence after submitting it to the bank using [SubmitEvidence]($e/Disputes/SubmitEvidence). want to remove evidence from. want to remove.

Parameters:

  • dispute_id (String) —

    Required parameter: The ID of the dispute you

  • evidence_id (String) —

    Required parameter: The ID of the evidence you

Returns:

  • (DeleteDisputeEvidenceResponse Hash) —

    response from the API call



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/square/api/disputes_api.rb', line 292

def delete_dispute_evidence(dispute_id:,
                            evidence_id:)
  # Prepare query url.
  _query_builder = config.get_base_uri
  _query_builder << '/v2/disputes/{dispute_id}/evidence/{evidence_id}'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'dispute_id' => { 'value' => dispute_id, 'encode' => true },
    'evidence_id' => { 'value' => evidence_id, 'encode' => true }
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json'
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.delete(
    _query_url,
    headers: _headers
  )
  OAuth2.apply(config, _request)
  _response = execute_request(_request)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_response.raw_body)
  _errors = APIHelper.map_response(decoded, ['errors'])
  ApiResponse.new(
    _response, data: decoded, errors: _errors
  )
end

#list_dispute_evidence(dispute_id:, cursor: nil) ⇒ ListDisputeEvidenceResponse Hash

Returns a list of evidence associated with a dispute. a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. For more information, see [Pagination](developer.squareup.com/docs/basics/api101/pagination) .

Parameters:

  • dispute_id (String) —

    Required parameter: The ID of the dispute.

  • cursor (String) (defaults to: nil) —

    Optional parameter: A pagination cursor returned by

Returns:

  • (ListDisputeEvidenceResponse Hash) —

    response from the API call



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/square/api/disputes_api.rb', line 140

def list_dispute_evidence(dispute_id:,
                          cursor: nil)
  # Prepare query url.
  _query_builder = config.get_base_uri
  _query_builder << '/v2/disputes/{dispute_id}/evidence'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'dispute_id' => { 'value' => dispute_id, 'encode' => true }
  )
  _query_builder = APIHelper.append_url_with_query_parameters(
    _query_builder,
    'cursor' => cursor
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json'
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.get(
    _query_url,
    headers: _headers
  )
  OAuth2.apply(config, _request)
  _response = execute_request(_request)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_response.raw_body)
  _errors = APIHelper.map_response(decoded, ['errors'])
  ApiResponse.new(
    _response, data: decoded, errors: _errors
  )
end

#list_disputes(cursor: nil, states: nil, location_id: nil) ⇒ ListDisputesResponse Hash

Returns a list of disputes associated with a particular account. a previous call to this endpoint. Provide this cursor to retrieve the next set of results for the original query. For more information, see [Pagination](developer.squareup.com/docs/basics/api101/pagination) . filter the result. If not specified, the endpoint returns all open disputes (the dispute status is not ‘INQUIRY_CLOSED`, `WON`, or `LOST`). which to return a list of disputes. If not specified, the endpoint returns all open disputes (the dispute status is not `INQUIRY_CLOSED`, `WON`, or `LOST`) associated with all locations.

Parameters:

  • cursor (String) (defaults to: nil) —

    Optional parameter: A pagination cursor returned by

  • states (DisputeState) (defaults to: nil) —

    Optional parameter: The dispute states to

  • location_id (String) (defaults to: nil) —

    Optional parameter: The ID of the location for

Returns:

  • (ListDisputesResponse Hash) —

    response from the API call



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/square/api/disputes_api.rb', line 22

def list_disputes(cursor: nil,
                  states: nil,
                  location_id: nil)
  # Prepare query url.
  _query_builder = config.get_base_uri
  _query_builder << '/v2/disputes'
  _query_builder = APIHelper.append_url_with_query_parameters(
    _query_builder,
    'cursor' => cursor,
    'states' => states,
    'location_id' => location_id
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json'
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.get(
    _query_url,
    headers: _headers
  )
  OAuth2.apply(config, _request)
  _response = execute_request(_request)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_response.raw_body)
  _errors = APIHelper.map_response(decoded, ['errors'])
  ApiResponse.new(
    _response, data: decoded, errors: _errors
  )
end

#retrieve_dispute(dispute_id:) ⇒ RetrieveDisputeResponse Hash

Returns details about a specific dispute. want more details about.

Parameters:

  • dispute_id (String) —

    Required parameter: The ID of the dispute you

Returns:

  • (RetrieveDisputeResponse Hash) —

    response from the API call



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/square/api/disputes_api.rb', line 61

def retrieve_dispute(dispute_id:)
  # Prepare query url.
  _query_builder = config.get_base_uri
  _query_builder << '/v2/disputes/{dispute_id}'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'dispute_id' => { 'value' => dispute_id, 'encode' => true }
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json'
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.get(
    _query_url,
    headers: _headers
  )
  OAuth2.apply(config, _request)
  _response = execute_request(_request)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_response.raw_body)
  _errors = APIHelper.map_response(decoded, ['errors'])
  ApiResponse.new(
    _response, data: decoded, errors: _errors
  )
end

#retrieve_dispute_evidence(dispute_id:, evidence_id:) ⇒ RetrieveDisputeEvidenceResponse Hash

Returns the evidence metadata specified by the evidence ID in the request URL path You must maintain a copy of the evidence you upload if you want to reference it later. You cannot download the evidence after you upload it. you want to retrieve evidence from. retrieve.

Parameters:

  • dispute_id (String) —

    Required parameter: The ID of the dispute that

  • evidence_id (String) —

    Required parameter: The ID of the evidence to

Returns:

  • (RetrieveDisputeEvidenceResponse Hash) —

    response from the API call



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/square/api/disputes_api.rb', line 335

def retrieve_dispute_evidence(dispute_id:,
                              evidence_id:)
  # Prepare query url.
  _query_builder = config.get_base_uri
  _query_builder << '/v2/disputes/{dispute_id}/evidence/{evidence_id}'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'dispute_id' => { 'value' => dispute_id, 'encode' => true },
    'evidence_id' => { 'value' => evidence_id, 'encode' => true }
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json'
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.get(
    _query_url,
    headers: _headers
  )
  OAuth2.apply(config, _request)
  _response = execute_request(_request)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_response.raw_body)
  _errors = APIHelper.map_response(decoded, ['errors'])
  ApiResponse.new(
    _response, data: decoded, errors: _errors
  )
end

#submit_evidence(dispute_id:) ⇒ SubmitEvidenceResponse Hash

Submits evidence to the cardholder’s bank. Before submitting evidence, Square compiles all available evidence. This includes evidence uploaded using the [CreateDisputeEvidenceFile]($e/Disputes/CreateDisputeEvidenceFile) and [CreateDisputeEvidenceText]($e/Disputes/CreateDisputeEvidenceText) endpoints and evidence automatically provided by Square, when available. you want to submit evidence for.

Parameters:

  • dispute_id (String) —

    Required parameter: The ID of the dispute that

Returns:

  • (SubmitEvidenceResponse Hash) —

    response from the API call



379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/square/api/disputes_api.rb', line 379

def submit_evidence(dispute_id:)
  # Prepare query url.
  _query_builder = config.get_base_uri
  _query_builder << '/v2/disputes/{dispute_id}/submit-evidence'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'dispute_id' => { 'value' => dispute_id, 'encode' => true }
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json'
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.post(
    _query_url,
    headers: _headers
  )
  OAuth2.apply(config, _request)
  _response = execute_request(_request)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_response.raw_body)
  _errors = APIHelper.map_response(decoded, ['errors'])
  ApiResponse.new(
    _response, data: decoded, errors: _errors
  )
end