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 OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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 OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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 OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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 OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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 OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#delete_routing_queue_wrapupcode\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_routing_settings(opts = {}) ⇒ nil

Delete an organization’s routing settings

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


390
391
392
393
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 390

def delete_routing_settings(opts = {})
  delete_routing_settings_with_http_info(opts)
  return nil
end

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

Delete an organization&#39;s routing settings

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def delete_routing_settings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.delete_routing_settings ..."
  end
  
  # resource path
  local_var_path = "/api/v2/routing/settings".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 OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#delete_routing_settings\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) 


445
446
447
448
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 445

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



455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 455

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 OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#delete_routing_skill\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_routing_sms_address(address_id, opts = {}) ⇒ nil

Delete an Address by Id for SMS

Parameters:

  • address_id —

    Address ID

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_routing_sms_address(address_id, opts = {})
  delete_routing_sms_address_with_http_info(address_id, opts)
  return nil
end

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

Delete an Address by Id 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



519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 519

def delete_routing_sms_address_with_http_info(address_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.delete_routing_sms_address ..."
  end
  
  
  # verify the required parameter 'address_id' is set
  fail ArgumentError, "Missing the required parameter 'address_id' when calling RoutingApi.delete_routing_sms_address" if address_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/sms/addresses/{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 OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#delete_routing_sms_address\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) 


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

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



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_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 OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#delete_routing_sms_phonenumber\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_routing_user_utilization(user_id, opts = {}) ⇒ nil

Delete the user’s max utilization settings and revert to the organization-wide default.

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:

  • (nil) 


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

def delete_routing_user_utilization(user_id, opts = {})
  delete_routing_user_utilization_with_http_info(user_id, opts)
  return nil
end

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

Delete the user&#39;s max utilization settings and revert to the organization-wide default.

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def delete_routing_user_utilization_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.delete_routing_user_utilization ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling RoutingApi.delete_routing_user_utilization" if user_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/users/{userId}/utilization".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 = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#delete_routing_user_utilization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_routing_utilization(opts = {}) ⇒ nil

Delete the organization-wide max utilization settings and revert to the system default.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


700
701
702
703
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 700

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 the organization-wide max utilization settings and revert to the system default.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 709

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 OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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) 


755
756
757
758
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 755

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



765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 765

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 OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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) 


820
821
822
823
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 820

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



831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 831

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 OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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) 


894
895
896
897
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 894

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



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

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 OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: 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:



967
968
969
970
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 967

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:



1033
1034
1035
1036
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1033

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



1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1044

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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



1110
1111
1112
1113
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1110

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



1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1123

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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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



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
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 977

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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



1198
1199
1200
1201
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1198

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



1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1207

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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



1253
1254
1255
1256
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1253

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



1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1262

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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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

  • :id (Array<String>) —

    id

Returns:



1313
1314
1315
1316
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1313

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

  • :id (Array<String>) —

    id

Returns:

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

    LanguageEntityListing data, response status code and response headers



1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1327

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']
  query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



1413
1414
1415
1416
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1413

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



1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1423

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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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):

  • :messenger_type (String) —

    Messenger Type

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

Returns:



1480
1481
1482
1483
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1480

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

  • :messenger_type (String) —

    Messenger Type

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:

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

    RecipientListing data, response status code and response headers



1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1492

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
  
  
  
  
  if opts[:'messenger_type'] && !['sms', 'facebook', 'twitter', 'line', 'whatsapp'].include?(opts[:'messenger_type'])
    fail ArgumentError, 'invalid value for "messenger_type", must be one of sms, facebook, twitter, line, whatsapp'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/message/recipients".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'messengerType'] = opts[:'messenger_type'] if opts[:'messenger_type']
  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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



1564
1565
1566
1567
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1564

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:



1630
1631
1632
1633
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1630

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:



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

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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



1704
1705
1706
1707
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1704

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:



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

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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



1789
1790
1791
1792
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1789

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



