Class: TCAClient::SimilarityApi

Inherits:
Object
  • Object
show all
Defined in:
lib/tca_client/api/similarity_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SimilarityApi

Returns a new instance of SimilarityApi.



16
17
18
 
# File 'lib/tca_client/api/similarity_api.rb', line 16

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/tca_client/api/similarity_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#download_similarity_report_pdf(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id, opts = {}) ⇒ String

GET download pdf

Parameters:

  • x_turnitin_integration_name —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version —

    the version of the integration platform being used

  • id —

    The Submission ID (returned upon a successful POST to /submissions)

  • pdf_id —

    The Pdf ID (returned upon a successful POST to /submissions/submission_id/similarity/pdf)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (String) 


26
27
28
29
 
# File 'lib/tca_client/api/similarity_api.rb', line 26

def download_similarity_report_pdf(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id, opts = {})
  data, _status_code, _headers = download_similarity_report_pdf_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id, opts)
  data
end

#download_similarity_report_pdf_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

GET download pdf

Parameters:

  • x_turnitin_integration_name —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version —

    the version of the integration platform being used

  • id —

    The Submission ID (returned upon a successful POST to /submissions)

  • pdf_id —

    The Pdf ID (returned upon a successful POST to /submissions/submission_id/similarity/pdf)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(String, Integer, Hash)>) —

    String data, response status code and response headers



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
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
91
92
 
# File 'lib/tca_client/api/similarity_api.rb', line 38

def download_similarity_report_pdf_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SimilarityApi.download_similarity_report_pdf ...'
  end
  # verify the required parameter 'x_turnitin_integration_name' is set
  if @api_client.config.client_side_validation && x_turnitin_integration_name.nil?
    fail ArgumentError, "Missing the required parameter 'x_turnitin_integration_name' when calling SimilarityApi.download_similarity_report_pdf"
  end
  # verify the required parameter 'x_turnitin_integration_version' is set
  if @api_client.config.client_side_validation && x_turnitin_integration_version.nil?
    fail ArgumentError, "Missing the required parameter 'x_turnitin_integration_version' when calling SimilarityApi.download_similarity_report_pdf"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SimilarityApi.download_similarity_report_pdf"
  end
  # verify the required parameter 'pdf_id' is set
  if @api_client.config.client_side_validation && pdf_id.nil?
    fail ArgumentError, "Missing the required parameter 'pdf_id' when calling SimilarityApi.download_similarity_report_pdf"
  end
  # resource path
  local_var_path = '/submissions/{id}/similarity/pdf/{pdf_id}'.sub('{' + 'id' + '}', id.to_s).sub('{' + 'pdf_id' + '}', pdf_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/json'])
  header_params[:'X-Turnitin-Integration-Name'] = x_turnitin_integration_name
  header_params[:'X-Turnitin-Integration-Version'] = x_turnitin_integration_version

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'String' 

  auth_names = opts[:auth_names] || ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SimilarityApi#download_similarity_report_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_similarity_report_pdf_status(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id, opts = {}) ⇒ PdfStatusResponse

GET pdf download status

Parameters:

  • x_turnitin_integration_name —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version —

    the version of the integration platform being used

  • id —

    The Submission ID (returned upon a successful POST to /submissions)

  • pdf_id —

    The Pdf ID (returned upon a successful POST to /submissions/submission_id/similarity/pdf)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



100
101
102
103
 
# File 'lib/tca_client/api/similarity_api.rb', line 100

def get_similarity_report_pdf_status(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id, opts = {})
  data, _status_code, _headers = get_similarity_report_pdf_status_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id, opts)
  data
end

#get_similarity_report_pdf_status_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id, opts = {}) ⇒ Array<(PdfStatusResponse, Integer, Hash)>

GET pdf download status

Parameters:

  • x_turnitin_integration_name —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version —

    the version of the integration platform being used

  • id —

    The Submission ID (returned upon a successful POST to /submissions)

  • pdf_id —

    The Pdf ID (returned upon a successful POST to /submissions/submission_id/similarity/pdf)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(PdfStatusResponse, Integer, Hash)>) —

    PdfStatusResponse data, response status code and response headers



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
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
 
# File 'lib/tca_client/api/similarity_api.rb', line 112

