Class: PureCloud::RoutingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/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_sms_phonenumber(address_id, opts = {}) ⇒ nil

Delete a phone number provisioned for SMS.

Parameters:

  • address_id —

    Address ID

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

    the optional parameters

Returns:

  • (nil) 


455
456
457
458
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 455

def delete_routing_sms_phonenumber(address_id, opts = {})
  delete_routing_sms_phonenumber_with_http_info(address_id, opts)
  return nil
end

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

Delete a phone number provisioned for SMS.

Parameters:

  • address_id —

    Address ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
503
504
505
506
507
508
509
510
511
512
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 465

def delete_routing_sms_phonenumber_with_http_info(address_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.delete_routing_sms_phonenumber ..."
  end
  
  
  # verify the required parameter 'address_id' is set
  fail ArgumentError, "Missing the required parameter 'address_id' when calling RoutingApi.delete_routing_sms_phonenumber" if address_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/sms/phonenumbers/{addressId}".sub('{format}','json').sub('{' + 'addressId' + '}', address_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_sms_phonenumber\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) 


518
519
520
521
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 518

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



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/purecloudplatformclientv2/api/routing_api.rb', line 527

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) 


573
574
575
576
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 573

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



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

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_routinglanguage(user_id, language_id, opts = {}) ⇒ nil

Remove routing language from user

Parameters:

  • user_id —

    User ID

  • language_id —

    languageId

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

    the optional parameters

Returns:

  • (nil) 


638
639
640
641
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 638

def delete_user_routinglanguage(user_id, language_id, opts = {})
  delete_user_routinglanguage_with_http_info(user_id, language_id, opts)
  return nil
end

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

Remove routing language from user

