Class: PureCloud::RoutingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudclient_v2a/api/routing_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RoutingApi

Returns a new instance of RoutingApi.



23
24
25
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 23

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



21
22
23
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_routing_email_domain(domain_id, opts = {}) ⇒ nil

Delete a domain

Parameters:

  • domain_id —

    domain ID

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

    the optional parameters

Returns:

  • (nil) 


32
33
34
35
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 32

def delete_routing_email_domain(domain_id, opts = {})
  delete_routing_email_domain_with_http_info(domain_id, opts)
  return nil
end

#delete_routing_email_domain_route(domain_name, route_id, opts = {}) ⇒ nil

Delete a route

Parameters:

  • domain_name —

    email domain

  • route_id —

    route ID

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

    the optional parameters

Returns:

  • (nil) 


97
98
99
100
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 97

def delete_routing_email_domain_route(domain_name, route_id, opts = {})
  delete_routing_email_domain_route_with_http_info(domain_name, route_id, opts)
  return nil
end

#delete_routing_email_domain_route_with_http_info(domain_name, route_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a route

Parameters:

  • domain_name —

    email domain

  • route_id —

    route ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 108

def delete_routing_email_domain_route_with_http_info(domain_name, route_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.delete_routing_email_domain_route ..."
  end
  
  
  # verify the required parameter 'domain_name' is set
  fail ArgumentError, "Missing the required parameter 'domain_name' when calling RoutingApi.delete_routing_email_domain_route" if domain_name.nil?
  
  
  
  
  
  
  # verify the required parameter 'route_id' is set
  fail ArgumentError, "Missing the required parameter 'route_id' when calling RoutingApi.delete_routing_email_domain_route" if route_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/email/domains/{domainName}/routes/{routeId}".sub('{format}','json').sub('{' + 'domainName' + '}', domain_name.to_s).sub('{' + 'routeId' + '}', route_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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: RoutingApi#delete_routing_email_domain_route\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete a domain

Parameters:

  • domain_id —

    domain ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 42

def delete_routing_email_domain_with_http_info(domain_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.delete_routing_email_domain ..."
  end
  
  
  # verify the required parameter 'domain_id' is set
  fail ArgumentError, "Missing the required parameter 'domain_id' when calling RoutingApi.delete_routing_email_domain" if domain_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/email/domains/{domainId}".sub('{format}','json').sub('{' + 'domainId' + '}', domain_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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: RoutingApi#delete_routing_email_domain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_routing_queue(queue_id, opts = {}) ⇒ nil

Delete a queue

Parameters:

  • queue_id —

    Queue ID

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

    the optional parameters

Options Hash (opts):

  • :force_delete (BOOLEAN) —

    forceDelete

Returns:

  • (nil) 


171
172
173
174
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 171

def delete_routing_queue(queue_id, opts = {})
  delete_routing_queue_with_http_info(queue_id, opts)
  return nil
end

#delete_routing_queue_user(queue_id, member_id, opts = {}) ⇒ nil

Delete queue member

Parameters:

  • queue_id —

    Queue ID

  • member_id —

    Member ID

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

    the optional parameters

Returns:

  • (nil) 


244
245
246
247
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 244

def delete_routing_queue_user(queue_id, member_id, opts = {})
  delete_routing_queue_user_with_http_info(queue_id, member_id, opts)
  return nil
end

#delete_routing_queue_user_with_http_info(queue_id, member_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete queue member

Parameters:

  • queue_id —

    Queue ID

  • member_id —

    Member ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 255

def delete_routing_queue_user_with_http_info(queue_id, member_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.delete_routing_queue_user ..."
  end
  
  
  # verify the required parameter 'queue_id' is set
  fail ArgumentError, "Missing the required parameter 'queue_id' when calling RoutingApi.delete_routing_queue_user" if queue_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'member_id' is set
  fail ArgumentError, "Missing the required parameter 'member_id' when calling RoutingApi.delete_routing_queue_user" if member_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/queues/{queueId}/users/{memberId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s).sub('{' + 'memberId' + '}', member_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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: RoutingApi#delete_routing_queue_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete a queue

Parameters:

  • queue_id —

    Queue ID

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

    the optional parameters

Options Hash (opts):

  • :force_delete (BOOLEAN) —

    forceDelete

Returns:

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

    nil, response status code and response headers



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 182

def delete_routing_queue_with_http_info(queue_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.delete_routing_queue ..."
  end
  
  
  # verify the required parameter 'queue_id' is set
  fail ArgumentError, "Missing the required parameter 'queue_id' when calling RoutingApi.delete_routing_queue" if queue_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/queues/{queueId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'forceDelete'] = opts[:'force_delete'] if opts[:'force_delete']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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: RoutingApi#delete_routing_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_routing_queue_wrapupcode(queue_id, code_id, opts = {}) ⇒ nil

Delete a wrap-up code from a queue

Parameters:

  • queue_id —

    Queue ID

  • code_id —

    Code ID

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

    the optional parameters

Returns:

  • (nil) 


318
319
320
321
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 318

def delete_routing_queue_wrapupcode(queue_id, code_id, opts = {})
  delete_routing_queue_wrapupcode_with_http_info(queue_id, code_id, opts)
  return nil
end

#delete_routing_queue_wrapupcode_with_http_info(queue_id, code_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a wrap-up code from a queue

Parameters:

  • queue_id —

    Queue ID

  • code_id —

    Code ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 329

def delete_routing_queue_wrapupcode_with_http_info(queue_id, code_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.delete_routing_queue_wrapupcode ..."
  end
  
  
  # verify the required parameter 'queue_id' is set
  fail ArgumentError, "Missing the required parameter 'queue_id' when calling RoutingApi.delete_routing_queue_wrapupcode" if queue_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'code_id' is set
  fail ArgumentError, "Missing the required parameter 'code_id' when calling RoutingApi.delete_routing_queue_wrapupcode" if code_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/queues/{queueId}/wrapupcodes/{codeId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s).sub('{' + 'codeId' + '}', code_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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: RoutingApi#delete_routing_queue_wrapupcode\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_routing_skill(skill_id, opts = {}) ⇒ nil

Delete Routing Skill

Parameters:

  • skill_id —

    Skill ID

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

    the optional parameters

Returns:

  • (nil) 


391
392
393
394
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 391

def delete_routing_skill(skill_id, opts = {})
  delete_routing_skill_with_http_info(skill_id, opts)
  return nil
end

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

Delete Routing Skill

Parameters:

  • skill_id —

    Skill ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 401

def delete_routing_skill_with_http_info(skill_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.delete_routing_skill ..."
  end
  
  
  # verify the required parameter 'skill_id' is set
  fail ArgumentError, "Missing the required parameter 'skill_id' when calling RoutingApi.delete_routing_skill" if skill_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/skills/{skillId}".sub('{format}','json').sub('{' + 'skillId' + '}', skill_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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: RoutingApi#delete_routing_skill\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_routing_utilization(opts = {}) ⇒ nil

Delete utilization settings and revert to system defaults.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


454
455
456
457
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 454

def delete_routing_utilization(opts = {})
  delete_routing_utilization_with_http_info(opts)
  return nil
end

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

Delete utilization settings and revert to system defaults.

Parameters:

  • 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
501
502
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 463

def delete_routing_utilization_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.delete_routing_utilization ..."
  end
  
  # resource path
  local_var_path = "/api/v2/routing/utilization".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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: RoutingApi#delete_routing_utilization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_routing_wrapupcode(code_id, opts = {}) ⇒ nil

Delete wrap-up code

Parameters:

  • code_id —

    Wrapup Code ID

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

    the optional parameters

Returns:

  • (nil) 


509
510
511
512
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 509

def delete_routing_wrapupcode(code_id, opts = {})
  delete_routing_wrapupcode_with_http_info(code_id, opts)
  return nil
end

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

Delete wrap-up code

Parameters:

  • code_id —

    Wrapup Code ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
554
555
556
557
558
559
560
561
562
563
564
565
566
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 519

def delete_routing_wrapupcode_with_http_info(code_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.delete_routing_wrapupcode ..."
  end
  
  
  # verify the required parameter 'code_id' is set
  fail ArgumentError, "Missing the required parameter 'code_id' when calling RoutingApi.delete_routing_wrapupcode" if code_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/wrapupcodes/{codeId}".sub('{format}','json').sub('{' + 'codeId' + '}', code_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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: RoutingApi#delete_routing_wrapupcode\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_user_routingskill(user_id, skill_id, opts = {}) ⇒ nil

Remove routing skill from user

Parameters:

  • user_id —

    User ID

  • skill_id —

    skillId

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

    the optional parameters

Returns:

  • (nil) 


574
575
576
577
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 574

def delete_user_routingskill(user_id, skill_id, opts = {})
  delete_user_routingskill_with_http_info(user_id, skill_id, opts)
  return nil
end

#delete_user_routingskill_with_http_info(user_id, skill_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Remove routing skill from user

Parameters:

  • user_id —

    User ID

  • skill_id —

    skillId

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 585

def delete_user_routingskill_with_http_info(user_id, skill_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.delete_user_routingskill ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling RoutingApi.delete_user_routingskill" if user_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'skill_id' is set
  fail ArgumentError, "Missing the required parameter 'skill_id' when calling RoutingApi.delete_user_routingskill" if skill_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/users/{userId}/routingskills/{skillId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'skillId' + '}', skill_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud Auth']
  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: RoutingApi#delete_user_routingskill\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_routing_email_domain(domain_id, opts = {}) ⇒ InboundDomain

Get domain

Parameters:

  • domain_id —

    domain ID

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

    the optional parameters

Returns:



647
648
649
650
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 647

def get_routing_email_domain(domain_id, opts = {})
  data, _status_code, _headers = get_routing_email_domain_with_http_info(domain_id, opts)
  return data
end

#get_routing_email_domain_route(domain_name, route_id, opts = {}) ⇒ InboundRoute

Get a route

Parameters:

  • domain_name —

    email domain

  • route_id —

    route ID

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

    the optional parameters

Returns:



713
714
715
716
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 713

def get_routing_email_domain_route(domain_name, route_id, opts = {})
  data, _status_code, _headers = get_routing_email_domain_route_with_http_info(domain_name, route_id, opts)
  return data
end

#get_routing_email_domain_route_with_http_info(domain_name, route_id, opts = {}) ⇒ Array<(InboundRoute, Fixnum, Hash)>

Get a route

Parameters:

  • domain_name —

    email domain

  • route_id —

    route ID

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

    the optional parameters

Returns:

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

    InboundRoute data, response status code and response headers



724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 724

def get_routing_email_domain_route_with_http_info(domain_name, route_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_email_domain_route ..."
  end
  
  
  # verify the required parameter 'domain_name' is set
  fail ArgumentError, "Missing the required parameter 'domain_name' when calling RoutingApi.get_routing_email_domain_route" if domain_name.nil?
  
  
  
  
  
  
  # verify the required parameter 'route_id' is set
  fail ArgumentError, "Missing the required parameter 'route_id' when calling RoutingApi.get_routing_email_domain_route" if route_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/email/domains/{domainName}/routes/{routeId}".sub('{format}','json').sub('{' + 'domainName' + '}', domain_name.to_s).sub('{' + 'routeId' + '}', route_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_routing_email_domain_routes(domain_name, opts = {}) ⇒ InboundRouteEntityListing

Get routes

Parameters:

  • domain_name —

    email domain

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :pattern (String) —

    Filter routes by the route&#39;s pattern property

Returns:



790
791
792
793
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 790

def get_routing_email_domain_routes(domain_name, opts = {})
  data, _status_code, _headers = get_routing_email_domain_routes_with_http_info(domain_name, opts)
  return data
end

#get_routing_email_domain_routes_with_http_info(domain_name, opts = {}) ⇒ Array<(InboundRouteEntityListing, Fixnum, Hash)>

Get routes

Parameters:

  • domain_name —

    email domain

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :pattern (String) —

    Filter routes by the route&#39;s pattern property

Returns:

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

    InboundRouteEntityListing data, response status code and response headers



803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
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
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 803

def get_routing_email_domain_routes_with_http_info(domain_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_email_domain_routes ..."
  end
  
  
  # verify the required parameter 'domain_name' is set
  fail ArgumentError, "Missing the required parameter 'domain_name' when calling RoutingApi.get_routing_email_domain_routes" if domain_name.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/email/domains/{domainName}/routes".sub('{format}','json').sub('{' + 'domainName' + '}', domain_name.to_s)

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'pattern'] = opts[:'pattern'] if opts[:'pattern']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_routing_email_domain_with_http_info(domain_id, opts = {}) ⇒ Array<(InboundDomain, Fixnum, Hash)>

Get domain

Parameters:

  • domain_id —

    domain ID

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

    the optional parameters

Returns:

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

    InboundDomain data, response status code and response headers



657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 657

def get_routing_email_domain_with_http_info(domain_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_email_domain ..."
  end
  
  
  # verify the required parameter 'domain_id' is set
  fail ArgumentError, "Missing the required parameter 'domain_id' when calling RoutingApi.get_routing_email_domain" if domain_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/email/domains/{domainId}".sub('{format}','json').sub('{' + 'domainId' + '}', domain_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_routing_email_domains(opts = {}) ⇒ InboundDomainEntityListing

Get domains

Parameters:

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

    the optional parameters

Returns:



878
879
880
881
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 878

def get_routing_email_domains(opts = {})
  data, _status_code, _headers = get_routing_email_domains_with_http_info(opts)
  return data
end

#get_routing_email_domains_with_http_info(opts = {}) ⇒ Array<(InboundDomainEntityListing, Fixnum, Hash)>

Get domains

Parameters:

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

    the optional parameters

Returns:

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

    InboundDomainEntityListing data, response status code and response headers



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
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 887

def get_routing_email_domains_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_email_domains ..."
  end
  
  # resource path
  local_var_path = "/api/v2/routing/email/domains".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_routing_email_setup(opts = {}) ⇒ EmailSetup

Get email setup

Parameters:

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

    the optional parameters

Returns:



933
934
935
936
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 933

def get_routing_email_setup(opts = {})
  data, _status_code, _headers = get_routing_email_setup_with_http_info(opts)
  return data
end

#get_routing_email_setup_with_http_info(opts = {}) ⇒ Array<(EmailSetup, Fixnum, Hash)>

Get email setup

Parameters:

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

    the optional parameters

Returns:

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

    EmailSetup data, response status code and response headers



942
943
944
945
946
947
948
949
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
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 942

def get_routing_email_setup_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_email_setup ..."
  end
  
  # resource path
  local_var_path = "/api/v2/routing/email/setup".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_routing_languages(opts = {}) ⇒ LanguageEntityListing

Get the list of supported languages.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :sort_order (String) —

    Ascending or descending sort order (default to ASC)

  • :name (String) —

    Name

Returns:



992
993
994
995
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 992

def get_routing_languages(opts = {})
  data, _status_code, _headers = get_routing_languages_with_http_info(opts)
  return data
end

#get_routing_languages_with_http_info(opts = {}) ⇒ Array<(LanguageEntityListing, Fixnum, Hash)>

Get the list of supported languages.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_order (String) —

    Ascending or descending sort order

  • :name (String) —

    Name

Returns:

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

    LanguageEntityListing data, response status code and response headers



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
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 1005

def get_routing_languages_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_languages ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/languages".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'name'] = opts[:'name'] if opts[:'name']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_routing_queue(queue_id, opts = {}) ⇒ Queue

Get details about this queue.

Parameters:

  • queue_id —

    Queue ID

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

    the optional parameters

Returns:



1084
1085
1086
1087
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 1084

def get_routing_queue(queue_id, opts = {})
  data, _status_code, _headers = get_routing_queue_with_http_info(queue_id, opts)
  return data
end

#get_routing_queue_estimatedwaittime(queue_id, opts = {}) ⇒ EstimatedWaitTimePredictions

Get Estimated Wait Time

Parameters:

  • queue_id —

    queueId

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

    the optional parameters

Options Hash (opts):

  • :conversation_id (String) —

    conversationId

Returns:



1150
1151
1152
1153
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 1150

def get_routing_queue_estimatedwaittime(queue_id, opts = {})
  data, _status_code, _headers = get_routing_queue_estimatedwaittime_with_http_info(queue_id, opts)
  return data
end

#get_routing_queue_estimatedwaittime_with_http_info(queue_id, opts = {}) ⇒ Array<(EstimatedWaitTimePredictions, Fixnum, Hash)>

Get Estimated Wait Time

Parameters:

  • queue_id —

    queueId

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

    the optional parameters

Options Hash (opts):

  • :conversation_id (String) —

    conversationId

Returns:



1161
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
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 1161

def get_routing_queue_estimatedwaittime_with_http_info(queue_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_queue_estimatedwaittime ..."
  end
  
  
  # verify the required parameter 'queue_id' is set
  fail ArgumentError, "Missing the required parameter 'queue_id' when calling RoutingApi.get_routing_queue_estimatedwaittime" if queue_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/queues/{queueId}/estimatedwaittime".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'conversationId'] = opts[:'conversation_id'] if opts[:'conversation_id']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_routing_queue_mediatype_estimatedwaittime(queue_id, media_type, opts = {}) ⇒ EstimatedWaitTimePredictions

Get Estimated Wait Time

Parameters:

  • queue_id —

    queueId

  • media_type —

    mediaType

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

    the optional parameters

Returns:



1224
1225
1226
1227
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 1224

def get_routing_queue_mediatype_estimatedwaittime(queue_id, media_type, opts = {})
  data, _status_code, _headers = get_routing_queue_mediatype_estimatedwaittime_with_http_info(queue_id, media_type, opts)
  return data
end

#get_routing_queue_mediatype_estimatedwaittime_with_http_info(queue_id, media_type, opts = {}) ⇒ Array<(EstimatedWaitTimePredictions, Fixnum, Hash)>

Get Estimated Wait Time

Parameters:

  • queue_id —

    queueId

  • media_type —

    mediaType

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

    the optional parameters

Returns:



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
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 1235

def get_routing_queue_mediatype_estimatedwaittime_with_http_info(queue_id, media_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_queue_mediatype_estimatedwaittime ..."
  end
  
  
  # verify the required parameter 'queue_id' is set
  fail ArgumentError, "Missing the required parameter 'queue_id' when calling RoutingApi.get_routing_queue_mediatype_estimatedwaittime" if queue_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'media_type' is set
  fail ArgumentError, "Missing the required parameter 'media_type' when calling RoutingApi.get_routing_queue_mediatype_estimatedwaittime" if media_type.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s).sub('{' + 'mediaType' + '}', media_type.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_routing_queue_users(queue_id, opts = {}) ⇒ QueueMemberEntityListing

Get the members of this queue

Parameters:

  • queue_id —

    Queue ID

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :sort_by (String) —

    Sort by (default to name)

  • :expand (Array<String>) —

    Which fields, if any, to expand.

  • :joined (BOOLEAN) —

    Filter by joined status

  • :name (String) —

    Filter by queue member name

  • :profile_skills (Array<String>) —

    Filter by profile skill

  • :skills (Array<String>) —

    Filter by skill

  • :languages (Array<String>) —

    Filter by language

  • :routing_status (Array<String>) —

    Filter by routing status

  • :presence (Array<String>) —

    Filter by presence

Returns:



1309
1310
1311
1312
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 1309

def get_routing_queue_users(queue_id, opts = {})
  data, _status_code, _headers = get_routing_queue_users_with_http_info(queue_id, opts)
  return data
end

#get_routing_queue_users_with_http_info(queue_id, opts = {}) ⇒ Array<(QueueMemberEntityListing, Fixnum, Hash)>

Get the members of this queue

Parameters:

  • queue_id —

    Queue ID

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_by (String) —

    Sort by

  • :expand (Array<String>) —

    Which fields, if any, to expand.

  • :joined (BOOLEAN) —

    Filter by joined status

  • :name (String) —

    Filter by queue member name

  • :profile_skills (Array<String>) —

    Filter by profile skill

  • :skills (Array<String>) —

    Filter by skill

  • :languages (Array<String>) —

    Filter by language

  • :routing_status (Array<String>) —

    Filter by routing status

  • :presence (Array<String>) —

    Filter by presence

Returns:

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

    QueueMemberEntityListing data, response status code and response headers



1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
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
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 1330

def get_routing_queue_users_with_http_info(queue_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_queue_users ..."
  end
  
  
  # verify the required parameter 'queue_id' is set
  fail ArgumentError, "Missing the required parameter 'queue_id' when calling RoutingApi.get_routing_queue_users" if queue_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/queues/{queueId}/users".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']
  query_params[:'joined'] = opts[:'joined'] if opts[:'joined']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'profileSkills'] = @api_client.build_collection_param(opts[:'profile_skills'], :multi) if opts[:'profile_skills']
  query_params[:'skills'] = @api_client.build_collection_param(opts[:'skills'], :multi) if opts[:'skills']
  query_params[:'languages'] = @api_client.build_collection_param(opts[:'languages'], :multi) if opts[:'languages']
  query_params[:'routingStatus'] = @api_client.build_collection_param(opts[:'routing_status'], :multi) if opts[:'routing_status']
  query_params[:'presence'] = @api_client.build_collection_param(opts[:'presence'], :multi) if opts[:'presence']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_routing_queue_with_http_info(queue_id, opts = {}) ⇒ Array<(Queue, Fixnum, Hash)>

Get details about this queue.

Parameters:

  • queue_id —

    Queue ID

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

    the optional parameters

Returns:

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

    Queue data, response status code and response headers



1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
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
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 1094

def get_routing_queue_with_http_info(queue_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_queue ..."
  end
  
  
  # verify the required parameter 'queue_id' is set
  fail ArgumentError, "Missing the required parameter 'queue_id' when calling RoutingApi.get_routing_queue" if queue_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/queues/{queueId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_routing_queue_wrapupcodes(queue_id, opts = {}) ⇒ WrapupCodeEntityListing

Get the wrap-up codes for a queue

Parameters:

  • queue_id —

    Queue ID

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

    the optional parameters

Returns:



1462
1463
1464
1465
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 1462

def get_routing_queue_wrapupcodes(queue_id, opts = {})
  data, _status_code, _headers = get_routing_queue_wrapupcodes_with_http_info(queue_id, opts)
  return data
end

#get_routing_queue_wrapupcodes_with_http_info(queue_id, opts = {}) ⇒ Array<(WrapupCodeEntityListing, Fixnum, Hash)>

Get the wrap-up codes for a queue

Parameters:

  • queue_id —

    Queue ID

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

    the optional parameters

Returns:

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

    WrapupCodeEntityListing data, response status code and response headers



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
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 1472

def get_routing_queue_wrapupcodes_with_http_info(queue_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_queue_wrapupcodes ..."
  end
  
  
  # verify the required parameter 'queue_id' is set
  fail ArgumentError, "Missing the required parameter 'queue_id' when calling RoutingApi.get_routing_queue_wrapupcodes" if queue_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/queues/{queueId}/wrapupcodes".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_routing_queues(opts = {}) ⇒ QueueEntityListing

Get list of queues.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :sort_by (String) —

    Sort by (default to name)

  • :name (String) —

    Name

  • :active (BOOLEAN) —

    Active

Returns:



1531
1532
1533
1534
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 1531

def get_routing_queues(opts = {})
  data, _status_code, _headers = get_routing_queues_with_http_info(opts)
  return data
end

#get_routing_queues_with_http_info(opts = {}) ⇒ Array<(QueueEntityListing, Fixnum, Hash)>

Get list of queues.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_by (String) —

    Sort by

  • :name (String) —

    Name

  • :active (BOOLEAN) —

    Active

Returns:

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

    QueueEntityListing data, response status code and response headers



1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 1545

def get_routing_queues_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_queues ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/queues".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'active'] = opts[:'active'] if opts[:'active']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_routing_skill(skill_id, opts = {}) ⇒ RoutingSkill

Get Routing Skill

Parameters:

  • skill_id —

    Skill ID

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

    the optional parameters

Returns:



1627
1628
1629
1630
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 1627

def get_routing_skill(skill_id, opts = {})
  data, _status_code, _headers = get_routing_skill_with_http_info(skill_id, opts)
  return data
end

#get_routing_skill_with_http_info(skill_id, opts = {}) ⇒ Array<(RoutingSkill, Fixnum, Hash)>

Get Routing Skill

Parameters:

  • skill_id —

    Skill ID

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

    the optional parameters

Returns:

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

    RoutingSkill data, response status code and response headers



1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 1637

def get_routing_skill_with_http_info(skill_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_skill ..."
  end
  
  
  # verify the required parameter 'skill_id' is set
  fail ArgumentError, "Missing the required parameter 'skill_id' when calling RoutingApi.get_routing_skill" if skill_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/skills/{skillId}".sub('{format}','json').sub('{' + 'skillId' + '}', skill_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_routing_skills(opts = {}) ⇒ SkillEntityListing

Get the list of routing skills.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :name (String) —

    Filter for results that start with this value

Returns:



1694
1695
1696
1697
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 1694

def get_routing_skills(opts = {})
  data, _status_code, _headers = get_routing_skills_with_http_info(opts)
  return data
end

#get_routing_skills_with_http_info(opts = {}) ⇒ Array<(SkillEntityListing, Fixnum, Hash)>

Get the list of routing skills.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :name (String) —

    Filter for results that start with this value

Returns:

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

    SkillEntityListing data, response status code and response headers



1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 1706

def get_routing_skills_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_skills ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/skills".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'name'] = opts[:'name'] if opts[:'name']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_routing_utilization(opts = {}) ⇒ Utilization

Get the utilization settings.

Parameters:

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

    the optional parameters

Returns:



1773
1774
1775
1776
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 1773

def get_routing_utilization(opts = {})
  data, _status_code, _headers = get_routing_utilization_with_http_info(opts)
  return data
end

#get_routing_utilization_with_http_info(opts = {}) ⇒ Array<(Utilization, Fixnum, Hash)>

Get the utilization settings.

Parameters:

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

    the optional parameters

Returns:

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

    Utilization data, response status code and response headers



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

def get_routing_utilization_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_utilization ..."
  end
  
  # resource path
  local_var_path = "/api/v2/routing/utilization".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_routing_wrapupcode(code_id, opts = {}) ⇒ WrapupCode

Get details about this wrap-up code.

Parameters:

  • code_id —

    Wrapup Code ID

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

    the optional parameters

Returns:



1829
1830
1831
1832
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 1829

def get_routing_wrapupcode(code_id, opts = {})
  data, _status_code, _headers = get_routing_wrapupcode_with_http_info(code_id, opts)
  return data
end

#get_routing_wrapupcode_with_http_info(code_id, opts = {}) ⇒ Array<(WrapupCode, Fixnum, Hash)>

Get details about this wrap-up code.

Parameters:

  • code_id —

    Wrapup Code ID

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

    the optional parameters

Returns:

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

    WrapupCode data, response status code and response headers



1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 1839

def get_routing_wrapupcode_with_http_info(code_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_wrapupcode ..."
  end
  
  
  # verify the required parameter 'code_id' is set
  fail ArgumentError, "Missing the required parameter 'code_id' when calling RoutingApi.get_routing_wrapupcode" if code_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/wrapupcodes/{codeId}".sub('{format}','json').sub('{' + 'codeId' + '}', code_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_routing_wrapupcodes(opts = {}) ⇒ WrapupCodeEntityListing

Get list of wrapup codes.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by (default to name)

Returns:



1897
1898
1899
1900
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 1897

def get_routing_wrapupcodes(opts = {})
  data, _status_code, _headers = get_routing_wrapupcodes_with_http_info(opts)
  return data
end

#get_routing_wrapupcodes_with_http_info(opts = {}) ⇒ Array<(WrapupCodeEntityListing, Fixnum, Hash)>

Get list of wrapup codes.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :name (String) —

    Name

  • :sort_by (String) —

    Sort by

Returns:

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

    WrapupCodeEntityListing data, response status code and response headers



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
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 1910

def get_routing_wrapupcodes_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_wrapupcodes ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/wrapupcodes".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#get_user_routingskills(user_id, opts = {}) ⇒ UserSkillEntityListing

List routing skills for user

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :sort_order (String) —

    Ascending or descending sort order (default to ASC)

Returns:



1988
1989
1990
1991
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 1988

def get_user_routingskills(user_id, opts = {})
  data, _status_code, _headers = get_user_routingskills_with_http_info(user_id, opts)
  return data
end

#get_user_routingskills_with_http_info(user_id, opts = {}) ⇒ Array<(UserSkillEntityListing, Fixnum, Hash)>

List routing skills for user

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_order (String) —

    Ascending or descending sort order

Returns:

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

    UserSkillEntityListing data, response status code and response headers



2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 2001

def get_user_routingskills_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_user_routingskills ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling RoutingApi.get_user_routingskills" if user_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_order'] && !['ascending', 'descending'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of ascending, descending'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/users/{userId}/routingskills".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

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

#patch_routing_queue_user(queue_id, member_id, body, opts = {}) ⇒ QueueMember

Update the ring number of joined status for a User in a Queue

Parameters:

  • queue_id —

    Queue ID

  • member_id —

    Member ID

  • body —

    Queue Member

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

    the optional parameters

Returns:



2083
2084
2085
2086
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 2083

def patch_routing_queue_user(queue_id, member_id, body, opts = {})
  data, _status_code, _headers = patch_routing_queue_user_with_http_info(queue_id, member_id, body, opts)
  return data
end

#patch_routing_queue_user_with_http_info(queue_id, member_id, body, opts = {}) ⇒ Array<(QueueMember, Fixnum, Hash)>

Update the ring number of joined status for a User in a Queue

Parameters:

  • queue_id —

    Queue ID

  • member_id —

    Member ID

  • body —

    Queue Member

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

    the optional parameters

Returns:

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

    QueueMember data, response status code and response headers



2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 2095

def patch_routing_queue_user_with_http_info(queue_id, member_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.patch_routing_queue_user ..."
  end
  
  
  # verify the required parameter 'queue_id' is set
  fail ArgumentError, "Missing the required parameter 'queue_id' when calling RoutingApi.patch_routing_queue_user" if queue_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'member_id' is set
  fail ArgumentError, "Missing the required parameter 'member_id' when calling RoutingApi.patch_routing_queue_user" if member_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.patch_routing_queue_user" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/queues/{queueId}/users/{memberId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s).sub('{' + 'memberId' + '}', member_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'QueueMember')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#patch_routing_queue_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_routing_queue_users(queue_id, body, opts = {}) ⇒ QueueMemberEntityListing

Join or unjoin a set of users for a queue

Parameters:

  • queue_id —

    Queue ID

  • body —

    Queue Members

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

    the optional parameters

Returns:



2167
2168
2169
2170
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 2167

def patch_routing_queue_users(queue_id, body, opts = {})
  data, _status_code, _headers = patch_routing_queue_users_with_http_info(queue_id, body, opts)
  return data
end

#patch_routing_queue_users_with_http_info(queue_id, body, opts = {}) ⇒ Array<(QueueMemberEntityListing, Fixnum, Hash)>

Join or unjoin a set of users for a queue

Parameters:

  • queue_id —

    Queue ID

  • body —

    Queue Members

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

    the optional parameters

Returns:

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

    QueueMemberEntityListing data, response status code and response headers



2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 2178

def patch_routing_queue_users_with_http_info(queue_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.patch_routing_queue_users ..."
  end
  
  
  # verify the required parameter 'queue_id' is set
  fail ArgumentError, "Missing the required parameter 'queue_id' when calling RoutingApi.patch_routing_queue_users" if queue_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.patch_routing_queue_users" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/queues/{queueId}/users".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'QueueMemberEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#patch_routing_queue_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_analytics_queues_observations_query(body, opts = {}) ⇒ QualifierMappingObservationQueryResponse

Query for queue observations

Parameters:

  • body —

    query

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

    the optional parameters

Returns:



2241
2242
2243
2244
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 2241

def post_analytics_queues_observations_query(body, opts = {})
  data, _status_code, _headers = post_analytics_queues_observations_query_with_http_info(body, opts)
  return data
end

#post_analytics_queues_observations_query_with_http_info(body, opts = {}) ⇒ Array<(QualifierMappingObservationQueryResponse, Fixnum, Hash)>

Query for queue observations

Parameters:

  • body —

    query

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

    the optional parameters

Returns:



2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 2251

def post_analytics_queues_observations_query_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.post_analytics_queues_observations_query ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.post_analytics_queues_observations_query" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/analytics/queues/observations/query".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'QualifierMappingObservationQueryResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#post_analytics_queues_observations_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_routing_email_domain_routes(domain_name, body, opts = {}) ⇒ InboundRoute

Create a route

Parameters:

  • domain_name —

    email domain

  • body —

    Route

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

    the optional parameters

Returns:



2307
2308
2309
2310
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 2307

def post_routing_email_domain_routes(domain_name, body, opts = {})
  data, _status_code, _headers = post_routing_email_domain_routes_with_http_info(domain_name, body, opts)
  return data
end

#post_routing_email_domain_routes_with_http_info(domain_name, body, opts = {}) ⇒ Array<(InboundRoute, Fixnum, Hash)>

Create a route

Parameters:

  • domain_name —

    email domain

  • body —

    Route

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

    the optional parameters

Returns:

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

    InboundRoute data, response status code and response headers



2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 2318

def post_routing_email_domain_routes_with_http_info(domain_name, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.post_routing_email_domain_routes ..."
  end
  
  
  # verify the required parameter 'domain_name' is set
  fail ArgumentError, "Missing the required parameter 'domain_name' when calling RoutingApi.post_routing_email_domain_routes" if domain_name.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.post_routing_email_domain_routes" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/email/domains/{domainName}/routes".sub('{format}','json').sub('{' + 'domainName' + '}', domain_name.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InboundRoute')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#post_routing_email_domain_routes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_routing_email_domains(body, opts = {}) ⇒ InboundDomain

Create a domain

Parameters:

  • body —

    Domain

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

    the optional parameters

Returns:



2381
2382
2383
2384
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 2381

def post_routing_email_domains(body, opts = {})
  data, _status_code, _headers = post_routing_email_domains_with_http_info(body, opts)
  return data
end

#post_routing_email_domains_with_http_info(body, opts = {}) ⇒ Array<(InboundDomain, Fixnum, Hash)>

Create a domain

Parameters:

  • body —

    Domain

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

    the optional parameters

Returns:

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

    InboundDomain data, response status code and response headers



2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 2391

def post_routing_email_domains_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.post_routing_email_domains ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.post_routing_email_domains" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/email/domains".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InboundDomain')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#post_routing_email_domains\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_routing_languages(body, opts = {}) ⇒ Language

Create Language

Parameters:

  • body —

    Language

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

    the optional parameters

Returns:



2446
2447
2448
2449
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 2446

def post_routing_languages(body, opts = {})
  data, _status_code, _headers = post_routing_languages_with_http_info(body, opts)
  return data
end

#post_routing_languages_with_http_info(body, opts = {}) ⇒ Array<(Language, Fixnum, Hash)>

Create Language

Parameters:

  • body —

    Language

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

    the optional parameters

Returns:

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

    Language data, response status code and response headers



2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 2456

def post_routing_languages_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.post_routing_languages ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.post_routing_languages" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/languages".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Language')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#post_routing_languages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_routing_queue_users(queue_id, body, opts = {}) ⇒ String

Bulk add or delete up to 100 queue members

Parameters:

  • queue_id —

    Queue ID

  • body —

    Queue Members

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

    the optional parameters

Options Hash (opts):

  • :delete (BOOLEAN) —

    True to delete queue members (default to false)

Returns:

  • (String) 


2513
2514
2515
2516
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 2513

def post_routing_queue_users(queue_id, body, opts = {})
  data, _status_code, _headers = post_routing_queue_users_with_http_info(queue_id, body, opts)
  return data
end

#post_routing_queue_users_with_http_info(queue_id, body, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Bulk add or delete up to 100 queue members

Parameters:

  • queue_id —

    Queue ID

  • body —

    Queue Members

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

    the optional parameters

Options Hash (opts):

  • :delete (BOOLEAN) —

    True to delete queue members

Returns:

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

    String data, response status code and response headers



2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 2525

def post_routing_queue_users_with_http_info(queue_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.post_routing_queue_users ..."
  end
  
  
  # verify the required parameter 'queue_id' is set
  fail ArgumentError, "Missing the required parameter 'queue_id' when calling RoutingApi.post_routing_queue_users" if queue_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.post_routing_queue_users" if body.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/queues/{queueId}/users".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'delete'] = opts[:'delete'] if opts[:'delete']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#post_routing_queue_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_routing_queue_wrapupcodes(queue_id, body, opts = {}) ⇒ Array<WrapupCode>

Add up to 100 wrap-up codes to a queue

Parameters:

  • queue_id —

    Queue ID

  • body —

    List of wrapup codes

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

    the optional parameters

Returns:



2596
2597
2598
2599
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 2596

def post_routing_queue_wrapupcodes(queue_id, body, opts = {})
  data, _status_code, _headers = post_routing_queue_wrapupcodes_with_http_info(queue_id, body, opts)
  return data
end

#post_routing_queue_wrapupcodes_with_http_info(queue_id, body, opts = {}) ⇒ Array<(Array<WrapupCode>, Fixnum, Hash)>

Add up to 100 wrap-up codes to a queue

Parameters:

  • queue_id —

    Queue ID

  • body —

    List of wrapup codes

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

    the optional parameters

Returns:

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

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



2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 2607

def post_routing_queue_wrapupcodes_with_http_info(queue_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.post_routing_queue_wrapupcodes ..."
  end
  
  
  # verify the required parameter 'queue_id' is set
  fail ArgumentError, "Missing the required parameter 'queue_id' when calling RoutingApi.post_routing_queue_wrapupcodes" if queue_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.post_routing_queue_wrapupcodes" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/queues/{queueId}/wrapupcodes".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<WrapupCode>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#post_routing_queue_wrapupcodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_routing_queues(body, opts = {}) ⇒ Queue

Create queue

Parameters:

  • body —

    Queue

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

    the optional parameters

Returns:



2670
2671
2672
2673
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 2670

def post_routing_queues(body, opts = {})
  data, _status_code, _headers = post_routing_queues_with_http_info(body, opts)
  return data
end

#post_routing_queues_with_http_info(body, opts = {}) ⇒ Array<(Queue, Fixnum, Hash)>

Create queue

Parameters:

  • body —

    Queue

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

    the optional parameters

Returns:

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

    Queue data, response status code and response headers



2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 2680

def post_routing_queues_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.post_routing_queues ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.post_routing_queues" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/queues".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Queue')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#post_routing_queues\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_routing_skills(body, opts = {}) ⇒ RoutingSkill

Create Skill

Parameters:

  • body —

    Skill

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

    the optional parameters

Returns:



2735
2736
2737
2738
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 2735

def post_routing_skills(body, opts = {})
  data, _status_code, _headers = post_routing_skills_with_http_info(body, opts)
  return data
end

#post_routing_skills_with_http_info(body, opts = {}) ⇒ Array<(RoutingSkill, Fixnum, Hash)>

Create Skill

Parameters:

  • body —

    Skill

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

    the optional parameters

Returns:

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

    RoutingSkill data, response status code and response headers



2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 2745

def post_routing_skills_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.post_routing_skills ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.post_routing_skills" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/skills".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RoutingSkill')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#post_routing_skills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_routing_wrapupcodes(body, opts = {}) ⇒ WrapupCode

Create a wrap-up code

Parameters:

  • body —

    WrapupCode

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

    the optional parameters

Returns:



2800
2801
2802
2803
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 2800

def post_routing_wrapupcodes(body, opts = {})
  data, _status_code, _headers = post_routing_wrapupcodes_with_http_info(body, opts)
  return data
end

#post_routing_wrapupcodes_with_http_info(body, opts = {}) ⇒ Array<(WrapupCode, Fixnum, Hash)>

Create a wrap-up code

Parameters:

  • body —

    WrapupCode

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

    the optional parameters

Returns:

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

    WrapupCode data, response status code and response headers



2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 2810

def post_routing_wrapupcodes_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.post_routing_wrapupcodes ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.post_routing_wrapupcodes" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/wrapupcodes".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WrapupCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#post_routing_wrapupcodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_user_routingskills(user_id, body, opts = {}) ⇒ UserRoutingSkill

Add routing skill to user

Parameters:

  • user_id —

    User ID

  • body —

    Skill

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

    the optional parameters

Returns:



2866
2867
2868
2869
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 2866

def post_user_routingskills(user_id, body, opts = {})
  data, _status_code, _headers = post_user_routingskills_with_http_info(user_id, body, opts)
  return data
end

#post_user_routingskills_with_http_info(user_id, body, opts = {}) ⇒ Array<(UserRoutingSkill, Fixnum, Hash)>

Add routing skill to user

Parameters:

  • user_id —

    User ID

  • body —

    Skill

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

    the optional parameters

Returns:

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

    UserRoutingSkill data, response status code and response headers



2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 2877

def post_user_routingskills_with_http_info(user_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.post_user_routingskills ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling RoutingApi.post_user_routingskills" if user_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.post_user_routingskills" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/users/{userId}/routingskills".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserRoutingSkill')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#post_user_routingskills\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_routing_email_domain_route(domain_name, route_id, body, opts = {}) ⇒ InboundRoute

Update a route

Parameters:

  • domain_name —

    email domain

  • route_id —

    route ID

  • body —

    Route

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

    the optional parameters

Returns:



2942
2943
2944
2945
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 2942

def put_routing_email_domain_route(domain_name, route_id, body, opts = {})
  data, _status_code, _headers = put_routing_email_domain_route_with_http_info(domain_name, route_id, body, opts)
  return data
end

#put_routing_email_domain_route_with_http_info(domain_name, route_id, body, opts = {}) ⇒ Array<(InboundRoute, Fixnum, Hash)>

Update a route

Parameters:

  • domain_name —

    email domain

  • route_id —

    route ID

  • body —

    Route

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

    the optional parameters

Returns:

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

    InboundRoute data, response status code and response headers



2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 2954

def put_routing_email_domain_route_with_http_info(domain_name, route_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.put_routing_email_domain_route ..."
  end
  
  
  # verify the required parameter 'domain_name' is set
  fail ArgumentError, "Missing the required parameter 'domain_name' when calling RoutingApi.put_routing_email_domain_route" if domain_name.nil?
  
  
  
  
  
  
  # verify the required parameter 'route_id' is set
  fail ArgumentError, "Missing the required parameter 'route_id' when calling RoutingApi.put_routing_email_domain_route" if route_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.put_routing_email_domain_route" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/email/domains/{domainName}/routes/{routeId}".sub('{format}','json').sub('{' + 'domainName' + '}', domain_name.to_s).sub('{' + 'routeId' + '}', route_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InboundRoute')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#put_routing_email_domain_route\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_routing_queue(queue_id, body, opts = {}) ⇒ Queue

Update a queue

Parameters:

  • queue_id —

    Queue ID

  • body —

    Queue

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

    the optional parameters

Returns:



3026
3027
3028
3029
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 3026

def put_routing_queue(queue_id, body, opts = {})
  data, _status_code, _headers = put_routing_queue_with_http_info(queue_id, body, opts)
  return data
end

#put_routing_queue_with_http_info(queue_id, body, opts = {}) ⇒ Array<(Queue, Fixnum, Hash)>

Update a queue

Parameters:

  • queue_id —

    Queue ID

  • body —

    Queue

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

    the optional parameters

Returns:

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

    Queue data, response status code and response headers



3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 3037

def put_routing_queue_with_http_info(queue_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.put_routing_queue ..."
  end
  
  
  # verify the required parameter 'queue_id' is set
  fail ArgumentError, "Missing the required parameter 'queue_id' when calling RoutingApi.put_routing_queue" if queue_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.put_routing_queue" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/queues/{queueId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Queue')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#put_routing_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_routing_utilization(body, opts = {}) ⇒ Utilization

Update the utilization settings.

Parameters:

  • body —

    utilization

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

    the optional parameters

Returns:



3100
3101
3102
3103
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 3100

def put_routing_utilization(body, opts = {})
  data, _status_code, _headers = put_routing_utilization_with_http_info(body, opts)
  return data
end

#put_routing_utilization_with_http_info(body, opts = {}) ⇒ Array<(Utilization, Fixnum, Hash)>

Update the utilization settings.

Parameters:

  • body —

    utilization

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

    the optional parameters

Returns:

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

    Utilization data, response status code and response headers



3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 3110

def put_routing_utilization_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.put_routing_utilization ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.put_routing_utilization" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/utilization".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Utilization')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#put_routing_utilization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_routing_wrapupcode(code_id, body, opts = {}) ⇒ WrapupCode

Update wrap-up code

Parameters:

  • code_id —

    Wrapup Code ID

  • body —

    WrapupCode

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

    the optional parameters

Returns:



3166
3167
3168
3169
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 3166

def put_routing_wrapupcode(code_id, body, opts = {})
  data, _status_code, _headers = put_routing_wrapupcode_with_http_info(code_id, body, opts)
  return data
end

#put_routing_wrapupcode_with_http_info(code_id, body, opts = {}) ⇒ Array<(WrapupCode, Fixnum, Hash)>

Update wrap-up code

Parameters:

  • code_id —

    Wrapup Code ID

  • body —

    WrapupCode

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

    the optional parameters

Returns:

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

    WrapupCode data, response status code and response headers



3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 3177

def put_routing_wrapupcode_with_http_info(code_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.put_routing_wrapupcode ..."
  end
  
  
  # verify the required parameter 'code_id' is set
  fail ArgumentError, "Missing the required parameter 'code_id' when calling RoutingApi.put_routing_wrapupcode" if code_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.put_routing_wrapupcode" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/wrapupcodes/{codeId}".sub('{format}','json').sub('{' + 'codeId' + '}', code_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'WrapupCode')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#put_routing_wrapupcode\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_user_routingskill(user_id, skill_id, body, opts = {}) ⇒ UserRoutingSkill

Update routing skill proficiency or state.

Parameters:

  • user_id —

    User ID

  • skill_id —

    skillId

  • body —

    Skill

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

    the optional parameters

Returns:



3242
3243
3244
3245
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 3242

def put_user_routingskill(user_id, skill_id, body, opts = {})
  data, _status_code, _headers = put_user_routingskill_with_http_info(user_id, skill_id, body, opts)
  return data
end

#put_user_routingskill_with_http_info(user_id, skill_id, body, opts = {}) ⇒ Array<(UserRoutingSkill, Fixnum, Hash)>

Update routing skill proficiency or state.

Parameters:

  • user_id —

    User ID

  • skill_id —

    skillId

  • body —

    Skill

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

    the optional parameters

Returns:

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

    UserRoutingSkill data, response status code and response headers



3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
 
# File 'lib/purecloudclient_v2a/api/routing_api.rb', line 3254

def put_user_routingskill_with_http_info(user_id, skill_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.put_user_routingskill ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling RoutingApi.put_user_routingskill" if user_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'skill_id' is set
  fail ArgumentError, "Missing the required parameter 'skill_id' when calling RoutingApi.put_user_routingskill" if skill_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.put_user_routingskill" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/users/{userId}/routingskills/{skillId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'skillId' + '}', skill_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserRoutingSkill')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#put_user_routingskill\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end