def get_similarity_report_pdf_status_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, pdf_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SimilarityApi.get_similarity_report_pdf_status ...'
  end
  # verify the required parameter 'x_turnitin_integration_name' is set
  if @api_client.config.client_side_validation && x_turnitin_integration_name.nil?
    fail ArgumentError, "Missing the required parameter 'x_turnitin_integration_name' when calling SimilarityApi.get_similarity_report_pdf_status"
  end
  # verify the required parameter 'x_turnitin_integration_version' is set
  if @api_client.config.client_side_validation && x_turnitin_integration_version.nil?
    fail ArgumentError, "Missing the required parameter 'x_turnitin_integration_version' when calling SimilarityApi.get_similarity_report_pdf_status"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SimilarityApi.get_similarity_report_pdf_status"
  end
  # verify the required parameter 'pdf_id' is set
  if @api_client.config.client_side_validation && pdf_id.nil?
    fail ArgumentError, "Missing the required parameter 'pdf_id' when calling SimilarityApi.get_similarity_report_pdf_status"
  end
  # resource path
  local_var_path = '/submissions/{id}/similarity/pdf/{pdf_id}/status'.sub('{' + 'id' + '}', id.to_s).sub('{' + 'pdf_id' + '}', pdf_id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Turnitin-Integration-Name'] = x_turnitin_integration_name
  header_params[:'X-Turnitin-Integration-Version'] = x_turnitin_integration_version

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'PdfStatusResponse' 

  auth_names = opts[:auth_names] || ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SimilarityApi#get_similarity_report_pdf_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_similarity_report_results(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {}) ⇒ SimilarityMetadata

Get Similarity Report Results

Parameters:

  • x_turnitin_integration_name —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version —

    the version of the integration platform being used

  • id —

    The Submission ID (returned upon a successful POST to /submissions)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



173
174
175
176
 
# File 'lib/tca_client/api/similarity_api.rb', line 173

def get_similarity_report_results(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
  data, _status_code, _headers = get_similarity_report_results_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
  data
end

#get_similarity_report_results_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {}) ⇒ Array<(SimilarityMetadata, Integer, Hash)>

Get Similarity Report Results

Parameters:

  • x_turnitin_integration_name —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version —

    the version of the integration platform being used

  • id —

    The Submission ID (returned upon a successful POST to /submissions)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SimilarityMetadata, Integer, Hash)>) —

    SimilarityMetadata data, response status code and response headers



184
185
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
 
# File 'lib/tca_client/api/similarity_api.rb', line 184

def get_similarity_report_results_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SimilarityApi.get_similarity_report_results ...'
  end
  # verify the required parameter 'x_turnitin_integration_name' is set
  if @api_client.config.client_side_validation && x_turnitin_integration_name.nil?
    fail ArgumentError, "Missing the required parameter 'x_turnitin_integration_name' when calling SimilarityApi.get_similarity_report_results"
  end
  # verify the required parameter 'x_turnitin_integration_version' is set
  if @api_client.config.client_side_validation && x_turnitin_integration_version.nil?
    fail ArgumentError, "Missing the required parameter 'x_turnitin_integration_version' when calling SimilarityApi.get_similarity_report_results"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SimilarityApi.get_similarity_report_results"
  end
  # resource path
  local_var_path = '/submissions/{id}/similarity'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Turnitin-Integration-Name'] = x_turnitin_integration_name
  header_params[:'X-Turnitin-Integration-Version'] = x_turnitin_integration_version

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'SimilarityMetadata' 

  auth_names = opts[:auth_names] || ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SimilarityApi#get_similarity_report_results\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_similarity_report_url(body, x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {}) ⇒ SimilarityViewerUrlResponse

Returns a URL to access Cloud Viewer

Parameters:

  • body
  • x_turnitin_integration_name —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version —

    the version of the integration platform being used

  • id —

    The Submission ID (returned upon a successful POST to /submissions)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



242
243
244
245
 
# File 'lib/tca_client/api/similarity_api.rb', line 242

def get_similarity_report_url(body, x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
  data, _status_code, _headers = get_similarity_report_url_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
  data
end

#get_similarity_report_url_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {}) ⇒ Array<(SimilarityViewerUrlResponse, Integer, Hash)>

Returns a URL to access Cloud Viewer

Parameters:

  • body
  • x_turnitin_integration_name —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version —

    the version of the integration platform being used

  • id —

    The Submission ID (returned upon a successful POST to /submissions)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SimilarityViewerUrlResponse, Integer, Hash)>) —

    SimilarityViewerUrlResponse data, response status code and response headers



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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/tca_client/api/similarity_api.rb', line 254

def get_similarity_report_url_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SimilarityApi.get_similarity_report_url ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling SimilarityApi.get_similarity_report_url"
  end
  # verify the required parameter 'x_turnitin_integration_name' is set
  if @api_client.config.client_side_validation && x_turnitin_integration_name.nil?
    fail ArgumentError, "Missing the required parameter 'x_turnitin_integration_name' when calling SimilarityApi.get_similarity_report_url"
  end
  # verify the required parameter 'x_turnitin_integration_version' is set
  if @api_client.config.client_side_validation && x_turnitin_integration_version.nil?
    fail ArgumentError, "Missing the required parameter 'x_turnitin_integration_version' when calling SimilarityApi.get_similarity_report_url"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SimilarityApi.get_similarity_report_url"
  end
  # resource path
  local_var_path = '/submissions/{id}/viewer-url'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-Turnitin-Integration-Name'] = x_turnitin_integration_name
  header_params[:'X-Turnitin-Integration-Version'] = x_turnitin_integration_version

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'SimilarityViewerUrlResponse' 

  auth_names = opts[:auth_names] || ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SimilarityApi#get_similarity_report_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#request_similarity_report(body, x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {}) ⇒ SuccessMessage

