Class: TCAClient::GroupsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ GroupsApi

Returns a new instance of GroupsApi.



16
17
18
 
# File 'lib/tca_client/api/groups_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/groups_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#add_group_attachment(body, x_turnitin_integration_name, x_turnitin_integration_version, group_id, opts = {}) ⇒ AddGroupAttachmentResponse

Add attachment to a group. will create a group if it does not exist.

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

  • group_id —

    group_id

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

    the optional parameters

Returns:



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

def add_group_attachment(body, x_turnitin_integration_name, x_turnitin_integration_version, group_id, opts = {})
  data, _status_code, _headers = add_group_attachment_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, group_id, opts)
  data
end

#add_group_attachment_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, group_id, opts = {}) ⇒ Array<(AddGroupAttachmentResponse, Integer, Hash)>

Add attachment to a group. will create a group if it does not exist.

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

  • group_id —

    group_id

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

    the optional parameters

Returns:

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

    AddGroupAttachmentResponse 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
93
94
 
# File 'lib/tca_client/api/groups_api.rb', line 38

def add_group_attachment_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.add_group_attachment ...'
  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 GroupsApi.add_group_attachment"
  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 GroupsApi.add_group_attachment"
  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 GroupsApi.add_group_attachment"
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.add_group_attachment"
  end
  # resource path
  local_var_path = '/groups/{group_id}/attachments'.sub('{' + 'group_id' + '}', group_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] || 'AddGroupAttachmentResponse' 

  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: GroupsApi#add_group_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_group_attachment(x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id, opts = {}) ⇒ nil

Hard delete group attachment

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

  • group_id —

    group_id

  • attach_id —

    The attachment ID (returned from a successful group attachment request)

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

    the optional parameters

Returns:

  • (nil) 


102
103
104
105
 
# File 'lib/tca_client/api/groups_api.rb', line 102

def delete_group_attachment(x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id, opts = {})
  delete_group_attachment_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id, opts)
  nil
end

#delete_group_attachment_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Hard delete group attachment

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

  • group_id —

    group_id

  • attach_id —

    The attachment ID (returned from a successful group attachment request)

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
167
168
 
# File 'lib/tca_client/api/groups_api.rb', line 114

def delete_group_attachment_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.delete_group_attachment ...'
  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 GroupsApi.delete_group_attachment"
  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 GroupsApi.delete_group_attachment"
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.delete_group_attachment"
  end
  # verify the required parameter 'attach_id' is set
  if @api_client.config.client_side_validation && attach_id.nil?
    fail ArgumentError, "Missing the required parameter 'attach_id' when calling GroupsApi.delete_group_attachment"
  end
  # resource path
  local_var_path = '/groups/{group_id}/attachments/{attach_id}'.sub('{' + 'group_id' + '}', group_id.to_s).sub('{' + 'attach_id' + '}', attach_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] 

  auth_names = opts[:auth_names] || ['api_key']
  data, status_code, headers = @api_client.call_api(:DELETE, 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: GroupsApi#delete_group_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_group(x_turnitin_integration_name, x_turnitin_integration_version, group_id, opts = {}) ⇒ AggregateGroup

Get group, group context and group context owners info

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

  • group_id —

    group_id

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

    the optional parameters

Returns:



175
176
177
178
 
# File 'lib/tca_client/api/groups_api.rb', line 175

def get_group(x_turnitin_integration_name, x_turnitin_integration_version, group_id, opts = {})
  data, _status_code, _headers = get_group_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, group_id, opts)
  data
end

#get_group_attachment(x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id, opts = {}) ⇒ GroupAttachmentResponse

Get group attachment

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

  • group_id —

    group_id

  • attach_id —

    The attachment ID (returned from a successful group attachment request)

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

    the optional parameters

Returns:



244
245
246
247
 
# File 'lib/tca_client/api/groups_api.rb', line 244

def get_group_attachment(x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id, opts = {})
  data, _status_code, _headers = get_group_attachment_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id, opts)
  data
end

#get_group_attachment_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id, opts = {}) ⇒ Array<(GroupAttachmentResponse, Integer, Hash)>

Get group attachment

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

  • group_id —

    group_id

  • attach_id —

    The attachment ID (returned from a successful group attachment request)

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

    the optional parameters

Returns:

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

    GroupAttachmentResponse data, response status code and response headers



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/groups_api.rb', line 256