Parameters:

  • user_id —

    User ID

  • language_id —

    languageId

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def delete_user_routinglanguage_with_http_info(user_id, language_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.delete_user_routinglanguage ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling RoutingApi.delete_user_routinglanguage" if user_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'language_id' is set
  fail ArgumentError, "Missing the required parameter 'language_id' when calling RoutingApi.delete_user_routinglanguage" if language_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/users/{userId}/routinglanguages/{languageId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'languageId' + '}', language_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_routinglanguage\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) 


712
713
714
715
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 712

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



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

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:



785
786
787
788
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 785

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:



851
852
853
854
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 851

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



862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 862

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:



928
929
930
931
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 928

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



941
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
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 941

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



795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 795

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:



1016
1017
1018
1019
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1016

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



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

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:



1071
1072
1073
1074
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1071

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



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

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:



1130
1131
1132
1133
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1130

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



1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
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
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1143

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_message_recipient(recipient_id, opts = {}) ⇒ Recipient

Get a recipient

Parameters:

  • recipient_id —

    Recipient ID

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

    the optional parameters

Returns:



1222
1223
1224
1225
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1222

def get_routing_message_recipient(recipient_id, opts = {})
  data, _status_code, _headers = get_routing_message_recipient_with_http_info(recipient_id, opts)
  return data
end

#get_routing_message_recipient_with_http_info(recipient_id, opts = {}) ⇒ Array<(Recipient, Fixnum, Hash)>

Get a recipient

Parameters:

  • recipient_id —

    Recipient ID

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

    the optional parameters

Returns:

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

    Recipient data, response status code and response headers



1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1232

def get_routing_message_recipient_with_http_info(recipient_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_message_recipient ..."
  end
  
  
  # verify the required parameter 'recipient_id' is set
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling RoutingApi.get_routing_message_recipient" if recipient_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/message/recipients/{recipientId}".sub('{format}','json').sub('{' + 'recipientId' + '}', recipient_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 => 'Recipient')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#get_routing_message_recipient\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_routing_message_recipients(opts = {}) ⇒ RecipientListing

Get recipients

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)

Returns:



1288
1289
1290
1291
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1288

def get_routing_message_recipients(opts = {})
  data, _status_code, _headers = get_routing_message_recipients_with_http_info(opts)
  return data
end

#get_routing_message_recipients_with_http_info(opts = {}) ⇒ Array<(RecipientListing, Fixnum, Hash)>

Get recipients

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:

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

    RecipientListing data, response status code and response headers



1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1299

def get_routing_message_recipients_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_message_recipients ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/message/recipients".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']

  # 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 => 'RecipientListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#get_routing_message_recipients\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:



1360
1361
1362
1363
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1360

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:



1426
1427
1428
1429
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1426

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:



1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1437

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:



1500
1501
1502
1503
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1500

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:



1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1511

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:



1585
1586
1587
1588
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1585

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



1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
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
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1606

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



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

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:



1738
1739
1740
1741
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1738

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



1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1748

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:



1807
1808
1809
1810
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1807

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



1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1821

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:



1903
1904
1905
1906
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1903

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



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

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:



1970
1971
1972
1973
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1970

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



1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
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
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1982

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_sms_availablephonenumbers(country_code, phone_number_type, opts = {}) ⇒ SMSAvailablePhoneNumberEntityListing

Get a list of available phone numbers for SMS provisioning. This request will return up to 30 random phone numbers matching the criteria specified. To get additional phone numbers repeat the request.

Parameters:

  • country_code —

    The ISO 3166-1 alpha-2 country code of the county for which available phone numbers should be returned

  • phone_number_type —

    Type of available phone numbers searched

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

    the optional parameters

Options Hash (opts):

  • :region (String) —

    Region/province/state that can be used to restrict the numbers returned

  • :city (String) —

    City that can be used to restrict the numbers returned

  • :area_code (String) —

    Area code that can be used to restrict the numbers returned

  • :pattern (String) —

    A pattern to match phone numbers. Valid characters are &#39;*&#39; and [0-9a-zA-Z]. The &#39;*&#39; character will match any single digit.

  • :address_requirement (String) —

    This indicates whether the phone number requires to have an Address registered.

Returns:



2056
2057
2058
2059
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2056

def get_routing_sms_availablephonenumbers(country_code, phone_number_type, opts = {})
  data, _status_code, _headers = get_routing_sms_availablephonenumbers_with_http_info(country_code, phone_number_type, opts)
  return data
end

#get_routing_sms_availablephonenumbers_with_http_info(country_code, phone_number_type, opts = {}) ⇒ Array<(SMSAvailablePhoneNumberEntityListing, Fixnum, Hash)>

Get a list of available phone numbers for SMS provisioning. This request will return up to 30 random phone numbers matching the criteria specified. To get additional phone numbers repeat the request.

Parameters:

  • country_code —

    The ISO 3166-1 alpha-2 country code of the county for which available phone numbers should be returned

  • phone_number_type —

    Type of available phone numbers searched

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

    the optional parameters

Options Hash (opts):

  • :region (String) —

    Region/province/state that can be used to restrict the numbers returned

  • :city (String) —

    City that can be used to restrict the numbers returned

  • :area_code (String) —

    Area code that can be used to restrict the numbers returned

  • :pattern (String) —

    A pattern to match phone numbers. Valid characters are &#39;*&#39; and [0-9a-zA-Z]. The &#39;*&#39; character will match any single digit.

  • :address_requirement (String) —

    This indicates whether the phone number requires to have an Address registered.

Returns:



2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
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
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2072

def get_routing_sms_availablephonenumbers_with_http_info(country_code, phone_number_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_sms_availablephonenumbers ..."
  end
  
  
  # verify the required parameter 'country_code' is set
  fail ArgumentError, "Missing the required parameter 'country_code' when calling RoutingApi.get_routing_sms_availablephonenumbers" if country_code.nil?
  
  
  
  
  
  
  # verify the required parameter 'phone_number_type' is set
  fail ArgumentError, "Missing the required parameter 'phone_number_type' when calling RoutingApi.get_routing_sms_availablephonenumbers" if phone_number_type.nil?
  
  # verify enum value
  unless ['local', 'mobile', 'tollfree'].include?(phone_number_type)
    fail ArgumentError, "invalid value for 'phone_number_type', must be one of local, mobile, tollfree"
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'address_requirement'] && !['none', 'any', 'local', 'foreign'].include?(opts[:'address_requirement'])
    fail ArgumentError, 'invalid value for "address_requirement", must be one of none, any, local, foreign'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/sms/availablephonenumbers".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'countryCode'] = country_code
  query_params[:'phoneNumberType'] = phone_number_type
  query_params[:'region'] = opts[:'region'] if opts[:'region']
  query_params[:'city'] = opts[:'city'] if opts[:'city']
  query_params[:'areaCode'] = opts[:'area_code'] if opts[:'area_code']
  query_params[:'pattern'] = opts[:'pattern'] if opts[:'pattern']
  query_params[:'addressRequirement'] = opts[:'address_requirement'] if opts[:'address_requirement']

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

#get_routing_sms_phonenumber(address_id, opts = {}) ⇒ SmsPhoneNumber

Get a phone number provisioned for SMS.

Parameters:

  • address_id —

    Address ID

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

    the optional parameters

Returns:



2181
2182
2183
2184
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2181

def get_routing_sms_phonenumber(address_id, opts = {})
  data, _status_code, _headers = get_routing_sms_phonenumber_with_http_info(address_id, opts)
  return data
end

#get_routing_sms_phonenumber_with_http_info(address_id, opts = {}) ⇒ Array<(SmsPhoneNumber, Fixnum, Hash)>

Get a phone number provisioned for SMS.

Parameters:

  • address_id —

    Address ID

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

    the optional parameters

Returns:

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

    SmsPhoneNumber data, response status code and response headers



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
2235
2236
2237
2238
2239
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2191

def get_routing_sms_phonenumber_with_http_info(address_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_sms_phonenumber ..."
  end
  
  
  # verify the required parameter 'address_id' is set
  fail ArgumentError, "Missing the required parameter 'address_id' when calling RoutingApi.get_routing_sms_phonenumber" if address_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/sms/phonenumbers/{addressId}".sub('{format}','json').sub('{' + 'addressId' + '}', address_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 => 'SmsPhoneNumber')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#get_routing_sms_phonenumber\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_routing_sms_phonenumbers(opts = {}) ⇒ SmsPhoneNumberEntityListing

Get a list of provisioned phone numbers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :phone_number (String) —

    Filter on phone number address. Allowable characters are the digits &#39;0-9&#39; and the wild card character &#39;*&#39;. If just digits are present, a contains search is done on the address pattern. For example, &#39;317&#39; could be matched anywhere in the address. An &#39;*&#39; will match multiple digits. For example, to match a specific area code within the US a pattern like &#39;1317*&#39; could be used.

  • :phone_number_type (String) —

    Filter on phone number type

  • :phone_number_status (String) —

    Filter on phone number status

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

Returns:



2250
2251
2252
2253
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2250

def get_routing_sms_phonenumbers(opts = {})
  data, _status_code, _headers = get_routing_sms_phonenumbers_with_http_info(opts)
  return data
end

#get_routing_sms_phonenumbers_with_http_info(opts = {}) ⇒ Array<(SmsPhoneNumberEntityListing, Fixnum, Hash)>

Get a list of provisioned phone numbers.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :phone_number (String) —

    Filter on phone number address. Allowable characters are the digits &#39;0-9&#39; and the wild card character &#39;*&#39;. If just digits are present, a contains search is done on the address pattern. For example, &#39;317&#39; could be matched anywhere in the address. An &#39;*&#39; will match multiple digits. For example, to match a specific area code within the US a pattern like &#39;1317*&#39; could be used.

  • :phone_number_type (String) —

    Filter on phone number type

  • :phone_number_status (String) —

    Filter on phone number status

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:



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
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
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
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2264

def get_routing_sms_phonenumbers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_sms_phonenumbers ..."
  end
  
  
  
  
  
  
  
  
  
  
  if opts[:'phone_number_type'] && !['local', 'mobile', 'tollfree'].include?(opts[:'phone_number_type'])
    fail ArgumentError, 'invalid value for "phone_number_type", must be one of local, mobile, tollfree'
  end
  
  
  
  
  
  
  
  if opts[:'phone_number_status'] && !['active', 'invalid', 'porting'].include?(opts[:'phone_number_status'])
    fail ArgumentError, 'invalid value for "phone_number_status", must be one of active, invalid, porting'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/sms/phonenumbers".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'phoneNumber'] = opts[:'phone_number'] if opts[:'phone_number']
  query_params[:'phoneNumberType'] = opts[:'phone_number_type'] if opts[:'phone_number_type']
  query_params[:'phoneNumberStatus'] = opts[:'phone_number_status'] if opts[:'phone_number_status']
  query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
  query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']

  # 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 => 'SmsPhoneNumberEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#get_routing_sms_phonenumbers\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:



2353
2354
2355
2356
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2353

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



2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2362

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:



2409
2410
2411
2412
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2409

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



2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2419

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:



2477
2478
2479
2480
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2477

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



2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
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
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2490

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_routinglanguages(user_id, opts = {}) ⇒ UserLanguageEntityListing

List routing language 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:



2568
2569
2570
2571
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2568

def get_user_routinglanguages(user_id, opts = {})
  data, _status_code, _headers = get_user_routinglanguages_with_http_info(user_id, opts)
  return data
end

#get_user_routinglanguages_with_http_info(user_id, opts = {}) ⇒ Array<(UserLanguageEntityListing, Fixnum, Hash)>

List routing language 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<(UserLanguageEntityListing, Fixnum, Hash)>) —

    UserLanguageEntityListing data, response status code and response headers



2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
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
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2581

def get_user_routinglanguages_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_user_routinglanguages ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling RoutingApi.get_user_routinglanguages" 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}/routinglanguages".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 => 'UserLanguageEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#get_user_routinglanguages\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:



2664
2665
2666
2667
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2664

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



2677
2678
2679
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
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2677

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:



2759
2760
2761
2762
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2759

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



2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
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
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2771

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:



2843
2844
2845
2846
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2843

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



2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
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
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2854

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

#patch_user_routinglanguage(user_id, language_id, body, opts = {}) ⇒ UserRoutingLanguage

Update routing language proficiency or state.

Parameters:

  • user_id —

    User ID

  • language_id —

    languageId

  • body —

    Language

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

    the optional parameters

Returns:



2919
2920
2921
2922
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2919

def patch_user_routinglanguage(user_id, language_id, body, opts = {})
  data, _status_code, _headers = patch_user_routinglanguage_with_http_info(user_id, language_id, body, opts)
  return data
end

#patch_user_routinglanguage_with_http_info(user_id, language_id, body, opts = {}) ⇒ Array<(UserRoutingLanguage, Fixnum, Hash)>

Update routing language proficiency or state.

Parameters:

  • user_id —

    User ID

  • language_id —

    languageId

  • body —

    Language

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

    the optional parameters

Returns:

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

    UserRoutingLanguage data, response status code and response headers



2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
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
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2931

def patch_user_routinglanguage_with_http_info(user_id, language_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.patch_user_routinglanguage ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling RoutingApi.patch_user_routinglanguage" if user_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'language_id' is set
  fail ArgumentError, "Missing the required parameter 'language_id' when calling RoutingApi.patch_user_routinglanguage" if language_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.patch_user_routinglanguage" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/users/{userId}/routinglanguages/{languageId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'languageId' + '}', language_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 => 'UserRoutingLanguage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#patch_user_routinglanguage\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:



3002
3003
3004
3005
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3002

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:



3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3012

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:



3068
3069
3070
3071
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3068

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



3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
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
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3079

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:



3142
3143
3144
3145
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3142

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



3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3152

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:



3207
3208
3209
3210
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3207

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



3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3217

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) 


3274
3275
3276
3277
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3274

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



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
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3286

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:



3357
3358
3359
3360
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3357

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



3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3368

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:



3431
3432
3433
3434
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3431

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



3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3441

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:



3496
3497
3498
3499
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3496

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



3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3506

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_sms_addresses(body, opts = {}) ⇒ SmsPhoneNumber

Provision an Address for SMS

Parameters:

  • body —

    SmsAddress

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

    the optional parameters

Returns:



3561
3562
3563
3564
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3561

def post_routing_sms_addresses(body, opts = {})
  data, _status_code, _headers = post_routing_sms_addresses_with_http_info(body, opts)
  return data
end

#post_routing_sms_addresses_with_http_info(body, opts = {}) ⇒ Array<(SmsPhoneNumber, Fixnum, Hash)>

Provision an Address for SMS

Parameters:

  • body —

    SmsAddress

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

    the optional parameters

Returns:

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

    SmsPhoneNumber data, response status code and response headers



3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3571

def post_routing_sms_addresses_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.post_routing_sms_addresses ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.post_routing_sms_addresses" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/sms/addresses".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 => 'SmsPhoneNumber')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#post_routing_sms_addresses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_routing_sms_phonenumbers(body, opts = {}) ⇒ SmsPhoneNumber