Request Similarity Report generation

Parameters:

  • body
  • x_turnitin_integration_name —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version —

    the version of the integration platform being used

  • id —

    The Submission ID (returned upon a successful POST to /submissions)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



318
319
320
321
 
# File 'lib/tca_client/api/similarity_api.rb', line 318

def request_similarity_report(body, x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
  data, _status_code, _headers = request_similarity_report_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
  data
end

#request_similarity_report_pdf(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {}) ⇒ RequestPdfResponse

Request Pdf download and returns the Pdf Id

Parameters:

  • x_turnitin_integration_name —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version —

    the version of the integration platform being used

  • id —

    The Submission ID (returned upon a successful POST to /submissions)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



393
394
395
396
 
# File 'lib/tca_client/api/similarity_api.rb', line 393

def request_similarity_report_pdf(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
  data, _status_code, _headers = request_similarity_report_pdf_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts)
  data
end

#request_similarity_report_pdf_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {}) ⇒ Array<(RequestPdfResponse, Integer, Hash)>

Request Pdf download and returns the Pdf Id

Parameters:

  • x_turnitin_integration_name —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version —

    the version of the integration platform being used

  • id —

    The Submission ID (returned upon a successful POST to /submissions)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(RequestPdfResponse, Integer, Hash)>) —

    RequestPdfResponse data, response status code and response headers



404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/tca_client/api/similarity_api.rb', line 404

def request_similarity_report_pdf_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SimilarityApi.request_similarity_report_pdf ...'
  end
  # verify the required parameter 'x_turnitin_integration_name' is set
  if @api_client.config.client_side_validation && x_turnitin_integration_name.nil?
    fail ArgumentError, "Missing the required parameter 'x_turnitin_integration_name' when calling SimilarityApi.request_similarity_report_pdf"
  end
  # verify the required parameter 'x_turnitin_integration_version' is set
  if @api_client.config.client_side_validation && x_turnitin_integration_version.nil?
    fail ArgumentError, "Missing the required parameter 'x_turnitin_integration_version' when calling SimilarityApi.request_similarity_report_pdf"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SimilarityApi.request_similarity_report_pdf"
  end
  # resource path
  local_var_path = '/submissions/{id}/similarity/pdf'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Turnitin-Integration-Name'] = x_turnitin_integration_name
  header_params[:'X-Turnitin-Integration-Version'] = x_turnitin_integration_version

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  return_type = opts[:return_type] || 'RequestPdfResponse' 

  auth_names = opts[:auth_names] || ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SimilarityApi#request_similarity_report_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#request_similarity_report_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {}) ⇒ Array<(SuccessMessage, Integer, Hash)>

Request Similarity Report generation

Parameters:

  • body
  • x_turnitin_integration_name —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version —

    the version of the integration platform being used

  • id —

    The Submission ID (returned upon a successful POST to /submissions)

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(SuccessMessage, Integer, Hash)>) —

    SuccessMessage data, response status code and response headers



330
331
332
333
334
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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/tca_client/api/similarity_api.rb', line 330

def request_similarity_report_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SimilarityApi.request_similarity_report ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling SimilarityApi.request_similarity_report"
  end
  # verify the required parameter 'x_turnitin_integration_name' is set
  if @api_client.config.client_side_validation && x_turnitin_integration_name.nil?
    fail ArgumentError, "Missing the required parameter 'x_turnitin_integration_name' when calling SimilarityApi.request_similarity_report"
  end
  # verify the required parameter 'x_turnitin_integration_version' is set
  if @api_client.config.client_side_validation && x_turnitin_integration_version.nil?
    fail ArgumentError, "Missing the required parameter 'x_turnitin_integration_version' when calling SimilarityApi.request_similarity_report"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SimilarityApi.request_similarity_report"
  end
  # resource path
  local_var_path = '/submissions/{id}/similarity'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-Turnitin-Integration-Name'] = x_turnitin_integration_name
  header_params[:'X-Turnitin-Integration-Version'] = x_turnitin_integration_version

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'SuccessMessage' 

  auth_names = opts[:auth_names] || ['api_key']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SimilarityApi#request_similarity_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end