Class: RusticiSoftwareCloudV2::ZoomiApi

Inherits:
Object
  • Object
show all
Defined in:
lib/rustici_software_cloud_v2/api/zoomi_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ZoomiApi

Returns a new instance of ZoomiApi.



18
19
20
 
# File 'lib/rustici_software_cloud_v2/api/zoomi_api.rb', line 18

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



16
17
18
 
# File 'lib/rustici_software_cloud_v2/api/zoomi_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#delete_application_zoomi_keys(opts = {}) ⇒ nil

Delete the keys for an application. Delete the keys for an application.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


26
27
28
29
 
# File 'lib/rustici_software_cloud_v2/api/zoomi_api.rb', line 26

def delete_application_zoomi_keys(opts = {})
  delete_application_zoomi_keys_with_http_info(opts)
  return nil
end

#delete_application_zoomi_keys_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete the keys for an application. Delete the keys for an application.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



35
36
37
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
 
# File 'lib/rustici_software_cloud_v2/api/zoomi_api.rb', line 35

def delete_application_zoomi_keys_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ZoomiApi.delete_application_zoomi_keys ..."
  end
  # resource path
  local_var_path = "/zoomi/key".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZoomiApi#delete_application_zoomi_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_zoomi_course(course_id, version_id, opts = {}) ⇒ nil

Deletes the course in zoomi Deletes the course in zoomi

Parameters:

  • course_id
  • version_id —

    The course version

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

    the optional parameters

Returns:

  • (nil) 


76
77
78
79
 
# File 'lib/rustici_software_cloud_v2/api/zoomi_api.rb', line 76

def delete_zoomi_course(course_id, version_id, opts = {})
  delete_zoomi_course_with_http_info(course_id, version_id, opts)
  return nil
end

#delete_zoomi_course_with_http_info(course_id, version_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Deletes the course in zoomi Deletes the course in zoomi

Parameters:

  • course_id
  • version_id —

    The course version

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/rustici_software_cloud_v2/api/zoomi_api.rb', line 87

def delete_zoomi_course_with_http_info(course_id, version_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ZoomiApi.delete_zoomi_course ..."
  end
  # verify the required parameter 'course_id' is set
  fail ArgumentError, "Missing the required parameter 'course_id' when calling ZoomiApi.delete_zoomi_course" if course_id.nil?
  # verify the required parameter 'version_id' is set
  fail ArgumentError, "Missing the required parameter 'version_id' when calling ZoomiApi.delete_zoomi_course" if version_id.nil?
  # resource path
  local_var_path = "/zoomi/course/{courseId}/version/{versionId}".sub('{format}','json').sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZoomiApi#delete_zoomi_course\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_application_zoomi_company_id(opts = {}) ⇒ StringResultSchema

Gets the zoomi company id of an application. Gets the zoomi company id of an application.

Parameters:

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

    the optional parameters

Returns:



130
131
132
133
 
# File 'lib/rustici_software_cloud_v2/api/zoomi_api.rb', line 130

def get_application_zoomi_company_id(opts = {})
  data, _status_code, _headers = get_application_zoomi_company_id_with_http_info(opts)
  return data
end

#get_application_zoomi_company_id_with_http_info(opts = {}) ⇒ Array<(StringResultSchema, Fixnum, Hash)>

Gets the zoomi company id of an application. Gets the zoomi company id of an application.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(StringResultSchema, Fixnum, Hash)>) —

    StringResultSchema data, response status code and response headers



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
 
# File 'lib/rustici_software_cloud_v2/api/zoomi_api.rb', line 139

def get_application_zoomi_company_id_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ZoomiApi.get_application_zoomi_company_id ..."
  end
  # resource path
  local_var_path = "/zoomi".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  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 => 'StringResultSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZoomiApi#get_application_zoomi_company_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_application_zoomi_public_key(opts = {}) ⇒ StringResultSchema

