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.



19
20
21
 
# File 'lib/tca_client/api/similarity_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



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

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 = {}) ⇒ File

GET download pdf

Parameters:

  • x_turnitin_integration_name (String) —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version (String) —

    the version of the integration platform being used

  • id (String) —

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

  • pdf_id (String) —

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

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

    the optional parameters

Returns:

  • (File) 


29
30
31
32
 
# File 'lib/tca_client/api/similarity_api.rb', line 29

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<(File, Integer, Hash)>

GET download pdf

Parameters:

  • x_turnitin_integration_name (String) —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version (String) —

    the version of the integration platform being used

  • id (String) —

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

  • pdf_id (String) —

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

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

    the optional parameters

Returns:

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

    File data, response status code and response headers



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
93
94
95
96
97
98
99
100
101
 
# File 'lib/tca_client/api/similarity_api.rb', line 41

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' + '}', CGI.escape(id.to_s)).sub('{' + 'pdf_id' + '}', CGI.escape(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[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_key']

  new_options = opts.merge(
    :operation => :"SimilarityApi.download_similarity_report_pdf",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  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 (String) —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version (String) —

    the version of the integration platform being used

  • id (String) —

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

  • pdf_id (String) —

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

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

    the optional parameters

Returns:



110
111
112
113
 
# File 'lib/tca_client/api/similarity_api.rb', line 110

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 (String) —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version (String) —

    the version of the integration platform being used

  • id (String) —

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

  • pdf_id (String) —

    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



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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/tca_client/api/similarity_api.rb', line 122

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' + '}', CGI.escape(id.to_s)).sub('{' + 'pdf_id' + '}', CGI.escape(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[:debug_body]

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_key']

  new_options = opts.merge(
    :operation => :"SimilarityApi.get_similarity_report_pdf_status",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  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 (String) —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version (String) —

    the version of the integration platform being used

  • id (String) —

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

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

    the optional parameters

Returns:



190
191
192
193
 
# File 'lib/tca_client/api/similarity_api.rb', line 190

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 (String) —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version (String) —

    the version of the integration platform being used

  • id (String) —

    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



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
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/tca_client/api/similarity_api.rb', line 201

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' + '}', CGI.escape(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[:debug_body]

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_key']

  new_options = opts.merge(
    :operation => :"SimilarityApi.get_similarity_report_results",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  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(x_turnitin_integration_name, x_turnitin_integration_version, id, data, opts = {}) ⇒ SimilarityViewerUrlResponse

Returns a URL to access Cloud Viewer

Parameters:

  • x_turnitin_integration_name (String) —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version (String) —

    the version of the integration platform being used

  • id (String) —

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

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

    the optional parameters

Returns:



266
267
268
269
 
# File 'lib/tca_client/api/similarity_api.rb', line 266

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

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

Returns a URL to access Cloud Viewer

Parameters:

  • x_turnitin_integration_name (String) —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version (String) —

    the version of the integration platform being used

  • id (String) —

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

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

    the optional parameters

Returns:

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

    SimilarityViewerUrlResponse data, response status code and response headers



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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/tca_client/api/similarity_api.rb', line 278

def get_similarity_report_url_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: 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
  # verify the required parameter 'data' is set
  if @api_client.config.client_side_validation && data.nil?
    fail ArgumentError, "Missing the required parameter 'data' when calling SimilarityApi.get_similarity_report_url"
  end
  # resource path
  local_var_path = '/submissions/{id}/viewer-url'.sub('{' + 'id' + '}', CGI.escape(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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  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[:debug_body] || @api_client.object_to_http_body(data)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_key']

  new_options = opts.merge(
    :operation => :"SimilarityApi.get_similarity_report_url",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  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(x_turnitin_integration_name, x_turnitin_integration_version, id, data, opts = {}) ⇒ SuccessMessage

Request Similarity Report generation

Parameters:

  • x_turnitin_integration_name (String) —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version (String) —

    the version of the integration platform being used

  • id (String) —

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

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

    the optional parameters

Returns:



352
353
354
355
 
# File 'lib/tca_client/api/similarity_api.rb', line 352

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

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

Request Pdf download and returns the Pdf Id

Parameters:

  • x_turnitin_integration_name (String) —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version (String) —

    the version of the integration platform being used

  • id (String) —

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

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

    the optional parameters

Returns:



438
439
440
441
 
# File 'lib/tca_client/api/similarity_api.rb', line 438

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

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

Request Pdf download and returns the Pdf Id

Parameters:

  • x_turnitin_integration_name (String) —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version (String) —

    the version of the integration platform being used

  • id (String) —

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

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

    the optional parameters

Returns:

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

    RequestPdfResponse data, response status code and response headers



450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/tca_client/api/similarity_api.rb', line 450

def request_similarity_report_pdf_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, generate_similarity_pdf, 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
  # verify the required parameter 'generate_similarity_pdf' is set
  if @api_client.config.client_side_validation && generate_similarity_pdf.nil?
    fail ArgumentError, "Missing the required parameter 'generate_similarity_pdf' when calling SimilarityApi.request_similarity_report_pdf"
  end
  # resource path
  local_var_path = '/submissions/{id}/similarity/pdf'.sub('{' + 'id' + '}', CGI.escape(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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  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[:debug_body] || @api_client.object_to_http_body(generate_similarity_pdf)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_key']

  new_options = opts.merge(
    :operation => :"SimilarityApi.request_similarity_report_pdf",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  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(x_turnitin_integration_name, x_turnitin_integration_version, id, data, opts = {}) ⇒ Array<(SuccessMessage, Integer, Hash)>

Request Similarity Report generation

Parameters:

  • x_turnitin_integration_name (String) —

    a human readable string representing the type of integration being used

  • x_turnitin_integration_version (String) —

    the version of the integration platform being used

  • id (String) —

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

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

    the optional parameters

Returns:

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

    SuccessMessage data, response status code and response headers



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
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
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/tca_client/api/similarity_api.rb', line 364

def request_similarity_report_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, id, data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: 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
  # verify the required parameter 'data' is set
  if @api_client.config.client_side_validation && data.nil?
    fail ArgumentError, "Missing the required parameter 'data' when calling SimilarityApi.request_similarity_report"
  end
  # resource path
  local_var_path = '/submissions/{id}/similarity'.sub('{' + 'id' + '}', CGI.escape(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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  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[:debug_body] || @api_client.object_to_http_body(data)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['api_key']

  new_options = opts.merge(
    :operation => :"SimilarityApi.request_similarity_report",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  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