Class: RusticiSoftwareCloudV2::DispatchApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DispatchApi

Returns a new instance of DispatchApi.



19
20
21
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_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/rustici_software_cloud_v2/api/dispatch_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_destinations(destinations_list, opts = {}) ⇒ nil

DestinationsByTenant Create multiple destinations.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 27

def create_destinations(destinations_list, opts = {})
  create_destinations_with_http_info(destinations_list, opts)
  nil
end

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

DestinationsByTenant Create multiple destinations.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
69
70
71
72
73
74
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 37

def create_destinations_with_http_info(destinations_list, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.create_destinations ...'
  end
  # verify the required parameter 'destinations_list' is set
  if @api_client.config.client_side_validation && destinations_list.nil?
    fail ArgumentError, "Missing the required parameter 'destinations_list' when calling DispatchApi.create_destinations"
  end
  # resource path
  local_var_path = '/dispatch/destinations'

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

#create_dispatches(dispatch_list, opts = {}) ⇒ nil

Create dispatches. Create multiple dispatches at once.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


80
81
82
83
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 80

def create_dispatches(dispatch_list, opts = {})
  create_dispatches_with_http_info(dispatch_list, opts)
  nil
end

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

Create dispatches. Create multiple dispatches at once.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
125
126
127
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 90

def create_dispatches_with_http_info(dispatch_list, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.create_dispatches ...'
  end
  # verify the required parameter 'dispatch_list' is set
  if @api_client.config.client_side_validation && dispatch_list.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_list' when calling DispatchApi.create_dispatches"
  end
  # resource path
  local_var_path = '/dispatch/dispatches'

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

#delete_destination(destination_id, opts = {}) ⇒ nil

Delete destination Delete the destination with ‘destinationId`

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Returns:

  • (nil) 


133
134
135
136
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 133

def delete_destination(destination_id, opts = {})
  delete_destination_with_http_info(destination_id, opts)
  nil
end

#delete_destination_dispatches(destination_id, opts = {}) ⇒ nil

Delete dispatches in destination Delete the dispatches in a destination

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Returns:

  • (nil) 


186
187
188
189
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 186

def delete_destination_dispatches(destination_id, opts = {})
  delete_destination_dispatches_with_http_info(destination_id, opts)
  nil
end

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

Delete dispatches in destination Delete the dispatches in a destination

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def delete_destination_dispatches_with_http_info(destination_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.delete_destination_dispatches ...'
  end
  # verify the required parameter 'destination_id' is set
  if @api_client.config.client_side_validation && destination_id.nil?
    fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.delete_destination_dispatches"
  end
  # resource path
  local_var_path = '/dispatch/destinations/{destinationId}/dispatches'.sub('{' + 'destinationId' + '}', destination_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: DispatchApi#delete_destination_dispatches\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_destination_tags(destination_id, tags, opts = {}) ⇒ nil

Delete the tags for this destination Delete the tags for this destination

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Returns:

  • (nil) 


240
241
242
243
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 240

def delete_destination_tags(destination_id, tags, opts = {})
  delete_destination_tags_with_http_info(destination_id, tags, opts)
  nil
end

#delete_destination_tags_with_http_info(destination_id, tags, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete the tags for this destination Delete the tags for this destination

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 251

def delete_destination_tags_with_http_info(destination_id, tags, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.delete_destination_tags ...'
  end
  # verify the required parameter 'destination_id' is set
  if @api_client.config.client_side_validation && destination_id.nil?
    fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.delete_destination_tags"
  end
  # verify the required parameter 'tags' is set
  if @api_client.config.client_side_validation && tags.nil?
    fail ArgumentError, "Missing the required parameter 'tags' when calling DispatchApi.delete_destination_tags"
  end
  # resource path
  local_var_path = '/dispatch/destinations/{destinationId}/tags'.sub('{' + 'destinationId' + '}', destination_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(tags)
  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: DispatchApi#delete_destination_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete destination Delete the destination with &#x60;destinationId&#x60;

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def delete_destination_with_http_info(destination_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.delete_destination ...'
  end
  # verify the required parameter 'destination_id' is set
  if @api_client.config.client_side_validation && destination_id.nil?
    fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.delete_destination"
  end
  # resource path
  local_var_path = '/dispatch/destinations/{destinationId}'.sub('{' + 'destinationId' + '}', destination_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: DispatchApi#delete_destination\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_dispatch(dispatch_id, opts = {}) ⇒ nil

Delete the dispatch with ‘dispatchId`. Delete the dispatch with `dispatchId`.

Parameters:

  • dispatch_id —

    Identifier for the dispatch

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

    the optional parameters

Returns:

  • (nil) 


298
299
300
301
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 298

def delete_dispatch(dispatch_id, opts = {})
  delete_dispatch_with_http_info(dispatch_id, opts)
  nil
end

#delete_dispatch_postback_info(dispatch_id, opts = {}) ⇒ nil

DispatchesByTenantAndDispatchId Delete the postback info dispatch with ‘dispatchId’.

Parameters:

  • dispatch_id —

    Identifier for the dispatch

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

    the optional parameters

Returns:

  • (nil) 


351
352
353
354
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 351

def delete_dispatch_postback_info(dispatch_id, opts = {})
  delete_dispatch_postback_info_with_http_info(dispatch_id, opts)
  nil
end

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

DispatchesByTenantAndDispatchId Delete the postback info dispatch with &#39;dispatchId&#39;.

Parameters:

  • dispatch_id —

    Identifier for the dispatch

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 361

def delete_dispatch_postback_info_with_http_info(dispatch_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.delete_dispatch_postback_info ...'
  end
  # verify the required parameter 'dispatch_id' is set
  if @api_client.config.client_side_validation && dispatch_id.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.delete_dispatch_postback_info"
  end
  # resource path
  local_var_path = '/dispatch/dispatches/{dispatchId}/postback'.sub('{' + 'dispatchId' + '}', dispatch_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: DispatchApi#delete_dispatch_postback_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_dispatch_tags(dispatch_id, tags, opts = {}) ⇒ nil

Delete the tags for this dispatch. Delete the tags for this dispatch.

Parameters:

  • dispatch_id —

    Identifier for the dispatch

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

    the optional parameters

Returns:

  • (nil) 


405
406
407
408
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 405

def delete_dispatch_tags(dispatch_id, tags, opts = {})
  delete_dispatch_tags_with_http_info(dispatch_id, tags, opts)
  nil
end

#delete_dispatch_tags_with_http_info(dispatch_id, tags, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete the tags for this dispatch. Delete the tags for this dispatch.

Parameters:

  • dispatch_id —

    Identifier for the dispatch

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
455
456
457
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 416

def delete_dispatch_tags_with_http_info(dispatch_id, tags, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.delete_dispatch_tags ...'
  end
  # verify the required parameter 'dispatch_id' is set
  if @api_client.config.client_side_validation && dispatch_id.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.delete_dispatch_tags"
  end
  # verify the required parameter 'tags' is set
  if @api_client.config.client_side_validation && tags.nil?
    fail ArgumentError, "Missing the required parameter 'tags' when calling DispatchApi.delete_dispatch_tags"
  end
  # resource path
  local_var_path = '/dispatch/dispatches/{dispatchId}/tags'.sub('{' + 'dispatchId' + '}', dispatch_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(tags)
  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: DispatchApi#delete_dispatch_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete the dispatch with &#x60;dispatchId&#x60;. Delete the dispatch with &#x60;dispatchId&#x60;.

Parameters:

  • dispatch_id —

    Identifier for the dispatch

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
344
345
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 308

def delete_dispatch_with_http_info(dispatch_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.delete_dispatch ...'
  end
  # verify the required parameter 'dispatch_id' is set
  if @api_client.config.client_side_validation && dispatch_id.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.delete_dispatch"
  end
  # resource path
  local_var_path = '/dispatch/dispatches/{dispatchId}'.sub('{' + 'dispatchId' + '}', dispatch_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: DispatchApi#delete_dispatch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#enable_registration_instancing(destination_id, enabled, opts = {}) ⇒ nil

DestinationsDispatchesRegistrationInstancing Enable or disable registration instancing.

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Returns:

  • (nil) 


464
465
466
467
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 464

def enable_registration_instancing(destination_id, enabled, opts = {})
  enable_registration_instancing_with_http_info(destination_id, enabled, opts)
  nil
end

#enable_registration_instancing_with_http_info(destination_id, enabled, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

DestinationsDispatchesRegistrationInstancing Enable or disable registration instancing.

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
516
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 475

def enable_registration_instancing_with_http_info(destination_id, enabled, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.enable_registration_instancing ...'
  end
  # verify the required parameter 'destination_id' is set
  if @api_client.config.client_side_validation && destination_id.nil?
    fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.enable_registration_instancing"
  end
  # verify the required parameter 'enabled' is set
  if @api_client.config.client_side_validation && enabled.nil?
    fail ArgumentError, "Missing the required parameter 'enabled' when calling DispatchApi.enable_registration_instancing"
  end
  # resource path
  local_var_path = '/dispatch/destinations/{destinationId}/dispatches/registrationInstancing'.sub('{' + 'destinationId' + '}', destination_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(enabled)
  auth_names = ['APP_NORMAL', 'OAUTH']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DispatchApi#enable_registration_instancing\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_destination(destination_id, opts = {}) ⇒ DestinationSchema

Get destination information by destinationId. Gets detailed information about a destination belonging to a destinationId.

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Returns:



522
523
524
525
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 522

def get_destination(destination_id, opts = {})
  data, _status_code, _headers = get_destination_with_http_info(destination_id, opts)
  data
end

#get_destination_dispatch_registration_count(destination_id, opts = {}) ⇒ IntegerResultSchema

DestinationsDispatchesRegistrationCount Get an aggregate count of all related dispatch registrations.

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Returns:



576
577
578
579
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 576

def get_destination_dispatch_registration_count(destination_id, opts = {})
  data, _status_code, _headers = get_destination_dispatch_registration_count_with_http_info(destination_id, opts)
  data
end

#get_destination_dispatch_registration_count_with_http_info(destination_id, opts = {}) ⇒ Array<(IntegerResultSchema, Fixnum, Hash)>

DestinationsDispatchesRegistrationCount Get an aggregate count of all related dispatch registrations.

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Returns:

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

    IntegerResultSchema data, response status code and response headers



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

def get_destination_dispatch_registration_count_with_http_info(destination_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.get_destination_dispatch_registration_count ...'
  end
  # verify the required parameter 'destination_id' is set
  if @api_client.config.client_side_validation && destination_id.nil?
    fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination_dispatch_registration_count"
  end
  # resource path
  local_var_path = '/dispatch/destinations/{destinationId}/dispatches/registrationCount'.sub('{' + 'destinationId' + '}', destination_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 => 'IntegerResultSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DispatchApi#get_destination_dispatch_registration_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_destination_dispatch_zip(destination_id, opts = {}) ⇒ File

Get a ZIP of related dispatches. Returns a zip file containing all of the dispatch packages for a destination.

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The type of dispatch package to export (SCORM12 only supported in cloud today) (default to SCORM12)

  • :css_url (String)
  • :tags (Array<String>)

Returns:

  • (File) 


633
634
635
636
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 633

def get_destination_dispatch_zip(destination_id, opts = {})
  data, _status_code, _headers = get_destination_dispatch_zip_with_http_info(destination_id, opts)
  data
end

#get_destination_dispatch_zip_with_http_info(destination_id, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Get a ZIP of related dispatches. Returns a zip file containing all of the dispatch packages for a destination.

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The type of dispatch package to export (SCORM12 only supported in cloud today)

  • :css_url (String)
  • :tags (Array<String>)

Returns:

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

    File data, response status code and response headers



646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 646

def get_destination_dispatch_zip_with_http_info(destination_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.get_destination_dispatch_zip ...'
  end
  # verify the required parameter 'destination_id' is set
  if @api_client.config.client_side_validation && destination_id.nil?
    fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination_dispatch_zip"
  end
  if @api_client.config.client_side_validation && opts[:'type'] && !['SCORM12'].include?(opts[:'type'])
    fail ArgumentError, 'invalid value for "type", must be one of SCORM12'
  end
  # resource path
  local_var_path = '/dispatch/destinations/{destinationId}/dispatches/zip'.sub('{' + 'destinationId' + '}', destination_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'cssUrl'] = opts[:'css_url'] if !opts[:'css_url'].nil?
  query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/zip'])
  # 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 => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DispatchApi#get_destination_dispatch_zip\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_destination_dispatches(destination_id, opts = {}) ⇒ DispatchListSchema

Get a list of dispatches in this destination Get a list of related dispatches.

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Options Hash (opts):

  • :course_id (String) —

    Only retreive resources having &#x60;courseId&#x60;

  • :more (String) —

    Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.

  • :since (DateTime) —

    Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :_until (DateTime) —

    Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :tags (Array<String>)
  • :datetime_filter (String) —

    A string describing what the since/until parameters will be applied to. Options are: &#39;created&#39; or &#39;updated&#39;. If not provided, it will default to &#x60;updated&#x60;. (default to updated)

  • :order_by (String)

Returns:



703
704
705
706
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 703

def get_destination_dispatches(destination_id, opts = {})
  data, _status_code, _headers = get_destination_dispatches_with_http_info(destination_id, opts)
  data
end

#get_destination_dispatches_with_http_info(destination_id, opts = {}) ⇒ Array<(DispatchListSchema, Fixnum, Hash)>

Get a list of dispatches in this destination Get a list of related dispatches.

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Options Hash (opts):

  • :course_id (String) —

    Only retreive resources having &#x60;courseId&#x60;

  • :more (String) —

    Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.

  • :since (DateTime) —

    Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :_until (DateTime) —

    Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :tags (Array<String>)
  • :datetime_filter (String) —

    A string describing what the since/until parameters will be applied to. Options are: &#39;created&#39; or &#39;updated&#39;. If not provided, it will default to &#x60;updated&#x60;.

  • :order_by (String)

Returns:

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

    DispatchListSchema data, response status code and response headers



720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 720

def get_destination_dispatches_with_http_info(destination_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.get_destination_dispatches ...'
  end
  # verify the required parameter 'destination_id' is set
  if @api_client.config.client_side_validation && destination_id.nil?
    fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination_dispatches"
  end
  if @api_client.config.client_side_validation && opts[:'datetime_filter'] && !['created', 'updated'].include?(opts[:'datetime_filter'])
    fail ArgumentError, 'invalid value for "datetime_filter", must be one of created, updated'
  end
  if @api_client.config.client_side_validation && opts[:'order_by'] && !['updated_asc', 'updated_desc', 'created_asc', 'created_desc'].include?(opts[:'order_by'])
    fail ArgumentError, 'invalid value for "order_by", must be one of updated_asc, updated_desc, created_asc, created_desc'
  end
  # resource path
  local_var_path = '/dispatch/destinations/{destinationId}/dispatches'.sub('{' + 'destinationId' + '}', destination_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'courseId'] = opts[:'course_id'] if !opts[:'course_id'].nil?
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
  query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
  query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?

  # 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 => 'DispatchListSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DispatchApi#get_destination_dispatches\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_destination_hash_user_info(destination_id, opts = {}) ⇒ EnabledSchema

True if the destination is set to hash user info, or false if it is disabled. True if the destination is set to hash user info, or false if it is disabled.

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Returns:



777
778
779
780
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 777

def (destination_id, opts = {})
  data, _status_code, _headers = (destination_id, opts)
  data
end

#get_destination_hash_user_info_with_http_info(destination_id, opts = {}) ⇒ Array<(EnabledSchema, Fixnum, Hash)>

True if the destination is set to hash user info, or false if it is disabled. True if the destination is set to hash user info, or false if it is disabled.

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Returns:

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

    EnabledSchema data, response status code and response headers



787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 787

def (destination_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.get_destination_hash_user_info ...'
  end
  # verify the required parameter 'destination_id' is set
  if @api_client.config.client_side_validation && destination_id.nil?
    fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination_hash_user_info"
  end
  # resource path
  local_var_path = '/dispatch/destinations/{destinationId}/dispatches/hashUserInfo'.sub('{' + 'destinationId' + '}', destination_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: DispatchApi#get_destination_hash_user_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_destination_tags(destination_id, opts = {}) ⇒ TagListSchema

Get the tags for this destination Get the tags for this destination

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Returns:



831
832
833
834
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 831

def get_destination_tags(destination_id, opts = {})
  data, _status_code, _headers = get_destination_tags_with_http_info(destination_id, opts)
  data
end

#get_destination_tags_with_http_info(destination_id, opts = {}) ⇒ Array<(TagListSchema, Fixnum, Hash)>

Get the tags for this destination Get the tags for this destination

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Returns:

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

    TagListSchema data, response status code and response headers



841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 841

def get_destination_tags_with_http_info(destination_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.get_destination_tags ...'
  end
  # verify the required parameter 'destination_id' is set
  if @api_client.config.client_side_validation && destination_id.nil?
    fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination_tags"
  end
  # resource path
  local_var_path = '/dispatch/destinations/{destinationId}/tags'.sub('{' + 'destinationId' + '}', destination_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 => 'TagListSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DispatchApi#get_destination_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_destination_with_http_info(destination_id, opts = {}) ⇒ Array<(DestinationSchema, Fixnum, Hash)>

Get destination information by destinationId. Gets detailed information about a destination belonging to a destinationId.

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Returns:

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

    DestinationSchema data, response status code and response headers



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 532

def get_destination_with_http_info(destination_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.get_destination ...'
  end
  # verify the required parameter 'destination_id' is set
  if @api_client.config.client_side_validation && destination_id.nil?
    fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination"
  end
  # resource path
  local_var_path = '/dispatch/destinations/{destinationId}'.sub('{' + 'destinationId' + '}', destination_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 => 'DestinationSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DispatchApi#get_destination\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_destinations(opts = {}) ⇒ DestinationListSchema

getAllDestinations Get a list of destinations.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :course_id (String) —

    Only retreive resources having &#x60;courseId&#x60;

  • :more (String) —

    Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.

  • :since (DateTime) —

    Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :_until (DateTime) —

    Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :tags (Array<String>)
  • :datetime_filter (String) —

    A string describing what the since/until parameters will be applied to. Options are: &#39;created&#39; or &#39;updated&#39;. If not provided, it will default to &#x60;updated&#x60;. (default to updated)

  • :order_by (String) —

    Optional enum parameter for specifying the field and order by which to sort the results. Defaults to updated_asc (default to updated_asc)

Returns:



891
892
893
894
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 891

def get_destinations(opts = {})
  data, _status_code, _headers = get_destinations_with_http_info(opts)
  data
end

#get_destinations_with_http_info(opts = {}) ⇒ Array<(DestinationListSchema, Fixnum, Hash)>

getAllDestinations Get a list of destinations.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :course_id (String) —

    Only retreive resources having &#x60;courseId&#x60;

  • :more (String) —

    Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.

  • :since (DateTime) —

    Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :_until (DateTime) —

    Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :tags (Array<String>)
  • :datetime_filter (String) —

    A string describing what the since/until parameters will be applied to. Options are: &#39;created&#39; or &#39;updated&#39;. If not provided, it will default to &#x60;updated&#x60;.

  • :order_by (String) —

    Optional enum parameter for specifying the field and order by which to sort the results. Defaults to updated_asc

Returns:

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

    DestinationListSchema data, response status code and response headers



907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 907

def get_destinations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.get_destinations ...'
  end
  if @api_client.config.client_side_validation && opts[:'datetime_filter'] && !['created', 'updated'].include?(opts[:'datetime_filter'])
    fail ArgumentError, 'invalid value for "datetime_filter", must be one of created, updated'
  end
  if @api_client.config.client_side_validation && opts[:'order_by'] && !['updated_asc', 'updated_desc', 'created_asc', 'created_desc'].include?(opts[:'order_by'])
    fail ArgumentError, 'invalid value for "order_by", must be one of updated_asc, updated_desc, created_asc, created_desc'
  end
  # resource path
  local_var_path = '/dispatch/destinations'

  # query parameters
  query_params = {}
  query_params[:'courseId'] = opts[:'course_id'] if !opts[:'course_id'].nil?
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
  query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
  query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?

  # 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 => 'DestinationListSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DispatchApi#get_destinations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_dispatch(dispatch_id, opts = {}) ⇒ DispatchSchema

Get dispatch by id. Get the dispatch with ‘dispatchId`.

Parameters:

  • dispatch_id —

    Identifier for the dispatch

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

    the optional parameters

Returns:



960
961
962
963
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 960

def get_dispatch(dispatch_id, opts = {})
  data, _status_code, _headers = get_dispatch_with_http_info(dispatch_id, opts)
  data
end

#get_dispatch_enabled(dispatch_id, opts = {}) ⇒ EnabledSchema

Get the ‘enabled` status for `dispatchId`. Get the `enabled` status for `dispatchId`. True if the dispatch is enabled, or false if it is disabled.

Parameters:

  • dispatch_id —

    Identifier for the dispatch

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

    the optional parameters

Returns:



1014
1015
1016
1017
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1014

def get_dispatch_enabled(dispatch_id, opts = {})
  data, _status_code, _headers = get_dispatch_enabled_with_http_info(dispatch_id, opts)
  data
end

#get_dispatch_enabled_with_http_info(dispatch_id, opts = {}) ⇒ Array<(EnabledSchema, Fixnum, Hash)>

Get the &#x60;enabled&#x60; status for &#x60;dispatchId&#x60;. Get the &#x60;enabled&#x60; status for &#x60;dispatchId&#x60;. True if the dispatch is enabled, or false if it is disabled.

Parameters:

  • dispatch_id —

    Identifier for the dispatch

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

    the optional parameters

Returns:

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

    EnabledSchema data, response status code and response headers



1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1024

def get_dispatch_enabled_with_http_info(dispatch_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.get_dispatch_enabled ...'
  end
  # verify the required parameter 'dispatch_id' is set
  if @api_client.config.client_side_validation && dispatch_id.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch_enabled"
  end
  # resource path
  local_var_path = '/dispatch/dispatches/{dispatchId}/enabled'.sub('{' + 'dispatchId' + '}', dispatch_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: DispatchApi#get_dispatch_enabled\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_dispatch_hash_user_info(dispatch_id, opts = {}) ⇒ EnabledSchema

Get if this dispatch has PII hashing enabled. Get if this dispatch has PII hashing enabled. True if the dispatch is set to hash user info, or false if it is disabled.

Parameters:

  • dispatch_id —

    Identifier for the dispatch

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

    the optional parameters

Returns:



1068
1069
1070
1071
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1068

def (dispatch_id, opts = {})
  data, _status_code, _headers = (dispatch_id, opts)
  data
end

#get_dispatch_hash_user_info_with_http_info(dispatch_id, opts = {}) ⇒ Array<(EnabledSchema, Fixnum, Hash)>

Get if this dispatch has PII hashing enabled. Get if this dispatch has PII hashing enabled. True if the dispatch is set to hash user info, or false if it is disabled.

Parameters:

  • dispatch_id —

    Identifier for the dispatch

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

    the optional parameters

Returns:

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

    EnabledSchema data, response status code and response headers



1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1078

def (dispatch_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.get_dispatch_hash_user_info ...'
  end
  # verify the required parameter 'dispatch_id' is set
  if @api_client.config.client_side_validation && dispatch_id.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch_hash_user_info"
  end
  # resource path
  local_var_path = '/dispatch/dispatches/{dispatchId}/hashUserInfo'.sub('{' + 'dispatchId' + '}', dispatch_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: DispatchApi#get_dispatch_hash_user_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_dispatch_registration_count(dispatch_id, opts = {}) ⇒ DispatchRegistrationCountSchema

Get the registration count for ‘dispatchId`. Get the registration count for this dispatch, and the date and time of the last count reset, if any.

Parameters:

  • dispatch_id —

    Identifier for the dispatch

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

    the optional parameters

Returns:



1122
1123
1124
1125
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1122

def get_dispatch_registration_count(dispatch_id, opts = {})
  data, _status_code, _headers = get_dispatch_registration_count_with_http_info(dispatch_id, opts)
  data
end

#get_dispatch_registration_count_with_http_info(dispatch_id, opts = {}) ⇒ Array<(DispatchRegistrationCountSchema, Fixnum, Hash)>

Get the registration count for &#x60;dispatchId&#x60;. Get the registration count for this dispatch, and the date and time of the last count reset, if any.

Parameters:

  • dispatch_id —

    Identifier for the dispatch

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

    the optional parameters

Returns:



1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1132

def get_dispatch_registration_count_with_http_info(dispatch_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.get_dispatch_registration_count ...'
  end
  # verify the required parameter 'dispatch_id' is set
  if @api_client.config.client_side_validation && dispatch_id.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch_registration_count"
  end
  # resource path
  local_var_path = '/dispatch/dispatches/{dispatchId}/registrationCount'.sub('{' + 'dispatchId' + '}', dispatch_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 => 'DispatchRegistrationCountSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DispatchApi#get_dispatch_registration_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_dispatch_tags(dispatch_id, opts = {}) ⇒ TagListSchema

Get the tags for this dispatch. Get the tags for this dispatch.

Parameters:

  • dispatch_id —

    Identifier for the dispatch

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

    the optional parameters

Returns:



1176
1177
1178
1179
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1176

def get_dispatch_tags(dispatch_id, opts = {})
  data, _status_code, _headers = get_dispatch_tags_with_http_info(dispatch_id, opts)
  data
end

#get_dispatch_tags_with_http_info(dispatch_id, opts = {}) ⇒ Array<(TagListSchema, Fixnum, Hash)>

Get the tags for this dispatch. Get the tags for this dispatch.

Parameters:

  • dispatch_id —

    Identifier for the dispatch

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

    the optional parameters

Returns:

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

    TagListSchema data, response status code and response headers



1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1186

def get_dispatch_tags_with_http_info(dispatch_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.get_dispatch_tags ...'
  end
  # verify the required parameter 'dispatch_id' is set
  if @api_client.config.client_side_validation && dispatch_id.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch_tags"
  end
  # resource path
  local_var_path = '/dispatch/dispatches/{dispatchId}/tags'.sub('{' + 'dispatchId' + '}', dispatch_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 => 'TagListSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DispatchApi#get_dispatch_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_dispatch_with_http_info(dispatch_id, opts = {}) ⇒ Array<(DispatchSchema, Fixnum, Hash)>

Get dispatch by id. Get the dispatch with &#x60;dispatchId&#x60;.

Parameters:

  • dispatch_id —

    Identifier for the dispatch

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

    the optional parameters

Returns:

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

    DispatchSchema data, response status code and response headers



970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 970

def get_dispatch_with_http_info(dispatch_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.get_dispatch ...'
  end
  # verify the required parameter 'dispatch_id' is set
  if @api_client.config.client_side_validation && dispatch_id.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch"
  end
  # resource path
  local_var_path = '/dispatch/dispatches/{dispatchId}'.sub('{' + 'dispatchId' + '}', dispatch_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 => 'DispatchSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DispatchApi#get_dispatch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_dispatch_zip(dispatch_id, opts = {}) ⇒ File

Get the ZIP for the dispatchId. Get the ZIP for the dispatch with ‘dispatchId`

Parameters:

  • dispatch_id —

    Identifier for the dispatch

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The type of dispatch package to export (SCORM12 only supported in cloud today) (default to SCORM12)

  • :css_url (String)

Returns:

  • (File) 


1232
1233
1234
1235
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1232

def get_dispatch_zip(dispatch_id, opts = {})
  data, _status_code, _headers = get_dispatch_zip_with_http_info(dispatch_id, opts)
  data
end

#get_dispatch_zip_with_http_info(dispatch_id, opts = {}) ⇒ Array<(File, Fixnum, Hash)>

Get the ZIP for the dispatchId. Get the ZIP for the dispatch with &#x60;dispatchId&#x60;

Parameters:

  • dispatch_id —

    Identifier for the dispatch

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

    the optional parameters

Options Hash (opts):

  • :type (String) —

    The type of dispatch package to export (SCORM12 only supported in cloud today)

  • :css_url (String)

Returns:

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

    File data, response status code and response headers



1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1244

def get_dispatch_zip_with_http_info(dispatch_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.get_dispatch_zip ...'
  end
  # verify the required parameter 'dispatch_id' is set
  if @api_client.config.client_side_validation && dispatch_id.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch_zip"
  end
  if @api_client.config.client_side_validation && opts[:'type'] && !['SCORM12'].include?(opts[:'type'])
    fail ArgumentError, 'invalid value for "type", must be one of SCORM12'
  end
  # resource path
  local_var_path = '/dispatch/dispatches/{dispatchId}/zip'.sub('{' + 'dispatchId' + '}', dispatch_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'cssUrl'] = opts[:'css_url'] if !opts[:'css_url'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/zip'])
  # 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 => 'File')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DispatchApi#get_dispatch_zip\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_dispatches(opts = {}) ⇒ DispatchListSchema

All Dispatches in the system for an AppId Get a list of dispatches.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :course_id (String) —

    Only retreive resources having &#x60;courseId&#x60;

  • :more (String) —

    Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.

  • :since (DateTime) —

    Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :_until (DateTime) —

    Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :tags (Array<String>)
  • :datetime_filter (String) —

    A string describing what the since/until parameters will be applied to. Options are: &#39;created&#39; or &#39;updated&#39;. If not provided, it will default to &#x60;updated&#x60;. (default to updated)

  • :order_by (String) —

    Optional enum parameter for specifying the field and order by which to sort the results. Defaults to updated_asc (default to updated_asc)

Returns:



1299
1300
1301
1302
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1299

def get_dispatches(opts = {})
  data, _status_code, _headers = get_dispatches_with_http_info(opts)
  data
end

#get_dispatches_with_http_info(opts = {}) ⇒ Array<(DispatchListSchema, Fixnum, Hash)>

All Dispatches in the system for an AppId Get a list of dispatches.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :course_id (String) —

    Only retreive resources having &#x60;courseId&#x60;

  • :more (String) —

    Value for this parameter will be provided in the &#39;more&#39; property of registration lists, where needed. An opaque value, construction and parsing may change without notice.

  • :since (DateTime) —

    Only items updated since the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :_until (DateTime) —

    Only items updated before the specified ISO 8601 TimeStamp (inclusive) are included. If a time zone is not specified, UTC time zone will be used.

  • :tags (Array<String>)
  • :datetime_filter (String) —

    A string describing what the since/until parameters will be applied to. Options are: &#39;created&#39; or &#39;updated&#39;. If not provided, it will default to &#x60;updated&#x60;.

  • :order_by (String) —

    Optional enum parameter for specifying the field and order by which to sort the results. Defaults to updated_asc

Returns:

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

    DispatchListSchema data, response status code and response headers



1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1315

def get_dispatches_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.get_dispatches ...'
  end
  if @api_client.config.client_side_validation && opts[:'datetime_filter'] && !['created', 'updated'].include?(opts[:'datetime_filter'])
    fail ArgumentError, 'invalid value for "datetime_filter", must be one of created, updated'
  end
  if @api_client.config.client_side_validation && opts[:'order_by'] && !['updated_asc', 'updated_desc', 'created_asc', 'created_desc'].include?(opts[:'order_by'])
    fail ArgumentError, 'invalid value for "order_by", must be one of updated_asc, updated_desc, created_asc, created_desc'
  end
  # resource path
  local_var_path = '/dispatch/dispatches'

  # query parameters
  query_params = {}
  query_params[:'courseId'] = opts[:'course_id'] if !opts[:'course_id'].nil?
  query_params[:'more'] = opts[:'more'] if !opts[:'more'].nil?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
  query_params[:'until'] = opts[:'_until'] if !opts[:'_until'].nil?
  query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :csv) if !opts[:'tags'].nil?
  query_params[:'datetimeFilter'] = opts[:'datetime_filter'] if !opts[:'datetime_filter'].nil?
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?

  # 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 => 'DispatchListSchema')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DispatchApi#get_dispatches\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_destination_tags(destination_id, tags, opts = {}) ⇒ nil

Set the tags for this destination Set the tags for this destination

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Returns:

  • (nil) 


1369
1370
1371
1372
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1369

def put_destination_tags(destination_id, tags, opts = {})
  put_destination_tags_with_http_info(destination_id, tags, opts)
  nil
end

#put_destination_tags_batch(batch, opts = {}) ⇒ nil

Sets all of the provided tags on all of the provided destinations Sets all of the provided tags on all of the provided destinations

Parameters:

  • batch —

    Object representing an array of ids to apply an array of tags to.

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

    the optional parameters

Returns:

  • (nil) 


1427
1428
1429
1430
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1427

def put_destination_tags_batch(batch, opts = {})
  put_destination_tags_batch_with_http_info(batch, opts)
  nil
end

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

Sets all of the provided tags on all of the provided destinations Sets all of the provided tags on all of the provided destinations

Parameters:

  • batch —

    Object representing an array of ids to apply an array of tags to.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1437

def put_destination_tags_batch_with_http_info(batch, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.put_destination_tags_batch ...'
  end
  # verify the required parameter 'batch' is set
  if @api_client.config.client_side_validation && batch.nil?
    fail ArgumentError, "Missing the required parameter 'batch' when calling DispatchApi.put_destination_tags_batch"
  end
  # resource path
  local_var_path = '/dispatch/destinations/tags'

  # 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(batch)
  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: DispatchApi#put_destination_tags_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_destination_tags_with_http_info(destination_id, tags, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Set the tags for this destination Set the tags for this destination

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1380

def put_destination_tags_with_http_info(destination_id, tags, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.put_destination_tags ...'
  end
  # verify the required parameter 'destination_id' is set
  if @api_client.config.client_side_validation && destination_id.nil?
    fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.put_destination_tags"
  end
  # verify the required parameter 'tags' is set
  if @api_client.config.client_side_validation && tags.nil?
    fail ArgumentError, "Missing the required parameter 'tags' when calling DispatchApi.put_destination_tags"
  end
  # resource path
  local_var_path = '/dispatch/destinations/{destinationId}/tags'.sub('{' + 'destinationId' + '}', destination_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(tags)
  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: DispatchApi#put_destination_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_dispatch_tags(dispatch_id, tags, opts = {}) ⇒ nil

Set the tags for this dispatch. Set the tags for this dispatch.

Parameters:

  • dispatch_id —

    Identifier for the dispatch

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

    the optional parameters

Returns:

  • (nil) 


1481
1482
1483
1484
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1481

def put_dispatch_tags(dispatch_id, tags, opts = {})
  put_dispatch_tags_with_http_info(dispatch_id, tags, opts)
  nil
end

#put_dispatch_tags_batch(batch, opts = {}) ⇒ nil

Sets all of the provided tags on all of the provided dispatches Sets all of the provided tags on all of the provided dispatches

Parameters:

  • batch —

    Object representing an array of ids to apply an array of tags to.

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

    the optional parameters

Returns:

  • (nil) 


1539
1540
1541
1542
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1539

def put_dispatch_tags_batch(batch, opts = {})
  put_dispatch_tags_batch_with_http_info(batch, opts)
  nil
end

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

Sets all of the provided tags on all of the provided dispatches Sets all of the provided tags on all of the provided dispatches

Parameters:

  • batch —

    Object representing an array of ids to apply an array of tags to.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1549

def put_dispatch_tags_batch_with_http_info(batch, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.put_dispatch_tags_batch ...'
  end
  # verify the required parameter 'batch' is set
  if @api_client.config.client_side_validation && batch.nil?
    fail ArgumentError, "Missing the required parameter 'batch' when calling DispatchApi.put_dispatch_tags_batch"
  end
  # resource path
  local_var_path = '/dispatch/dispatches/tags'

  # 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(batch)
  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: DispatchApi#put_dispatch_tags_batch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_dispatch_tags_with_http_info(dispatch_id, tags, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Set the tags for this dispatch. Set the tags for this dispatch.

Parameters:

  • dispatch_id —

    Identifier for the dispatch

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1492

def put_dispatch_tags_with_http_info(dispatch_id, tags, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.put_dispatch_tags ...'
  end
  # verify the required parameter 'dispatch_id' is set
  if @api_client.config.client_side_validation && dispatch_id.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.put_dispatch_tags"
  end
  # verify the required parameter 'tags' is set
  if @api_client.config.client_side_validation && tags.nil?
    fail ArgumentError, "Missing the required parameter 'tags' when calling DispatchApi.put_dispatch_tags"
  end
  # resource path
  local_var_path = '/dispatch/dispatches/{dispatchId}/tags'.sub('{' + 'dispatchId' + '}', dispatch_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(tags)
  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: DispatchApi#put_dispatch_tags\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#reset_destination_dispatch_registration_count(destination_id, opts = {}) ⇒ nil

DestinationsDispatchesRegistrationCount Reset registration counts for all related dispatches.

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Returns:

  • (nil) 


1592
1593
1594
1595
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1592

def reset_destination_dispatch_registration_count(destination_id, opts = {})
  reset_destination_dispatch_registration_count_with_http_info(destination_id, opts)
  nil
end

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

DestinationsDispatchesRegistrationCount Reset registration counts for all related dispatches.

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1602

def reset_destination_dispatch_registration_count_with_http_info(destination_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.reset_destination_dispatch_registration_count ...'
  end
  # verify the required parameter 'destination_id' is set
  if @api_client.config.client_side_validation && destination_id.nil?
    fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.reset_destination_dispatch_registration_count"
  end
  # resource path
  local_var_path = '/dispatch/destinations/{destinationId}/dispatches/registrationCount'.sub('{' + 'destinationId' + '}', destination_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: DispatchApi#reset_destination_dispatch_registration_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#reset_dispatch_registration_count(dispatch_id, opts = {}) ⇒ nil

Reset registration count. Reset the registration count for this dispatch.

Parameters:

  • dispatch_id —

    Identifier for the dispatch

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

    the optional parameters

Returns:

  • (nil) 


1645
1646
1647
1648
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1645

def reset_dispatch_registration_count(dispatch_id, opts = {})
  reset_dispatch_registration_count_with_http_info(dispatch_id, opts)
  nil
end

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

Reset registration count. Reset the registration count for this dispatch.

Parameters:

  • dispatch_id —

    Identifier for the dispatch

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1655

def reset_dispatch_registration_count_with_http_info(dispatch_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.reset_dispatch_registration_count ...'
  end
  # verify the required parameter 'dispatch_id' is set
  if @api_client.config.client_side_validation && dispatch_id.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.reset_dispatch_registration_count"
  end
  # resource path
  local_var_path = '/dispatch/dispatches/{dispatchId}/registrationCount'.sub('{' + 'dispatchId' + '}', dispatch_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: DispatchApi#reset_dispatch_registration_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_destination(destination_id, destination, opts = {}) ⇒ nil

Creates or updates the destination identified by the ‘destinationId` provided in the path. If the destination is being created, a name should be provided in the DestinationSchema, else an error will be thrown. You may also optionally supply the e-mail address of the user to be associated with this destination. This e-mail address should correspond to a SCORM Cloud user account. If you do not supply an e-mail address upon the creation of a destination, the owner of the Realm will be used. This can, of course, also be changed via calling this method to update an existing destination.

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Returns:

  • (nil) 


1698
1699
1700
1701
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1698

def set_destination(destination_id, destination, opts = {})
  set_destination_with_http_info(destination_id, destination, opts)
  nil
end

#set_destination_dispatch_enabled(destination_id, enabled, opts = {}) ⇒ nil

DestinationsDispatchesEnabledByTenant Enable or disable all related dispatches.

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Returns:

  • (nil) 


1756
1757
1758
1759
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1756

def set_destination_dispatch_enabled(destination_id, enabled, opts = {})
  set_destination_dispatch_enabled_with_http_info(destination_id, enabled, opts)
  nil
end

#set_destination_dispatch_enabled_with_http_info(destination_id, enabled, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

DestinationsDispatchesEnabledByTenant Enable or disable all related dispatches.

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1767

def set_destination_dispatch_enabled_with_http_info(destination_id, enabled, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.set_destination_dispatch_enabled ...'
  end
  # verify the required parameter 'destination_id' is set
  if @api_client.config.client_side_validation && destination_id.nil?
    fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.set_destination_dispatch_enabled"
  end
  # verify the required parameter 'enabled' is set
  if @api_client.config.client_side_validation && enabled.nil?
    fail ArgumentError, "Missing the required parameter 'enabled' when calling DispatchApi.set_destination_dispatch_enabled"
  end
  # resource path
  local_var_path = '/dispatch/destinations/{destinationId}/dispatches/enabled'.sub('{' + 'destinationId' + '}', destination_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(enabled)
  auth_names = ['APP_NORMAL', 'OAUTH']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DispatchApi#set_destination_dispatch_enabled\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_destination_with_http_info(destination_id, destination, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Creates or updates the destination identified by the &#x60;destinationId&#x60; provided in the path. If the destination is being created, a name should be provided in the DestinationSchema, else an error will be thrown. You may also optionally supply the e-mail address of the user to be associated with this destination. This e-mail address should correspond to a SCORM Cloud user account. If you do not supply an e-mail address upon the creation of a destination, the owner of the Realm will be used. This can, of course, also be changed via calling this method to update an existing destination.

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1708

def set_destination_with_http_info(destination_id, destination, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.set_destination ...'
  end
  # verify the required parameter 'destination_id' is set
  if @api_client.config.client_side_validation && destination_id.nil?
    fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.set_destination"
  end
  # verify the required parameter 'destination' is set
  if @api_client.config.client_side_validation && destination.nil?
    fail ArgumentError, "Missing the required parameter 'destination' when calling DispatchApi.set_destination"
  end
  # resource path
  local_var_path = '/dispatch/destinations/{destinationId}'.sub('{' + 'destinationId' + '}', destination_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(destination)
  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: DispatchApi#set_destination\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_dispatch_enabled(dispatch_id, enabled, opts = {}) ⇒ nil

Set the ‘enabled` status for `dispatchId`. Set the `enabled` status for `dispatchId`.

Parameters:

  • dispatch_id —

    Identifier for the dispatch

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

    the optional parameters

Returns:

  • (nil) 


1815
1816
1817
1818
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1815

def set_dispatch_enabled(dispatch_id, enabled, opts = {})
  set_dispatch_enabled_with_http_info(dispatch_id, enabled, opts)
  nil
end

#set_dispatch_enabled_with_http_info(dispatch_id, enabled, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Set the &#x60;enabled&#x60; status for &#x60;dispatchId&#x60;. Set the &#x60;enabled&#x60; status for &#x60;dispatchId&#x60;.

Parameters:

  • dispatch_id —

    Identifier for the dispatch

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1826

def set_dispatch_enabled_with_http_info(dispatch_id, enabled, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.set_dispatch_enabled ...'
  end
  # verify the required parameter 'dispatch_id' is set
  if @api_client.config.client_side_validation && dispatch_id.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.set_dispatch_enabled"
  end
  # verify the required parameter 'enabled' is set
  if @api_client.config.client_side_validation && enabled.nil?
    fail ArgumentError, "Missing the required parameter 'enabled' when calling DispatchApi.set_dispatch_enabled"
  end
  # resource path
  local_var_path = '/dispatch/dispatches/{dispatchId}/enabled'.sub('{' + 'dispatchId' + '}', dispatch_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(enabled)
  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: DispatchApi#set_dispatch_enabled\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_destination_hash_user_info(destination_id, enabled, opts = {}) ⇒ nil

Enable or disable hashing of the user info for the destination. Enable or disable hashing of the user info for the destination.

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Returns:

  • (nil) 


1874
1875
1876
1877
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1874

def (destination_id, enabled, opts = {})
  (destination_id, enabled, opts)
  nil
end

#update_destination_hash_user_info_with_http_info(destination_id, enabled, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Enable or disable hashing of the user info for the destination. Enable or disable hashing of the user info for the destination.

Parameters:

  • destination_id —

    Identifier for the destination

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1885

def (destination_id, enabled, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.update_destination_hash_user_info ...'
  end
  # verify the required parameter 'destination_id' is set
  if @api_client.config.client_side_validation && destination_id.nil?
    fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.update_destination_hash_user_info"
  end
  # verify the required parameter 'enabled' is set
  if @api_client.config.client_side_validation && enabled.nil?
    fail ArgumentError, "Missing the required parameter 'enabled' when calling DispatchApi.update_destination_hash_user_info"
  end
  # resource path
  local_var_path = '/dispatch/destinations/{destinationId}/dispatches/hashUserInfo'.sub('{' + 'destinationId' + '}', destination_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(enabled)
  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: DispatchApi#update_destination_hash_user_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_dispatch(dispatch_id, dispatch_properties, opts = {}) ⇒ nil

Update the dispatch with ‘dispatchId`. Update the dispatch with `dispatchId`.

Parameters:

  • dispatch_id —

    Identifier for the dispatch

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

    the optional parameters

Returns:

  • (nil) 


1933
1934
1935
1936
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1933

def update_dispatch(dispatch_id, dispatch_properties, opts = {})
  update_dispatch_with_http_info(dispatch_id, dispatch_properties, opts)
  nil
end

#update_dispatch_hash_user_info(dispatch_id, enabled, opts = {}) ⇒ nil

Enable or disable hashing of the user info for the dispatch. Enable or disable hashing of the user info for the dispatch.

Parameters:

  • dispatch_id —

    Identifier for the dispatch

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

    the optional parameters

Returns:

  • (nil) 


1992
1993
1994
1995
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1992

def (dispatch_id, enabled, opts = {})
  (dispatch_id, enabled, opts)
  nil
end

#update_dispatch_hash_user_info_with_http_info(dispatch_id, enabled, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Enable or disable hashing of the user info for the dispatch. Enable or disable hashing of the user info for the dispatch.

Parameters:

  • dispatch_id —

    Identifier for the dispatch

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 2003

def (dispatch_id, enabled, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.update_dispatch_hash_user_info ...'
  end
  # verify the required parameter 'dispatch_id' is set
  if @api_client.config.client_side_validation && dispatch_id.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.update_dispatch_hash_user_info"
  end
  # verify the required parameter 'enabled' is set
  if @api_client.config.client_side_validation && enabled.nil?
    fail ArgumentError, "Missing the required parameter 'enabled' when calling DispatchApi.update_dispatch_hash_user_info"
  end
  # resource path
  local_var_path = '/dispatch/dispatches/{dispatchId}/hashUserInfo'.sub('{' + 'dispatchId' + '}', dispatch_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(enabled)
  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: DispatchApi#update_dispatch_hash_user_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_dispatch_with_http_info(dispatch_id, dispatch_properties, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update the dispatch with &#x60;dispatchId&#x60;. Update the dispatch with &#x60;dispatchId&#x60;.

Parameters:

  • dispatch_id —

    Identifier for the dispatch

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1944

def update_dispatch_with_http_info(dispatch_id, dispatch_properties, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DispatchApi.update_dispatch ...'
  end
  # verify the required parameter 'dispatch_id' is set
  if @api_client.config.client_side_validation && dispatch_id.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.update_dispatch"
  end
  # verify the required parameter 'dispatch_properties' is set
  if @api_client.config.client_side_validation && dispatch_properties.nil?
    fail ArgumentError, "Missing the required parameter 'dispatch_properties' when calling DispatchApi.update_dispatch"
  end
  # resource path
  local_var_path = '/dispatch/dispatches/{dispatchId}'.sub('{' + 'dispatchId' + '}', dispatch_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(dispatch_properties)
  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: DispatchApi#update_dispatch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end