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.



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



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

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)
  return 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
 
# 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
  fail ArgumentError, "Missing the required parameter 'destinations_list' when calling DispatchApi.create_destinations" if destinations_list.nil?
  # resource path
  local_var_path = "/dispatch/destinations".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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) 


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

def create_dispatches(dispatch_list, opts = {})
  create_dispatches_with_http_info(dispatch_list, opts)
  return 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



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

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
  fail ArgumentError, "Missing the required parameter 'dispatch_list' when calling DispatchApi.create_dispatches" if dispatch_list.nil?
  # resource path
  local_var_path = "/dispatch/dispatches".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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) 


131
132
133
134
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 131

def delete_destination(destination_id, opts = {})
  delete_destination_with_http_info(destination_id, opts)
  return 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) 


183
184
185
186
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 183

def delete_destination_dispatches(destination_id, opts = {})
  delete_destination_dispatches_with_http_info(destination_id, opts)
  return 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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 193

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
  fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.delete_destination_dispatches" if destination_id.nil?
  # resource path
  local_var_path = "/dispatch/destinations/{destinationId}/dispatches".sub('{format}','json').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) 


236
237
238
239
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 236

def delete_destination_tags(destination_id, tags, opts = {})
  delete_destination_tags_with_http_info(destination_id, tags, opts)
  return 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



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 247

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
  fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.delete_destination_tags" if destination_id.nil?
  # verify the required parameter 'tags' is set
  fail ArgumentError, "Missing the required parameter 'tags' when calling DispatchApi.delete_destination_tags" if tags.nil?
  # resource path
  local_var_path = "/dispatch/destinations/{destinationId}/tags".sub('{format}','json').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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 141

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
  fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.delete_destination" if destination_id.nil?
  # resource path
  local_var_path = "/dispatch/destinations/{destinationId}".sub('{format}','json').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) 


291
292
293
294
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 291

def delete_dispatch(dispatch_id, opts = {})
  delete_dispatch_with_http_info(dispatch_id, opts)
  return 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) 


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

def delete_dispatch_postback_info(dispatch_id, opts = {})
  delete_dispatch_postback_info_with_http_info(dispatch_id, opts)
  return 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



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 353

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
  fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.delete_dispatch_postback_info" if dispatch_id.nil?
  # resource path
  local_var_path = "/dispatch/dispatches/{dispatchId}/postback".sub('{format}','json').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) 


396
397
398
399
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 396

def delete_dispatch_tags(dispatch_id, tags, opts = {})
  delete_dispatch_tags_with_http_info(dispatch_id, tags, opts)
  return 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



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 407

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
  fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.delete_dispatch_tags" if dispatch_id.nil?
  # verify the required parameter 'tags' is set
  fail ArgumentError, "Missing the required parameter 'tags' when calling DispatchApi.delete_dispatch_tags" if tags.nil?
  # resource path
  local_var_path = "/dispatch/dispatches/{dispatchId}/tags".sub('{format}','json').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



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 301

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
  fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.delete_dispatch" if dispatch_id.nil?
  # resource path
  local_var_path = "/dispatch/dispatches/{dispatchId}".sub('{format}','json').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) 


452
453
454
455
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 452

def enable_registration_instancing(destination_id, enabled, opts = {})
  enable_registration_instancing_with_http_info(destination_id, enabled, opts)
  return 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



463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 463

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
  fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.enable_registration_instancing" if destination_id.nil?
  # verify the required parameter 'enabled' is set
  fail ArgumentError, "Missing the required parameter 'enabled' when calling DispatchApi.enable_registration_instancing" if enabled.nil?
  # resource path
  local_var_path = "/dispatch/destinations/{destinationId}/dispatches/registrationInstancing".sub('{format}','json').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:



507
508
509
510
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 507

def get_destination(destination_id, opts = {})
  data, _status_code, _headers = get_destination_with_http_info(destination_id, opts)
  return 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:



560
561
562
563
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 560