1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
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
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1810

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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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



1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1574

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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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

Options Hash (opts):

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

Returns:



1944
1945
1946
1947
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1944

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

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:

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

    WrapupCodeEntityListing data, response status code and response headers



1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
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
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 1956

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 = {}
  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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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

  • :id (Array<String>) —

    ID(s)

  • :division_id (Array<String>) —

    Division ID(s)

Returns:



2030
2031
2032
2033
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2030

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

#get_routing_queues_divisionviews(opts = {}) ⇒ QueueEntityListing

Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size [max value is 100] (default to 25)

  • :page_number (Integer) —

    Page number [max value is 5] (default to 1)

  • :sort_by (String) —

    Sort by (default to name)

  • :sort_order (String) —

    Sort order (default to asc)

  • :name (String) —

    Name

  • :id (Array<String>) —

    Queue ID(s)

  • :division_id (Array<String>) —

    Division ID(s)

Returns:



2140
2141
2142
2143
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2140

def get_routing_queues_divisionviews(opts = {})
  data, _status_code, _headers = get_routing_queues_divisionviews_with_http_info(opts)
  return data
end

#get_routing_queues_divisionviews_all(opts = {}) ⇒ QueueEntityListing

Get a paged listing of simplified queue objects. Can be used to get a digest of all queues in an organization.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size [max value is 500] (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :sort_by (String) —

    Sort by (default to name)

  • :sort_order (String) —

    Sort order (default to asc)

Returns:



2263
2264
2265
2266
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2263

def get_routing_queues_divisionviews_all(opts = {})
  data, _status_code, _headers = get_routing_queues_divisionviews_all_with_http_info(opts)
  return data
end

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

Get a paged listing of simplified queue objects. Can be used to get a digest of all queues in an organization.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size [max value is 500]

  • :page_number (Integer) —

    Page number

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:

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

    QueueEntityListing data, response status code and response headers



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
2348
2349
2350
2351
2352
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2276

def get_routing_queues_divisionviews_all_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_queues_divisionviews_all ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_by'] && !['name', 'id', 'divisionId'].include?(opts[:'sort_by'])
    fail ArgumentError, 'invalid value for "sort_by", must be one of name, id, divisionId'
  end
  
  
  
  
  
  
  
  if opts[:'sort_order'] && !['asc', 'desc', 'score'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of asc, desc, score'
  end
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/queues/divisionviews/all".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[:'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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'QueueEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#get_routing_queues_divisionviews_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size [max value is 100]

  • :page_number (Integer) —

    Page number [max value is 5]

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

  • :name (String) —

    Name

  • :id (Array<String>) —

    Queue ID(s)

  • :division_id (Array<String>) —

    Division ID(s)

Returns:

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

    QueueEntityListing data, response status code and response headers



2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2156

def get_routing_queues_divisionviews_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_queues_divisionviews ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_by'] && !['name', 'id', 'divisionId'].include?(opts[:'sort_by'])
    fail ArgumentError, 'invalid value for "sort_by", must be one of name, id, divisionId'
  end
  
  
  
  
  
  
  
  if opts[:'sort_order'] && !['asc', 'desc', 'score'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of asc, desc, score'
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/queues/divisionviews".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[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'name'] = opts[:'name'] if opts[:'name']
  query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
  query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'QueueEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#get_routing_queues_divisionviews\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_routing_queues_me(opts = {}) ⇒ UserQueueEntityListing

Get a paged listing of queues the user is a member of.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :joined (BOOLEAN) —

    Joined

  • :page_size (Integer) —

    Page size (default to 25)

  • :page_number (Integer) —

    Page number (default to 1)

  • :sort_by (String) —

    Sort by (default to name)

  • :sort_order (String) —

    Sort order (default to asc)

Returns:



2363
2364
2365
2366
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2363

def get_routing_queues_me(opts = {})
  data, _status_code, _headers = get_routing_queues_me_with_http_info(opts)
  return data
end

#get_routing_queues_me_with_http_info(opts = {}) ⇒ Array<(UserQueueEntityListing, Fixnum, Hash)>

Get a paged listing of queues the user is a member of.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :joined (BOOLEAN) —

    Joined

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :sort_by (String) —

    Sort by

  • :sort_order (String) —

    Sort order

Returns:

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

    UserQueueEntityListing data, response status code and response headers



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
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2377

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

  # query parameters
  query_params = {}
  query_params[:'joined'] = opts[:'joined'] if opts[:'joined']
  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[:'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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserQueueEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#get_routing_queues_me\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
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

  • :id (Array<String>) —

    ID(s)

  • :division_id (Array<String>) —

    Division ID(s)

Returns:

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

    QueueEntityListing data, response status code and response headers



2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
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
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2045

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[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
  query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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_settings(opts = {}) ⇒ RoutingSettings

Get an organization’s routing settings

Parameters:

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

    the optional parameters

Returns:



2458
2459
2460
2461
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2458

def get_routing_settings(opts = {})
  data, _status_code, _headers = get_routing_settings_with_http_info(opts)
  return data
end

#get_routing_settings_contactcenter(opts = {}) ⇒ ContactCenterSettings

Get Contact Center Settings

Parameters:

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

    the optional parameters

Returns:



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

def get_routing_settings_contactcenter(opts = {})
  data, _status_code, _headers = get_routing_settings_contactcenter_with_http_info(opts)
  return data
end

#get_routing_settings_contactcenter_with_http_info(opts = {}) ⇒ Array<(ContactCenterSettings, Fixnum, Hash)>

Get Contact Center Settings

Parameters:

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

    the optional parameters

Returns:

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

    ContactCenterSettings data, response status code and response headers



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
2559
2560
2561
2562
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2522

def get_routing_settings_contactcenter_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_settings_contactcenter ..."
  end
  
  # resource path
  local_var_path = "/api/v2/routing/settings/contactcenter".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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ContactCenterSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#get_routing_settings_contactcenter\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_routing_settings_transcription(opts = {}) ⇒ TranscriptionSettings

Get Transcription Settings

Parameters:

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

    the optional parameters

Returns:



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

def get_routing_settings_transcription(opts = {})
  data, _status_code, _headers = get_routing_settings_transcription_with_http_info(opts)
  return data
end

#get_routing_settings_transcription_with_http_info(opts = {}) ⇒ Array<(TranscriptionSettings, Fixnum, Hash)>

Get Transcription Settings

Parameters:

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

    the optional parameters

Returns:

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

    TranscriptionSettings data, response status code and response headers



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

def get_routing_settings_transcription_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_settings_transcription ..."
  end
  
  # resource path
  local_var_path = "/api/v2/routing/settings/transcription".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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TranscriptionSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#get_routing_settings_transcription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_routing_settings_with_http_info(opts = {}) ⇒ Array<(RoutingSettings, Fixnum, Hash)>

Get an organization&#39;s routing settings

Parameters:

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

    the optional parameters

Returns:

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

    RoutingSettings data, response status code and response headers



2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2467

def get_routing_settings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_settings ..."
  end
  
  # resource path
  local_var_path = "/api/v2/routing/settings".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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RoutingSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#get_routing_settings\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:



2624
2625
2626
2627
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2624

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



2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2634

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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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

  • :id (Array<String>) —

    id

Returns:



2692
2693
2694
2695
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2692

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

  • :id (Array<String>) —

    id

Returns:

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

    SkillEntityListing data, response status code and response headers



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
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2705

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']
  query_params[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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_address(address_id, opts = {}) ⇒ SmsAddress

Get an Address by Id for SMS

Parameters:

  • address_id —

    Address ID

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

    the optional parameters

Returns:



2780
2781
2782
2783
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2780

def get_routing_sms_address(address_id, opts = {})
  data, _status_code, _headers = get_routing_sms_address_with_http_info(address_id, opts)
  return data
end

#get_routing_sms_address_with_http_info(address_id, opts = {}) ⇒ Array<(SmsAddress, Fixnum, Hash)>

Get an Address by Id for SMS

Parameters:

  • address_id —

    Address ID

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

    the optional parameters

Returns:

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

    SmsAddress data, response status code and response headers



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

def get_routing_sms_address_with_http_info(address_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_sms_address ..."
  end
  
  
  # verify the required parameter 'address_id' is set
  fail ArgumentError, "Missing the required parameter 'address_id' when calling RoutingApi.get_routing_sms_address" if address_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/sms/addresses/{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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SmsAddress')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#get_routing_sms_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_routing_sms_addresses(opts = {}) ⇒ SmsAddressEntityListing

Get a list of Addresses for SMS

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:



2846
2847
2848
2849
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2846

def get_routing_sms_addresses(opts = {})
  data, _status_code, _headers = get_routing_sms_addresses_with_http_info(opts)
  return data
end

#get_routing_sms_addresses_with_http_info(opts = {}) ⇒ Array<(SmsAddressEntityListing, Fixnum, Hash)>

Get a list of Addresses for SMS

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

Returns:

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

    SmsAddressEntityListing data, response status code and response headers



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

def get_routing_sms_addresses_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_sms_addresses ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/sms/addresses".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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SmsAddressEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#get_routing_sms_addresses\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:



2924
2925
2926
2927
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2924

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:



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
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
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
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 2940

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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



3049
3050
3051
3052
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3049

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



3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3059

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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



3118
3119
3120
3121
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3118

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:



3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
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
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3132

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', 'shortcode'].include?(opts[:'phone_number_type'])
    fail ArgumentError, 'invalid value for "phone_number_type", must be one of local, mobile, tollfree, shortcode'
  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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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_user_utilization(user_id, opts = {}) ⇒ Utilization

Get the user’s max utilization settings. If not configured, the organization-wide default is returned.

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:



3222
3223
3224
3225
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3222

def get_routing_user_utilization(user_id, opts = {})
  data, _status_code, _headers = get_routing_user_utilization_with_http_info(user_id, opts)
  return data
end

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

Get the user&#39;s max utilization settings. If not configured, the organization-wide default is returned.

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:

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

    Utilization data, response status code and response headers



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
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3232

def get_routing_user_utilization_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_routing_user_utilization ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling RoutingApi.get_routing_user_utilization" if user_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/users/{userId}/utilization".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 = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Utilization')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#get_routing_user_utilization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_routing_utilization(opts = {}) ⇒ Utilization

Get the organization-wide max utilization settings.

Parameters:

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

    the optional parameters

Returns:



3286
3287
3288
3289
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3286

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 organization-wide max utilization settings.

Parameters:

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

    the optional parameters

Returns:

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

    Utilization data, response status code and response headers



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

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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



3342
3343
3344
3345
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3342

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



3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
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
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3352

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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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)

  • :sort_by (String) —

    Sort by (default to name)

  • :name (String) —

    Name

Returns:



3410
3411
3412
3413
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3410

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

  • :sort_by (String) —

    Sort by

  • :name (String) —

    Name

Returns:

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

    WrapupCodeEntityListing data, response status code and response headers



3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
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
3490
3491
3492
3493
3494
3495
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3423

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
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  if opts[:'sort_by'] && !['name', 'id'].include?(opts[:'sort_by'])
    fail ArgumentError, 'invalid value for "sort_by", must be one of name, id'
  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[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
  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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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_queues(user_id, opts = {}) ⇒ UserQueueEntityListing

Get queues 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)

  • :joined (BOOLEAN) —

    Is joined to the queue (default to true)

  • :division_id (Array<String>) —

    Division ID(s)

Returns:



3506
3507
3508
3509
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3506

def get_user_queues(user_id, opts = {})
  data, _status_code, _headers = get_user_queues_with_http_info(user_id, opts)
  return data
end

#get_user_queues_with_http_info(user_id, opts = {}) ⇒ Array<(UserQueueEntityListing, Fixnum, Hash)>

Get queues 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

  • :joined (BOOLEAN) —

    Is joined to the queue

  • :division_id (Array<String>) —

    Division ID(s)

Returns:

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

    UserQueueEntityListing data, response status code and response headers



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
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
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
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3520

def get_user_queues_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.get_user_queues ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling RoutingApi.get_user_queues" if user_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/users/{userId}/queues".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[:'joined'] = opts[:'joined'] if opts[:'joined']
  query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserQueueEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#get_user_queues\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:



3606
3607
3608
3609
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3606

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



3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
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
3685
3686
3687
3688
3689
3690
3691
3692
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3619

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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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:



3702
3703
3704
3705
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3702

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



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
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3715

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 OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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_email_domain(domain_id, body, opts = {}) ⇒ InboundDomain

Update domain settings

Parameters:

  • domain_id —

    domain ID

  • body —

    Domain settings

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

    the optional parameters

Returns:



3796
3797
3798
3799
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3796

def patch_routing_email_domain(domain_id, body, opts = {})
  data, _status_code, _headers = patch_routing_email_domain_with_http_info(domain_id, body, opts)
  return data
end

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

Update domain settings

Parameters:

  • domain_id —

    domain ID

  • body —

    Domain settings

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

    the optional parameters

Returns:

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

    InboundDomain data, response status code and response headers



3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3807

def patch_routing_email_domain_with_http_info(domain_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.patch_routing_email_domain ..."
  end
  
  
  # verify the required parameter 'domain_id' is set
  fail ArgumentError, "Missing the required parameter 'domain_id' when calling RoutingApi.patch_routing_email_domain" if domain_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.patch_routing_email_domain" if body.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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  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 => 'InboundDomain')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#patch_routing_email_domain\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 OR 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:



3872
3873
3874
3875
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3872

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 OR 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



3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
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
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3884

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 OAuth']
  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:



3956
3957
3958
3959
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3956

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



3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 3967

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 OAuth']
  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_routing_settings_contactcenter(body, opts = {}) ⇒ nil

Update Contact Center Settings

Parameters:

  • body —

    Contact Center Settings

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

    the optional parameters

Returns:

  • (nil) 


4030
4031
4032
4033
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4030

def patch_routing_settings_contactcenter(body, opts = {})
  patch_routing_settings_contactcenter_with_http_info(body, opts)
  return nil
end

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

Update Contact Center Settings

Parameters:

  • body —

    Contact Center Settings

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4040

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

#patch_user_queue(queue_id, user_id, body, opts = {}) ⇒ UserQueue

Join or unjoin a queue for a user

Parameters:

  • queue_id —

    Queue ID

  • user_id —

    User ID

  • body —

    Queue Member

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

    the optional parameters

Returns:



4096
4097
4098
4099
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4096

def patch_user_queue(queue_id, user_id, body, opts = {})
  data, _status_code, _headers = patch_user_queue_with_http_info(queue_id, user_id, body, opts)
  return data
end

#patch_user_queue_with_http_info(queue_id, user_id, body, opts = {}) ⇒ Array<(UserQueue, Fixnum, Hash)>

Join or unjoin a queue for a user

Parameters:

  • queue_id —

    Queue ID

  • user_id —

    User ID

  • body —

    Queue Member

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

    the optional parameters

Returns:

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

    UserQueue data, response status code and response headers



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
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4108

def patch_user_queue_with_http_info(queue_id, user_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.patch_user_queue ..."
  end
  
  
  # verify the required parameter 'queue_id' is set
  fail ArgumentError, "Missing the required parameter 'queue_id' when calling RoutingApi.patch_user_queue" if queue_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling RoutingApi.patch_user_queue" if user_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.patch_user_queue" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/users/{userId}/queues/{queueId}".sub('{format}','json').sub('{' + 'queueId' + '}', queue_id.to_s).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 OAuth']
  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 => 'UserQueue')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#patch_user_queue\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_user_queues(user_id, body, opts = {}) ⇒ UserQueueEntityListing

Join or unjoin a set of queues for a user

Parameters:

  • user_id —

    User ID

  • body —

    User Queues

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

    the optional parameters

Options Hash (opts):

  • :division_id (Array<String>) —

    Division ID(s)

Returns:



4181
4182
4183
4184
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4181

def patch_user_queues(user_id, body, opts = {})
  data, _status_code, _headers = patch_user_queues_with_http_info(user_id, body, opts)
  return data
end

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

Join or unjoin a set of queues for a user

Parameters:

  • user_id —

    User ID

  • body —

    User Queues

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

    the optional parameters

Options Hash (opts):

  • :division_id (Array<String>) —

    Division ID(s)

Returns:

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

    UserQueueEntityListing data, response status code and response headers



4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
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
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4193

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

  # query parameters
  query_params = {}
  query_params[:'divisionId'] = @api_client.build_collection_param(opts[:'division_id'], :multi) if opts[:'division_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 = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  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 => 'UserQueueEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#patch_user_queues\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:



4265
4266
4267
4268
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4265

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



4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
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
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4277

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 OAuth']
  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

#patch_user_routinglanguages_bulk(user_id, body, opts = {}) ⇒ UserLanguageEntityListing

Add bulk routing language to user. Max limit 50 languages

Parameters:

  • user_id —

    User ID

  • body —

    Language

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

    the optional parameters

Returns:



4349
4350
4351
4352
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4349

def patch_user_routinglanguages_bulk(user_id, body, opts = {})
  data, _status_code, _headers = patch_user_routinglanguages_bulk_with_http_info(user_id, body, opts)
  return data
end

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

Add bulk routing language to user. Max limit 50 languages

Parameters:

  • user_id —

    User ID

  • body —

    Language

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

    the optional parameters

Returns:

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

    UserLanguageEntityListing data, response status code and response headers



4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
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
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4360

def patch_user_routinglanguages_bulk_with_http_info(user_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.patch_user_routinglanguages_bulk ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling RoutingApi.patch_user_routinglanguages_bulk" if user_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.patch_user_routinglanguages_bulk" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/users/{userId}/routinglanguages/bulk".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 OAuth']
  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 => 'UserLanguageEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#patch_user_routinglanguages_bulk\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_user_routingskills_bulk(user_id, body, opts = {}) ⇒ UserSkillEntityListing

Bulk add routing skills to user

Parameters:

  • user_id —

    User ID

  • body —

    Skill

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

    the optional parameters

Returns:



4424
4425
4426
4427
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4424

def patch_user_routingskills_bulk(user_id, body, opts = {})
  data, _status_code, _headers = patch_user_routingskills_bulk_with_http_info(user_id, body, opts)
  return data
end

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

Bulk add routing skills to user

Parameters:

  • user_id —

    User ID

  • body —

    Skill

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

    the optional parameters

Returns:

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

    UserSkillEntityListing data, response status code and response headers



4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4435

def patch_user_routingskills_bulk_with_http_info(user_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.patch_user_routingskills_bulk ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling RoutingApi.patch_user_routingskills_bulk" if user_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.patch_user_routingskills_bulk" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/users/{userId}/routingskills/bulk".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 OAuth']
  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 => 'UserSkillEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#patch_user_routingskills_bulk\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Query for queue observations

Parameters:

  • body —

    query

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

    the optional parameters

Returns:



4498
4499
4500
4501
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4498

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<(QueueObservationQueryResponse, Fixnum, Hash)>

Query for queue observations

Parameters:

  • body —

    query

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

    the optional parameters

Returns:



4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4508

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 OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'QueueObservationQueryResponse')
  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:



4564
4565
4566
4567
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4564

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



4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4575

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 OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :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_domain_testconnection(domain_id, opts = {}) ⇒ TestMessage

Tests the custom SMTP server integration connection set on this domain The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server. If the body is specified, there will be an attempt to send an email message to the server.

Parameters:

  • domain_id —

    domain ID

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

    the optional parameters

Options Hash (opts):

Returns:



4639
4640
4641
4642
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4639

def post_routing_email_domain_testconnection(domain_id, opts = {})
  data, _status_code, _headers = post_routing_email_domain_testconnection_with_http_info(domain_id, opts)
  return data
end

#post_routing_email_domain_testconnection_with_http_info(domain_id, opts = {}) ⇒ Array<(TestMessage, Fixnum, Hash)>

Tests the custom SMTP server integration connection set on this domain The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server. If the body is specified, there will be an attempt to send an email message to the server.

Parameters:

  • domain_id —

    domain ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    TestMessage data, response status code and response headers



4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4650

def post_routing_email_domain_testconnection_with_http_info(domain_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.post_routing_email_domain_testconnection ..."
  end
  
  
  # verify the required parameter 'domain_id' is set
  fail ArgumentError, "Missing the required parameter 'domain_id' when calling RoutingApi.post_routing_email_domain_testconnection" if domain_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/email/domains/{domainId}/testconnection".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 = @api_client.object_to_http_body(opts[:'body'])
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TestMessage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#post_routing_email_domain_testconnection\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:



4711
4712
4713
4714
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4711

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



4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4721

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 OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :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:



4776
4777
4778
4779
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4776

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



4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4786

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 OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :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) 


4843
4844
4845
4846
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4843

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



4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4855

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 OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :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:



4926
4927
4928
4929
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4926

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



4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 4937

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 OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :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 a queue

Parameters:

  • body —

    Queue

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

    the optional parameters

Returns:



5000
5001
5002
5003
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 5000

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 a queue

Parameters:

  • body —

    Queue

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

    the optional parameters

Returns:

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

    Queue data, response status code and response headers



5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 5010

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 OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :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:



5065
5066
5067
5068
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 5065

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



5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 5075

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 OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :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 = {}) ⇒ SmsAddress

Provision an Address for SMS

Parameters:

  • body —

    SmsAddress

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

    the optional parameters

Returns:



5130
5131
5132
5133
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 5130

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<(SmsAddress, Fixnum, Hash)>

Provision an Address for SMS

Parameters:

  • body —

    SmsAddress

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

    the optional parameters

Returns:

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

    SmsAddress data, response status code and response headers



5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 5140

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 OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SmsAddress')
  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:



5195
5196
5197
5198
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 5195

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



5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 5205

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 OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :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:



5260
5261
5262
5263
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 5260

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



5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 5270

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 OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :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:



5326
5327
5328
5329
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 5326

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



5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 5337

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 OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :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:



5401
5402
5403
5404
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 5401

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



5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 5412

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 OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :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:



5477
5478
5479
5480
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 5477

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



5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 5489

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 OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :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:



5561
5562
5563
5564
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 5561

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



5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 5572

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 OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :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:



5636
5637
5638
5639
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 5636

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



5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 5647

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 OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :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_settings(body, opts = {}) ⇒ RoutingSettings

Update an organization’s routing settings

Parameters:

  • body —

    Organization Settings

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

    the optional parameters

Returns:



5710
5711
5712
5713
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 5710

def put_routing_settings(body, opts = {})
  data, _status_code, _headers = put_routing_settings_with_http_info(body, opts)
  return data
end

#put_routing_settings_transcription(body, opts = {}) ⇒ TranscriptionSettings

Update Transcription Settings

Parameters:

  • body —

    Organization Settings

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

    the optional parameters

Returns:



5775
5776
5777
5778
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 5775

def put_routing_settings_transcription(body, opts = {})
  data, _status_code, _headers = put_routing_settings_transcription_with_http_info(body, opts)
  return data
end

#put_routing_settings_transcription_with_http_info(body, opts = {}) ⇒ Array<(TranscriptionSettings, Fixnum, Hash)>

Update Transcription Settings

Parameters:

  • body —

    Organization Settings

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

    the optional parameters

Returns:

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

    TranscriptionSettings data, response status code and response headers



5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 5785

def put_routing_settings_transcription_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.put_routing_settings_transcription ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.put_routing_settings_transcription" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/settings/transcription".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 OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TranscriptionSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#put_routing_settings_transcription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_routing_settings_with_http_info(body, opts = {}) ⇒ Array<(RoutingSettings, Fixnum, Hash)>

Update an organization&#39;s routing settings

Parameters:

  • body —

    Organization Settings

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

    the optional parameters

Returns:

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

    RoutingSettings data, response status code and response headers



5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 5720

def put_routing_settings_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.put_routing_settings ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.put_routing_settings" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/settings".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 OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RoutingSettings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#put_routing_settings\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:



5841
5842
5843
5844
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 5841

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



5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 5852

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 OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :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_user_utilization(user_id, body, opts = {}) ⇒ Utilization

Update the user’s max utilization settings. Include only those media types requiring custom configuration.

Parameters:

  • user_id —

    User ID

  • body —

    utilization

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

    the optional parameters

Returns:



5916
5917
5918
5919
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 5916

def put_routing_user_utilization(user_id, body, opts = {})
  data, _status_code, _headers = put_routing_user_utilization_with_http_info(user_id, body, opts)
  return data
end

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

Update the user&#39;s max utilization settings. Include only those media types requiring custom configuration.

Parameters:

  • user_id —

    User ID

  • body —

    utilization

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

    the optional parameters

Returns:

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

    Utilization data, response status code and response headers



5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 5927

def put_routing_user_utilization_with_http_info(user_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.put_routing_user_utilization ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling RoutingApi.put_routing_user_utilization" if user_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.put_routing_user_utilization" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/routing/users/{userId}/utilization".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 OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Utilization')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#put_routing_user_utilization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update the organization-wide max utilization settings. Include only those media types requiring custom configuration.

Parameters:

  • body —

    utilization

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

    the optional parameters

Returns:



5990
5991
5992
5993
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 5990

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 organization-wide max utilization settings. Include only those media types requiring custom configuration.

Parameters:

  • body —

    utilization

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

    the optional parameters

Returns:

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

    Utilization data, response status code and response headers



6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 6000

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 OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :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:



6056
6057
6058
6059
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 6056

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



6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 6067

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 OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :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:



6132
6133
6134
6135
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 6132

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



6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 6144

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 OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :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

#put_user_routingskills_bulk(user_id, body, opts = {}) ⇒ UserSkillEntityListing

Replace all routing skills assigned to a user

Parameters:

  • user_id —

    User ID

  • body —

    Skill

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

    the optional parameters

Returns:



6216
6217
6218
6219
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 6216

def put_user_routingskills_bulk(user_id, body, opts = {})
  data, _status_code, _headers = put_user_routingskills_bulk_with_http_info(user_id, body, opts)
  return data
end

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

Replace all routing skills assigned to a user

Parameters:

  • user_id —

    User ID

  • body —

    Skill

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

    the optional parameters

Returns:

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

    UserSkillEntityListing data, response status code and response headers



6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
 
# File 'lib/purecloudplatformclientv2/api/routing_api.rb', line 6227

def put_user_routingskills_bulk_with_http_info(user_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: RoutingApi.put_user_routingskills_bulk ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling RoutingApi.put_user_routingskills_bulk" if user_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling RoutingApi.put_user_routingskills_bulk" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/users/{userId}/routingskills/bulk".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 OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserSkillEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RoutingApi#put_user_routingskills_bulk\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end