Gets the public key for an application. Gets the public key for an application.

Parameters:

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

    the optional parameters

Returns:



179
180
181
182
 
# File 'lib/rustici_software_cloud_v2/api/zoomi_api.rb', line 179

def get_application_zoomi_public_key(opts = {})
  data, _status_code, _headers = get_application_zoomi_public_key_with_http_info(opts)
  return data
end

#get_application_zoomi_public_key_with_http_info(opts = {}) ⇒ Array<(StringResultSchema, Fixnum, Hash)>

Gets the public key for an application. Gets the public key for an application.

Parameters:

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

    the optional parameters

Returns:

  • (Array<(StringResultSchema, Fixnum, Hash)>) —

    StringResultSchema data, response status code and response headers



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
 
# File 'lib/rustici_software_cloud_v2/api/zoomi_api.rb', line 188

def get_application_zoomi_public_key_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ZoomiApi.get_application_zoomi_public_key ..."
  end
  # resource path
  local_var_path = "/zoomi/key".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  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 => 'StringResultSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZoomiApi#get_application_zoomi_public_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_course_zoomi_enabled(course_id, version_id, opts = {}) ⇒ EnabledSchema

Gets the zoomi enabled value of a course Gets the zoomi enabled value of a course

Parameters:

  • course_id
  • version_id —

    The course version

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

    the optional parameters

Returns:



230
231
232
233
 
# File 'lib/rustici_software_cloud_v2/api/zoomi_api.rb', line 230

def get_course_zoomi_enabled(course_id, version_id, opts = {})
  data, _status_code, _headers = get_course_zoomi_enabled_with_http_info(course_id, version_id, opts)
  return data
end

#get_course_zoomi_enabled_with_http_info(course_id, version_id, opts = {}) ⇒ Array<(EnabledSchema, Fixnum, Hash)>

Gets the zoomi enabled value of a course Gets the zoomi enabled value of a course

Parameters:

  • course_id
  • version_id —

    The course version

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

    the optional parameters

Returns:

  • (Array<(EnabledSchema, Fixnum, Hash)>) —

    EnabledSchema data, response status code and response headers



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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/rustici_software_cloud_v2/api/zoomi_api.rb', line 241