def get_destination_dispatch_registration_count(destination_id, opts = {})
  data, _status_code, _headers = get_destination_dispatch_registration_count_with_http_info(destination_id, opts)
  return 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



570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 570

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
  fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination_dispatch_registration_count" if destination_id.nil?
  # resource path
  local_var_path = "/dispatch/destinations/{destinationId}/dispatches/registrationCount".sub('{format}','json').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) 


616
617
618
619
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 616

def get_destination_dispatch_zip(destination_id, opts = {})
  data, _status_code, _headers = get_destination_dispatch_zip_with_http_info(destination_id, opts)
  return 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



629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
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
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 629

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
  fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination_dispatch_zip" if destination_id.nil?
  if 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('{format}','json').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:



685
686
687
688
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 685

def get_destination_dispatches(destination_id, opts = {})
  data, _status_code, _headers = get_destination_dispatches_with_http_info(destination_id, opts)
  return 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



702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
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
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 702

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
  fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination_dispatches" if destination_id.nil?
  if opts[:'datetime_filter'] && !['created', 'updated'].include?(opts[:'datetime_filter'])
    fail ArgumentError, 'invalid value for "datetime_filter", must be one of created, updated'
  end
  if 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('{format}','json').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:



758
759
760
761
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 758

def (destination_id, opts = {})
  data, _status_code, _headers = (destination_id, opts)
  return 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



768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 768

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
  fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination_hash_user_info" if destination_id.nil?
  # resource path
  local_var_path = "/dispatch/destinations/{destinationId}/dispatches/hashUserInfo".sub('{format}','json').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:



811
812
813
814
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 811

def get_destination_tags(destination_id, opts = {})
  data, _status_code, _headers = get_destination_tags_with_http_info(destination_id, opts)
  return 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



821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 821

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
  fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination_tags" if destination_id.nil?
  # resource path
  local_var_path = "/dispatch/destinations/{destinationId}/tags".sub('{format}','json').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



517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 517

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
  fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.get_destination" if destination_id.nil?
  # resource path
  local_var_path = "/dispatch/destinations/{destinationId}".sub('{format}','json').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:



870
871
872
873
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 870

def get_destinations(opts = {})
  data, _status_code, _headers = get_destinations_with_http_info(opts)
  return 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



886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
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
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 886

def get_destinations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DispatchApi.get_destinations ..."
  end
  if opts[:'datetime_filter'] && !['created', 'updated'].include?(opts[:'datetime_filter'])
    fail ArgumentError, 'invalid value for "datetime_filter", must be one of created, updated'
  end
  if 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".sub('{format}','json')

  # 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:



940
941
942
943
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 940

def get_dispatch(dispatch_id, opts = {})
  data, _status_code, _headers = get_dispatch_with_http_info(dispatch_id, opts)
  return 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:



993
994
995
996
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 993

def get_dispatch_enabled(dispatch_id, opts = {})
  data, _status_code, _headers = get_dispatch_enabled_with_http_info(dispatch_id, opts)
  return 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



1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1003

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
  fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch_enabled" if dispatch_id.nil?
  # resource path
  local_var_path = "/dispatch/dispatches/{dispatchId}/enabled".sub('{format}','json').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:



1046
1047
1048
1049
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1046

def (dispatch_id, opts = {})
  data, _status_code, _headers = (dispatch_id, opts)
  return 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



1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1056

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
  fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch_hash_user_info" if dispatch_id.nil?
  # resource path
  local_var_path = "/dispatch/dispatches/{dispatchId}/hashUserInfo".sub('{format}','json').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:



1099
1100
1101
1102
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1099

def get_dispatch_registration_count(dispatch_id, opts = {})
  data, _status_code, _headers = get_dispatch_registration_count_with_http_info(dispatch_id, opts)
  return 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:



1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1109

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
  fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch_registration_count" if dispatch_id.nil?
  # resource path
  local_var_path = "/dispatch/dispatches/{dispatchId}/registrationCount".sub('{format}','json').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:



1152
1153
1154
1155
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1152

def get_dispatch_tags(dispatch_id, opts = {})
  data, _status_code, _headers = get_dispatch_tags_with_http_info(dispatch_id, opts)
  return 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



1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1162

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
  fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch_tags" if dispatch_id.nil?
  # resource path
  local_var_path = "/dispatch/dispatches/{dispatchId}/tags".sub('{format}','json').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



950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 950

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
  fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch" if dispatch_id.nil?
  # resource path
  local_var_path = "/dispatch/dispatches/{dispatchId}".sub('{format}','json').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) 


1207
1208
1209
1210
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1207

def get_dispatch_zip(dispatch_id, opts = {})
  data, _status_code, _headers = get_dispatch_zip_with_http_info(dispatch_id, opts)
  return 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



1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1219

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
  fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.get_dispatch_zip" if dispatch_id.nil?
  if 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('{format}','json').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:



1273
1274
1275
1276
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1273

def get_dispatches(opts = {})
  data, _status_code, _headers = get_dispatches_with_http_info(opts)
  return 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



1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1289

def get_dispatches_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DispatchApi.get_dispatches ..."
  end
  if opts[:'datetime_filter'] && !['created', 'updated'].include?(opts[:'datetime_filter'])
    fail ArgumentError, 'invalid value for "datetime_filter", must be one of created, updated'
  end
  if 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".sub('{format}','json')

  # 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) 


1344
1345
1346
1347
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1344

def put_destination_tags(destination_id, tags, opts = {})
  put_destination_tags_with_http_info(destination_id, tags, opts)
  return 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) 


1399
1400
1401
1402
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1399

def put_destination_tags_batch(batch, opts = {})
  put_destination_tags_batch_with_http_info(batch, opts)
  return 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



1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1409

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
  fail ArgumentError, "Missing the required parameter 'batch' when calling DispatchApi.put_destination_tags_batch" if batch.nil?
  # resource path
  local_var_path = "/dispatch/destinations/tags".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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



1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1355

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
  fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.put_destination_tags" if destination_id.nil?
  # verify the required parameter 'tags' is set
  fail ArgumentError, "Missing the required parameter 'tags' when calling DispatchApi.put_destination_tags" if tags.nil?
  # resource path
  local_var_path = "/dispatch/destinations/{destinationId}/tags".sub('{format}','json').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) 


1452
1453
1454
1455
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1452

def put_dispatch_tags(dispatch_id, tags, opts = {})
  put_dispatch_tags_with_http_info(dispatch_id, tags, opts)
  return 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) 


1507
1508
1509
1510
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1507

def put_dispatch_tags_batch(batch, opts = {})
  put_dispatch_tags_batch_with_http_info(batch, opts)
  return 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



1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1517

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
  fail ArgumentError, "Missing the required parameter 'batch' when calling DispatchApi.put_dispatch_tags_batch" if batch.nil?
  # resource path
  local_var_path = "/dispatch/dispatches/tags".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(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



1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1463

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
  fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.put_dispatch_tags" if dispatch_id.nil?
  # verify the required parameter 'tags' is set
  fail ArgumentError, "Missing the required parameter 'tags' when calling DispatchApi.put_dispatch_tags" if tags.nil?
  # resource path
  local_var_path = "/dispatch/dispatches/{dispatchId}/tags".sub('{format}','json').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) 


1559
1560
1561
1562
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1559

def reset_destination_dispatch_registration_count(destination_id, opts = {})
  reset_destination_dispatch_registration_count_with_http_info(destination_id, opts)
  return 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



1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1569

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
  fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.reset_destination_dispatch_registration_count" if destination_id.nil?
  # resource path
  local_var_path = "/dispatch/destinations/{destinationId}/dispatches/registrationCount".sub('{format}','json').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) 


1611
1612
1613
1614
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1611

def reset_dispatch_registration_count(dispatch_id, opts = {})
  reset_dispatch_registration_count_with_http_info(dispatch_id, opts)
  return 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