Provision a phone number for SMS

Parameters:

  • body —

    SmsPhoneNumber

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

    the optional parameters

Returns:



3626
3627
3628
3629
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3626

def post_routing_sms_phonenumbers(body, opts = {})
  data, _status_code, _headers = post_routing_sms_phonenumbers_with_http_info(body, opts)
  return data
end

#post_routing_sms_phonenumbers_with_http_info(body, opts = {}) ⇒ Array<(SmsPhoneNumber, Fixnum, Hash)>

Provision a phone number for SMS

Parameters:

  • body —

    SmsPhoneNumber

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

    the optional parameters

Returns:

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

    SmsPhoneNumber data, response status code and response headers



3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3636

def post_routing_sms_phonenumbers_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.post_routing_sms_phonenumbers ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.post_routing_sms_phonenumbers" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/sms/phonenumbers".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 => 'SmsPhoneNumber')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#post_routing_sms_phonenumbers\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:



3691
3692
3693
3694
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3691

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



3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3701

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_routinglanguages(user_id, body, opts = {}) ⇒ UserRoutingLanguage

Add routing language to user

Parameters:

  • user_id —

    User ID

  • body —

    Language

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

    the optional parameters

Returns:



3757
3758
3759
3760
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3757

def post_user_routinglanguages(user_id, body, opts = {})
  data, _status_code, _headers = post_user_routinglanguages_with_http_info(user_id, body, opts)
  return data