def get_group_attachment_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.get_group_attachment ...'
  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 GroupsApi.get_group_attachment"
  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 GroupsApi.get_group_attachment"
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.get_group_attachment"
  end
  # verify the required parameter 'attach_id' is set
  if @api_client.config.client_side_validation && attach_id.nil?
    fail ArgumentError, "Missing the required parameter 'attach_id' when calling GroupsApi.get_group_attachment"
  end
  # resource path
  local_var_path = '/groups/{group_id}/attachments/{attach_id}'.sub('{' + 'group_id' + '}', group_id.to_s).sub('{' + 'attach_id' + '}', attach_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] || 'GroupAttachmentResponse' 

  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: GroupsApi#get_group_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_group_attachments(x_turnitin_integration_name, x_turnitin_integration_version, group_id, opts = {}) ⇒ InlineResponse200

Get all attachments

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

  • group_id —

    group_id

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

    the optional parameters

Returns:



317
318
319
320
 
# File 'lib/tca_client/api/groups_api.rb', line 317

def get_group_attachments(x_turnitin_integration_name, x_turnitin_integration_version, group_id, opts = {})
  data, _status_code, _headers = get_group_attachments_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, group_id, opts)
  data
end

#get_group_attachments_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, group_id, opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>

Get all attachments

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

  • group_id —

    group_id

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

    the optional parameters

Returns:

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

    InlineResponse200 data, response status code and response headers



328
329
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
 
# File 'lib/tca_client/api/groups_api.rb', line 328

def get_group_attachments_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.get_group_attachments ...'
  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 GroupsApi.get_group_attachments"
  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 GroupsApi.get_group_attachments"
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.get_group_attachments"
  end
  # resource path
  local_var_path = '/groups/{group_id}/attachments'.sub('{' + 'group_id' + '}', group_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] || 'InlineResponse200' 

  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: GroupsApi#get_group_attachments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_group_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, group_id, opts = {}) ⇒ Array<(AggregateGroup, Integer, Hash)>

Get group, group context and group context owners info

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

  • group_id —

    group_id

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

    the optional parameters

Returns:

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

    AggregateGroup data, response status code and response headers



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
 
# File 'lib/tca_client/api/groups_api.rb', line 186

def get_group_with_http_info(x_turnitin_integration_name, x_turnitin_integration_version, group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.get_group ...'
  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 GroupsApi.get_group"
  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 GroupsApi.get_group"
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.get_group"
  end
  # resource path
  local_var_path = '/groups/{group_id}'.sub('{' + 'group_id' + '}', group_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] || 'AggregateGroup' 

  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: GroupsApi#get_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#groups_group_id_put(body, x_turnitin_integration_name, x_turnitin_integration_version, group_id, opts = {}) ⇒ AggregateGroup

upsert group, group context and group context owners info

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

  • group_id —

    group_id

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

    the optional parameters

Returns:



386
387
388
389
 
# File 'lib/tca_client/api/groups_api.rb', line 386

def groups_group_id_put(body, x_turnitin_integration_name, x_turnitin_integration_version, group_id, opts = {})
  data, _status_code, _headers = groups_group_id_put_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, group_id, opts)
  data
end

#groups_group_id_put_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, group_id, opts = {}) ⇒ Array<(AggregateGroup, Integer, Hash)>

upsert group, group context and group context owners info

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

  • group_id —

    group_id

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

    the optional parameters

Returns:

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

    AggregateGroup data, response status code and response headers



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
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/groups_api.rb', line 398

def groups_group_id_put_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.groups_group_id_put ...'
  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 GroupsApi.groups_group_id_put"
  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 GroupsApi.groups_group_id_put"
  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 GroupsApi.groups_group_id_put"
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.groups_group_id_put"
  end
  # resource path
  local_var_path = '/groups/{group_id}'.sub('{' + 'group_id' + '}', group_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] || 'AggregateGroup' 

  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: GroupsApi#groups_group_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_group_attachment(body, x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id, opts = {}) ⇒ GroupAttachmentResponse

Patch a group attachment

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

  • group_id —

    group_id

  • attach_id —

    The attachment ID (returned from a successful group attachment request)

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

    the optional parameters

Returns:



463
464
465
466
 
# File 'lib/tca_client/api/groups_api.rb', line 463

def update_group_attachment(body, x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id, opts = {})
  data, _status_code, _headers = update_group_attachment_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id, opts)
  data