def get_course_zoomi_enabled_with_http_info(course_id, version_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ZoomiApi.get_course_zoomi_enabled ..."
  end
  # verify the required parameter 'course_id' is set
  fail ArgumentError, "Missing the required parameter 'course_id' when calling ZoomiApi.get_course_zoomi_enabled" if course_id.nil?
  # verify the required parameter 'version_id' is set
  fail ArgumentError, "Missing the required parameter 'version_id' when calling ZoomiApi.get_course_zoomi_enabled" if version_id.nil?
  # resource path
  local_var_path = "/zoomi/course/{courseId}/version/{versionId}/enabled".sub('{format}','json').sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  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 => 'EnabledSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZoomiApi#get_course_zoomi_enabled\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_zoomi_course_status(course_id, version_id, opts = {}) ⇒ StringResultSchema

Gets the status for a course and imports to Zoomi Gets the status for a course and imports to Zoomi

Parameters:

  • course_id
  • version_id —

    The course version

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

    the optional parameters

Returns:



287
288
289
290
 
# File 'lib/rustici_software_cloud_v2/api/zoomi_api.rb', line 287

def get_zoomi_course_status(course_id, version_id, opts = {})
  data, _status_code, _headers = get_zoomi_course_status_with_http_info(course_id, version_id, opts)
  return data
end

#get_zoomi_course_status_with_http_info(course_id, version_id, opts = {}) ⇒ Array<(StringResultSchema, Fixnum, Hash)>

Gets the status for a course and imports to Zoomi Gets the status for a course and imports to Zoomi

Parameters:

  • course_id
  • version_id —

    The course version

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

    the optional parameters

Returns:

  • (Array<(StringResultSchema, Fixnum, Hash)>) —

    StringResultSchema data, response status code and response headers



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
 
# File 'lib/rustici_software_cloud_v2/api/zoomi_api.rb', line 298

def get_zoomi_course_status_with_http_info(course_id, version_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ZoomiApi.get_zoomi_course_status ..."
  end
  # verify the required parameter 'course_id' is set
  fail ArgumentError, "Missing the required parameter 'course_id' when calling ZoomiApi.get_zoomi_course_status" if course_id.nil?
  # verify the required parameter 'version_id' is set
  fail ArgumentError, "Missing the required parameter 'version_id' when calling ZoomiApi.get_zoomi_course_status" if version_id.nil?
  # resource path
  local_var_path = "/zoomi/course/{courseId}/version/{versionId}".sub('{format}','json').sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['APP_NORMAL', 'OAUTH']
  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 => 'StringResultSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZoomiApi#get_zoomi_course_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_application_zoomi_company_id(zoomi_company_id, opts = {}) ⇒ nil

Set the zoomi company id value of an application. Set the zoomi company id value of an application.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


343
344
345
346
 
# File 'lib/rustici_software_cloud_v2/api/zoomi_api.rb', line 343

def set_application_zoomi_company_id(zoomi_company_id, opts = {})
  set_application_zoomi_company_id_with_http_info(zoomi_company_id, opts)
  return nil
end

#set_application_zoomi_company_id_with_http_info(zoomi_company_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Set the zoomi company id value of an application. Set the zoomi company id value of an application.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
387
388
 
# File 'lib/rustici_software_cloud_v2/api/zoomi_api.rb', line 353

def set_application_zoomi_company_id_with_http_info(zoomi_company_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ZoomiApi.set_application_zoomi_company_id ..."
  end
  # verify the required parameter 'zoomi_company_id' is set
  fail ArgumentError, "Missing the required parameter 'zoomi_company_id' when calling ZoomiApi.set_application_zoomi_company_id" if zoomi_company_id.nil?
  # resource path
  local_var_path = "/zoomi".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(zoomi_company_id)
  auth_names = ['APP_NORMAL', 'OAUTH']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZoomiApi#set_application_zoomi_company_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_course_zoomi_enabled(course_id, version_id, opts = {}) ⇒ nil

Set the zoomi enabled value of a course. Set the zoomi enabled value of a course.

Parameters:

  • course_id
  • version_id —

    The course version

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


397
398
399
400
 
# File 'lib/rustici_software_cloud_v2/api/zoomi_api.rb', line 397

def set_course_zoomi_enabled(course_id, version_id, opts = {})
  set_course_zoomi_enabled_with_http_info(course_id, version_id, opts)
  return nil
end

#set_course_zoomi_enabled_with_http_info(course_id, version_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Set the zoomi enabled value of a course. Set the zoomi enabled value of a course.

Parameters:

  • course_id
  • version_id —

    The course version

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/rustici_software_cloud_v2/api/zoomi_api.rb', line 409

def set_course_zoomi_enabled_with_http_info(course_id, version_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ZoomiApi.set_course_zoomi_enabled ..."
  end
  # verify the required parameter 'course_id' is set
  fail ArgumentError, "Missing the required parameter 'course_id' when calling ZoomiApi.set_course_zoomi_enabled" if course_id.nil?
  # verify the required parameter 'version_id' is set
  fail ArgumentError, "Missing the required parameter 'version_id' when calling ZoomiApi.set_course_zoomi_enabled" if version_id.nil?
  # resource path
  local_var_path = "/zoomi/course/{courseId}/version/{versionId}/enabled".sub('{format}','json').sub('{' + 'courseId' + '}', course_id.to_s).sub('{' + 'versionId' + '}', version_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'zoomi_course_options'])
  auth_names = ['APP_NORMAL', 'OAUTH']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZoomiApi#set_course_zoomi_enabled\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end