end

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

Add routing language to user

Parameters:

  • user_id —

    User ID

  • body —

    Language

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

    the optional parameters

Returns:

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

    UserRoutingLanguage data, response status code and response headers



3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3768

def post_user_routinglanguages_with_http_info(user_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.post_user_routinglanguages ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling RoutingApi.post_user_routinglanguages" if user_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.post_user_routinglanguages" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/users/{userId}/routinglanguages".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 => 'UserRoutingLanguage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#post_user_routinglanguages\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:



3832
3833
3834
3835
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3832

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



3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3843

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:



3908
3909
3910
3911
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3908

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



3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3920

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_message_recipient(recipient_id, body, opts = {}) ⇒ Recipient

Update a recipient

Parameters:

  • recipient_id —

    Recipient ID

  • body —

    Recipient

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

    the optional parameters

Returns:



3992
3993
3994
3995
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3992

def put_routing_message_recipient(recipient_id, body, opts = {})
  data, _status_code, _headers = put_routing_message_recipient_with_http_info(recipient_id, body, opts)
  return data
end

#put_routing_message_recipient_with_http_info(recipient_id, body, opts = {}) ⇒ Array<(Recipient, Fixnum, Hash)>

Update a recipient

Parameters:

  • recipient_id —

    Recipient ID

  • body —

    Recipient

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

    the optional parameters

Returns:

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

    Recipient data, response status code and response headers



4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4003

def put_routing_message_recipient_with_http_info(recipient_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.put_routing_message_recipient ..."
  end
  
  
  # verify the required parameter 'recipient_id' is set
  fail ArgumentError, "Missing the required parameter 'recipient_id' when calling RoutingApi.put_routing_message_recipient" if recipient_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.put_routing_message_recipient" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/message/recipients/{recipientId}".sub('{format}','json').sub('{' + 'recipientId' + '}', recipient_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 => 'Recipient')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#put_routing_message_recipient\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:



4067
4068
4069
4070
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4067

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



4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4078

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_sms_phonenumber(address_id, body, opts = {}) ⇒ SmsPhoneNumber

Update a phone number provisioned for SMS.

Parameters:

  • address_id —

    Address ID

  • body —

    SmsPhoneNumber

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

    the optional parameters

Returns:



4142
4143
4144
4145
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4142

def put_routing_sms_phonenumber(address_id, body, opts = {})
  data, _status_code, _headers = put_routing_sms_phonenumber_with_http_info(address_id, body, opts)
  return data
end

#put_routing_sms_phonenumber_with_http_info(address_id, body, opts = {}) ⇒ Array<(SmsPhoneNumber, Fixnum, Hash)>

Update a phone number provisioned for SMS.

Parameters:

  • address_id —

    Address ID

  • body —

    SmsPhoneNumber

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

    the optional parameters

Returns:

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

    SmsPhoneNumber data, response status code and response headers



4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4153

def put_routing_sms_phonenumber_with_http_info(address_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.put_routing_sms_phonenumber ..."
  end
  
  
  # verify the required parameter 'address_id' is set
  fail ArgumentError, "Missing the required parameter 'address_id' when calling RoutingApi.put_routing_sms_phonenumber" if address_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.put_routing_sms_phonenumber" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/sms/phonenumbers/{addressId}".sub('{format}','json').sub('{' + 'addressId' + '}', address_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 => 'SmsPhoneNumber')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#put_routing_sms_phonenumber\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:



4216
4217
4218
4219
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4216

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



4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4226

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:



4282
4283
4284
4285
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4282

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



4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4293

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:



4358
4359
4360
4361
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4358

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



4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4370

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