1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1621

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
  fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.reset_dispatch_registration_count" if dispatch_id.nil?
  # resource path
  local_var_path = "/dispatch/dispatches/{dispatchId}/registrationCount".sub('{format}','json').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) 


1664
1665
1666
1667
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1664

def set_destination(destination_id, destination, opts = {})
  set_destination_with_http_info(destination_id, destination, opts)
  return 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) 


1720
1721
1722
1723
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1720

def set_destination_dispatch_enabled(destination_id, enabled, opts = {})
  set_destination_dispatch_enabled_with_http_info(destination_id, enabled, opts)
  return 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



1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1731

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
  fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.set_destination_dispatch_enabled" if destination_id.nil?
  # verify the required parameter 'enabled' is set
  fail ArgumentError, "Missing the required parameter 'enabled' when calling DispatchApi.set_destination_dispatch_enabled" if enabled.nil?
  # resource path
  local_var_path = "/dispatch/destinations/{destinationId}/dispatches/enabled".sub('{format}','json').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



1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1675

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
  fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.set_destination" if destination_id.nil?
  # verify the required parameter 'destination' is set
  fail ArgumentError, "Missing the required parameter 'destination' when calling DispatchApi.set_destination" if destination.nil?
  # resource path
  local_var_path = "/dispatch/destinations/{destinationId}".sub('{format}','json').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) 


1776
1777
1778
1779
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1776

def set_dispatch_enabled(dispatch_id, enabled, opts = {})
  set_dispatch_enabled_with_http_info(dispatch_id, enabled, opts)
  return 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



1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1787

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
  fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.set_dispatch_enabled" if dispatch_id.nil?
  # verify the required parameter 'enabled' is set
  fail ArgumentError, "Missing the required parameter 'enabled' when calling DispatchApi.set_dispatch_enabled" if enabled.nil?
  # resource path
  local_var_path = "/dispatch/dispatches/{dispatchId}/enabled".sub('{format}','json').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) 


1832
1833
1834
1835
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1832

def (destination_id, enabled, opts = {})
  (destination_id, enabled, opts)
  return 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



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
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1843

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
  fail ArgumentError, "Missing the required parameter 'destination_id' when calling DispatchApi.update_destination_hash_user_info" if destination_id.nil?
  # verify the required parameter 'enabled' is set
  fail ArgumentError, "Missing the required parameter 'enabled' when calling DispatchApi.update_destination_hash_user_info" if enabled.nil?
  # resource path
  local_var_path = "/dispatch/destinations/{destinationId}/dispatches/hashUserInfo".sub('{format}','json').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) 


1888
1889
1890
1891
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1888

def update_dispatch(dispatch_id, dispatch_properties, opts = {})
  update_dispatch_with_http_info(dispatch_id, dispatch_properties, opts)
  return 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) 


1944
1945
1946
1947
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1944

def (dispatch_id, enabled, opts = {})
  (dispatch_id, enabled, opts)
  return 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



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
1986
1987
1988
1989
1990
1991
1992
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1955

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
  fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.update_dispatch_hash_user_info" if dispatch_id.nil?
  # verify the required parameter 'enabled' is set
  fail ArgumentError, "Missing the required parameter 'enabled' when calling DispatchApi.update_dispatch_hash_user_info" if enabled.nil?
  # resource path
  local_var_path = "/dispatch/dispatches/{dispatchId}/hashUserInfo".sub('{format}','json').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



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
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
 
# File 'lib/rustici_software_cloud_v2/api/dispatch_api.rb', line 1899

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
  fail ArgumentError, "Missing the required parameter 'dispatch_id' when calling DispatchApi.update_dispatch" if dispatch_id.nil?
  # verify the required parameter 'dispatch_properties' is set
  fail ArgumentError, "Missing the required parameter 'dispatch_properties' when calling DispatchApi.update_dispatch" if dispatch_properties.nil?
  # resource path
  local_var_path = "/dispatch/dispatches/{dispatchId}".sub('{format}','json').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