Class: TCAClient::EULAApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ EULAApi

Returns a new instance of EULAApi.



19
20
21
 
# File 'lib/tca_client/api/eula_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/eula_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#eula_version_id_accept_post(x_turnitin_integration_name, x_turnitin_integration_version, version_id, data, opts = {}) ⇒ EulaAcceptListItem

Accepts a particular EULA version on behalf of an external user

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

  • version_id (String) —

    The EULA version ID (or `latest`)

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

    the optional parameters

Returns:



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

def eula_version_id_accept_post(x_turnitin_integration_name, x_turnitin_integration_version, version_id, data, opts = {})
  data, _status_code, _headers = eula_version_id_accept_post_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, version_id, data, opts)
  data
end

#eula_version_id_accept_post_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, version_id, data, opts = {}) ⇒ Array<(EulaAcceptListItem, Integer, Hash)>

Accepts a particular EULA version on behalf of an external user

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

  • version_id (String) —

    The EULA version ID (or &#x60;latest&#x60;)

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

    the optional parameters

Returns:

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

    EulaAcceptListItem 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
102
103
104
105
106
 
# File 'lib/tca_client/api/eula_api.rb', line 41

def eula_version_id_accept_post_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, version_id, data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EULAApi.eula_version_id_accept_post ...'
  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 EULAApi.eula_version_id_accept_post"
  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 EULAApi.eula_version_id_accept_post"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling EULAApi.eula_version_id_accept_post"
  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 EULAApi.eula_version_id_accept_post"
  end
  # resource path
  local_var_path = '/eula/{version_id}/accept'.sub('{' + 'version_id' + '}', CGI.escape(version_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] || 'EulaAcceptListItem'

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

  new_options = opts.merge(
    :operation => :"EULAApi.eula_version_id_accept_post",
    :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: EULAApi#eula_version_id_accept_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#eula_version_id_accept_user_id_get(x_turnitin_integration_name, x_turnitin_integration_version, version_id, user_id, opts = {}) ⇒ Array<EulaAcceptListItem>

Queries the acceptences of a particular EULA version on behalf of an external user

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

  • version_id (String) —

    The EULA version ID (or &#x60;latest&#x60;)

  • user_id (String) —

    The user associated with the EULA status

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

    the optional parameters

Returns:



115
116
117
118
 
# File 'lib/tca_client/api/eula_api.rb', line 115

def eula_version_id_accept_user_id_get(x_turnitin_integration_name, x_turnitin_integration_version, version_id, user_id, opts = {})
  data, _status_code, _headers = eula_version_id_accept_user_id_get_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, version_id, user_id, opts)
  data
end

#eula_version_id_accept_user_id_get_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, version_id, user_id, opts = {}) ⇒ Array<(Array<EulaAcceptListItem>, Integer, Hash)>

Queries the acceptences of a particular EULA version on behalf of an external user

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

  • version_id (String) —

    The EULA version ID (or &#x60;latest&#x60;)

  • user_id (String) —

    The user associated with the EULA status

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

    the optional parameters

Returns:

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

    Array<EulaAcceptListItem> data, response status code and response headers



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
183
184
185
186
187
 
# File 'lib/tca_client/api/eula_api.rb', line 127

def eula_version_id_accept_user_id_get_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, version_id, user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EULAApi.eula_version_id_accept_user_id_get ...'
  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 EULAApi.eula_version_id_accept_user_id_get"
  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 EULAApi.eula_version_id_accept_user_id_get"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling EULAApi.eula_version_id_accept_user_id_get"
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling EULAApi.eula_version_id_accept_user_id_get"
  end
  # resource path
  local_var_path = '/eula/{version_id}/accept/{user_id}'.sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'user_id' + '}', CGI.escape(user_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] || 'Array<EulaAcceptListItem>'

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

  new_options = opts.merge(
    :operation => :"EULAApi.eula_version_id_accept_user_id_get",
    :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: EULAApi#eula_version_id_accept_user_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#eula_version_id_get(x_turnitin_integration_name, x_turnitin_integration_version, version_id, opts = {}) ⇒ EulaVersion

Gets information about a particular EULA version

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

  • version_id (String) —

    The EULA version ID (or &#x60;latest&#x60;)

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

    the optional parameters

Options Hash (opts):

  • :lang (String) —

    The desired language of the specified EULA version

Returns:



196
197
198
199
 
# File 'lib/tca_client/api/eula_api.rb', line 196

def eula_version_id_get(x_turnitin_integration_name, x_turnitin_integration_version, version_id, opts = {})
  data, _status_code, _headers = eula_version_id_get_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, version_id, opts)
  data
end

#eula_version_id_get_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, version_id, opts = {}) ⇒ Array<(EulaVersion, Integer, Hash)>

Gets information about a particular EULA version

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

  • version_id (String) —

    The EULA version ID (or &#x60;latest&#x60;)

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

    the optional parameters

Options Hash (opts):

  • :lang (String) —

    The desired language of the specified EULA version

Returns:

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

    EulaVersion data, response status code and response headers



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
258
259
260
261
262
263
264
265
 
# File 'lib/tca_client/api/eula_api.rb', line 208

def eula_version_id_get_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, version_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EULAApi.eula_version_id_get ...'
  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 EULAApi.eula_version_id_get"
  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 EULAApi.eula_version_id_get"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling EULAApi.eula_version_id_get"
  end
  # resource path
  local_var_path = '/eula/{version_id}'.sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'lang'] = opts[:'lang'] if !opts[:'lang'].nil?

  # 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] || 'EulaVersion'

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

  new_options = opts.merge(
    :operation => :"EULAApi.eula_version_id_get",
    :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: EULAApi#eula_version_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#eula_version_id_view_get(x_turnitin_integration_name, x_turnitin_integration_version, version_id, opts = {}) ⇒ String

Gets the text of a particular EULA version

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

  • version_id (String) —

    The EULA version ID (or &#x60;latest&#x60;)

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

    the optional parameters

Options Hash (opts):

  • :lang (String) —

    The desired language of the specified EULA version

Returns:

  • (String) 


274
275
276
277
 
# File 'lib/tca_client/api/eula_api.rb', line 274

def eula_version_id_view_get(x_turnitin_integration_name, x_turnitin_integration_version, version_id, opts = {})
  data, _status_code, _headers = eula_version_id_view_get_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, version_id, opts)
  data
end

#eula_version_id_view_get_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, version_id, opts = {}) ⇒ Array<(String, Integer, Hash)>

Gets the text of a particular EULA version

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

  • version_id (String) —

    The EULA version ID (or &#x60;latest&#x60;)

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

    the optional parameters

Options Hash (opts):

  • :lang (String) —

    The desired language of the specified EULA version

Returns:

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

    String data, response status code and response headers



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/eula_api.rb', line 286

def eula_version_id_view_get_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, version_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: EULAApi.eula_version_id_view_get ...'
  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 EULAApi.eula_version_id_view_get"
  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 EULAApi.eula_version_id_view_get"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling EULAApi.eula_version_id_view_get"
  end
  # resource path
  local_var_path = '/eula/{version_id}/view'.sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'lang'] = opts[:'lang'] if !opts[:'lang'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain; charset=utf-8', 'application/html'])
  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] || 'String'

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

  new_options = opts.merge(
    :operation => :"EULAApi.eula_version_id_view_get",
    :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: EULAApi#eula_version_id_view_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end