end

#update_group_attachment_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id, opts = {}) ⇒ Array<(GroupAttachmentResponse, Integer, Hash)>

Patch a group attachment

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

  • group_id —

    group_id

  • attach_id —

    The attachment ID (returned from a successful group attachment request)

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

    the optional parameters

Returns:

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

    GroupAttachmentResponse data, response status code and response headers



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
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/tca_client/api/groups_api.rb', line 476

def update_group_attachment_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, group_id, attach_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.update_group_attachment ...'
  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 GroupsApi.update_group_attachment"
  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 GroupsApi.update_group_attachment"
  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 GroupsApi.update_group_attachment"
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.update_group_attachment"
  end
  # verify the required parameter 'attach_id' is set
  if @api_client.config.client_side_validation && attach_id.nil?
    fail ArgumentError, "Missing the required parameter 'attach_id' when calling GroupsApi.update_group_attachment"
  end
  # resource path
  local_var_path = '/groups/{group_id}/attachments/{attach_id}'.sub('{' + 'group_id' + '}', group_id.to_s).sub('{' + 'attach_id' + '}', attach_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] || 'GroupAttachmentResponse' 

  auth_names = opts[:auth_names] || ['api_key']
  data, status_code, headers = @api_client.call_api(:PATCH, 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: GroupsApi#update_group_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upload_group_attachment(body, x_turnitin_integration_name, x_turnitin_integration_version, content_disposition, group_id, attach_id, opts = {}) ⇒ SuccessMessage

Upload Submitted File

Parameters:

  • body —

    the attachment file

  • 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

  • content_disposition —

    *must include the &quot;filename&quot; parameter, e.g. &#x60;inline; filename&#x3D;&quot;MyFile.docx&quot;&#x60;

  • group_id —

    The Group ID (required to already exist)

  • attach_id —

    The attachment ID (returned from a successful group attachment request)

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

    the optional parameters

Returns:



546
547
548
549
 
# File 'lib/tca_client/api/groups_api.rb', line 546

def upload_group_attachment(body, x_turnitin_integration_name, x_turnitin_integration_version, content_disposition, group_id, attach_id, opts = {})
  data, _status_code, _headers = upload_group_attachment_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, content_disposition, group_id, attach_id, opts)
  data
end

#upload_group_attachment_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, content_disposition, group_id, attach_id, opts = {}) ⇒ Array<(SuccessMessage, Integer, Hash)>

Upload Submitted File

Parameters:

  • body —

    the attachment file

  • 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

  • content_disposition —

    *must include the &quot;filename&quot; parameter, e.g. &#x60;inline; filename&#x3D;&quot;MyFile.docx&quot;&#x60;

  • group_id —

    The Group ID (required to already exist)

  • attach_id —

    The attachment ID (returned from a successful group attachment request)

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

    the optional parameters

Returns:

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

    SuccessMessage data, response status code and response headers



560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
 
# File 'lib/tca_client/api/groups_api.rb', line 560

def upload_group_attachment_with_http_info(body, x_turnitin_integration_name, x_turnitin_integration_version, content_disposition, group_id, attach_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GroupsApi.upload_group_attachment ...'
  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 GroupsApi.upload_group_attachment"
  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 GroupsApi.upload_group_attachment"
  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 GroupsApi.upload_group_attachment"
  end
  # verify the required parameter 'content_disposition' is set
  if @api_client.config.client_side_validation && content_disposition.nil?
    fail ArgumentError, "Missing the required parameter 'content_disposition' when calling GroupsApi.upload_group_attachment"
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling GroupsApi.upload_group_attachment"
  end
  # verify the required parameter 'attach_id' is set
  if @api_client.config.client_side_validation && attach_id.nil?
    fail ArgumentError, "Missing the required parameter 'attach_id' when calling GroupsApi.upload_group_attachment"
  end
  # resource path
  local_var_path = '/groups/{group_id}/attachments/{attach_id}/original'.sub('{' + 'group_id' + '}', group_id.to_s).sub('{' + 'attach_id' + '}', attach_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(['binary/octet-stream'])
  header_params[:'X-Turnitin-Integration-Name'] = x_turnitin_integration_name
  header_params[:'X-Turnitin-Integration-Version'] = x_turnitin_integration_version
  header_params[:'Content-Disposition'] = content_disposition

  # 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: GroupsApi#upload_group_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end