Class: PureCloud::UsersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/api/users_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UsersApi

Returns a new instance of UsersApi.



23
24
25
 
# File 'lib/purecloudplatformclientv2/api/users_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/users_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_user(user_id, opts = {}) ⇒ Empty

Delete user

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:



32
33
34
35
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 32

def delete_user(user_id, opts = {})
  data, _status_code, _headers = delete_user_with_http_info(user_id, opts)
  return data
end

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

Removes all the roles from the user.

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:

  • (nil) 


89
90
91
92
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 89

def delete_user_roles(user_id, opts = {})
  delete_user_roles_with_http_info(user_id, opts)
  return nil
end

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

Removes all the roles from the user.

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 99

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

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

Remove routing skill from user

Parameters:

  • user_id —

    User ID

  • skill_id —

    skillId

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

    the optional parameters

Returns:

  • (String) 


146
147
148
149
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 146

def delete_user_routingskill(user_id, skill_id, opts = {})
  data, _status_code, _headers = delete_user_routingskill_with_http_info(user_id, skill_id, opts)
  return data
end

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

Remove routing skill from user

Parameters:

  • user_id —

    User ID

  • skill_id —

    skillId

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 157

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Clear associated station

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:

  • (nil) 


206
207
208
209
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 206

def delete_user_station_associatedstation(user_id, opts = {})
  delete_user_station_associatedstation_with_http_info(user_id, opts)
  return nil
end

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

Clear associated station

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 216

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

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

Clear default station

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:

  • (nil) 


262
263
264
265
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 262

def delete_user_station_defaultstation(user_id, opts = {})
  delete_user_station_defaultstation_with_http_info(user_id, opts)
  return nil
end

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

Clear default station

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
311
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 272

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

#delete_user_with_http_info(user_id, opts = {}) ⇒ Array<(Empty, Fixnum, Hash)>

Delete user

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:

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

    Empty data, 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
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 42

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

#get_fieldconfig(type, opts = {}) ⇒ FieldConfig

Fetch field config for an entity type

Parameters:

  • type —

    Field type

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

    the optional parameters

Returns:



318
319
320
321
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 318

def get_fieldconfig(type, opts = {})
  data, _status_code, _headers = get_fieldconfig_with_http_info(type, opts)
  return data
end

#get_fieldconfig_with_http_info(type, opts = {}) ⇒ Array<(FieldConfig, Fixnum, Hash)>

Fetch field config for an entity type

Parameters:

  • type —

    Field type

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

    the optional parameters

Returns:

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

    FieldConfig data, response status code and response headers



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

def get_fieldconfig_with_http_info(type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.get_fieldconfig ..."
  end
  # verify the required parameter 'type' is set
  fail ArgumentError, "Missing the required parameter 'type' when calling UsersApi.get_fieldconfig" if type.nil?
  # verify enum value
  unless ['person', 'group', 'org', 'externalContact'].include?(type)
    fail ArgumentError, "invalid value for 'type', must be one of person, group, org, externalContact"
  end
  # resource path
  local_var_path = "/api/v2/fieldconfig".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'type'] = type

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_user(user_id, opts = {}) ⇒ User

Get user.

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



381
382
383
384
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 381

def get_user(user_id, opts = {})
  data, _status_code, _headers = get_user_with_http_info(user_id, opts)
  return data
end

#get_user_adjacents(user_id, opts = {}) ⇒ Adjacents

Get adjacents

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



441
442
443
444
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 441

def get_user_adjacents(user_id, opts = {})
  data, _status_code, _headers = get_user_adjacents_with_http_info(user_id, opts)
  return data
end

#get_user_adjacents_with_http_info(user_id, opts = {}) ⇒ Array<(Adjacents, Fixnum, Hash)>

Get adjacents

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:

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

    Adjacents data, response status code and response headers



452
453
454
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
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 452

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

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_user_callforwarding(user_id, opts = {}) ⇒ CallForwarding

Get a user’s CallForwarding

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:



500
501
502
503
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 500

def get_user_callforwarding(user_id, opts = {})
  data, _status_code, _headers = get_user_callforwarding_with_http_info(user_id, opts)
  return data
end

#get_user_callforwarding_with_http_info(user_id, opts = {}) ⇒ Array<(CallForwarding, Fixnum, Hash)>

Get a user&#39;s CallForwarding

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:

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

    CallForwarding data, response status code and response headers



510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 510

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

#get_user_directreports(user_id, opts = {}) ⇒ Array<User>

Get direct reports

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



558
559
560
561
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 558

def get_user_directreports(user_id, opts = {})
  data, _status_code, _headers = get_user_directreports_with_http_info(user_id, opts)
  return data
end

#get_user_directreports_with_http_info(user_id, opts = {}) ⇒ Array<(Array<User>, Fixnum, Hash)>

Get direct reports

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:

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

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



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

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

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_user_favorites(user_id, opts = {}) ⇒ UserEntityListing

Get favorites

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

    Sort order (default to ASC)

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



621
622
623
624
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 621

def get_user_favorites(user_id, opts = {})
  data, _status_code, _headers = get_user_favorites_with_http_info(user_id, opts)
  return data
end

#get_user_favorites_with_http_info(user_id, opts = {}) ⇒ Array<(UserEntityListing, Fixnum, Hash)>

Get favorites

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

    Sort order

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:

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

    UserEntityListing data, response status code and response headers



635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 635

def get_user_favorites_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.get_user_favorites ..."
  end
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_favorites" if user_id.nil?
  # resource path
  local_var_path = "/api/v2/users/{userId}/favorites".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']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_user_geolocation(user_id, client_id, opts = {}) ⇒ Geolocation

Get a user’s Geolocation

Parameters:

  • user_id —

    user Id

  • client_id —

    client Id

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

    the optional parameters

Returns:



687
688
689
690
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 687

def get_user_geolocation(user_id, client_id, opts = {})
  data, _status_code, _headers = get_user_geolocation_with_http_info(user_id, client_id, opts)
  return data
end

#get_user_geolocation_with_http_info(user_id, client_id, opts = {}) ⇒ Array<(Geolocation, Fixnum, Hash)>

Get a user&#39;s Geolocation

Parameters:

  • user_id —

    user Id

  • client_id —

    client Id

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

    the optional parameters

Returns:

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

    Geolocation data, response status code and response headers



698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 698

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_user_outofoffice(user_id, opts = {}) ⇒ OutOfOffice

Get a OutOfOffice

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:



747
748
749
750
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 747

def get_user_outofoffice(user_id, opts = {})
  data, _status_code, _headers = get_user_outofoffice_with_http_info(user_id, opts)
  return data
end

#get_user_outofoffice_with_http_info(user_id, opts = {}) ⇒ Array<(OutOfOffice, Fixnum, Hash)>

Get a OutOfOffice

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:

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

    OutOfOffice data, response status code and response headers



757
758
759
760
761
762
763
764
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
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 757

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

#get_user_profileskills(user_id, opts = {}) ⇒ Array<String>

List profile skills for a user

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:

  • (Array<String>) 


804
805
806
807
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 804

def get_user_profileskills(user_id, opts = {})
  data, _status_code, _headers = get_user_profileskills_with_http_info(user_id, opts)
  return data
end

#get_user_profileskills_with_http_info(user_id, opts = {}) ⇒ Array<(Array<String>, Fixnum, Hash)>

List profile skills for a user

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:

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

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



814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 814

def get_user_profileskills_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.get_user_profileskills ..."
  end
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_profileskills" if user_id.nil?
  # resource path
  local_var_path = "/api/v2/users/{userId}/profileskills".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 Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<String>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#get_user_profileskills\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)

Returns:



864
865
866
867
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 864

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

Returns:

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

    UserQueueEntityListing data, response status code and response headers



877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 877

def get_user_queues_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.get_user_queues ..."
  end
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.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']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_user_roles(user_id, opts = {}) ⇒ UserAuthorization

Returns a listing of roles and permissions for a user.

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:



927
928
929
930
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 927

def get_user_roles(user_id, opts = {})
  data, _status_code, _headers = get_user_roles_with_http_info(user_id, opts)
  return data
end

#get_user_roles_with_http_info(user_id, opts = {}) ⇒ Array<(UserAuthorization, Fixnum, Hash)>

Returns a listing of roles and permissions for a user.

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:

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

    UserAuthorization data, response status code and response headers



937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 937

def get_user_roles_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.get_user_roles ..."
  end
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_roles" if user_id.nil?
  # resource path
  local_var_path = "/api/v2/users/{userId}/roles".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 Auth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserAuthorization')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#get_user_roles\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:



987
988
989
990
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 987

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



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
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 1000

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

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

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_user_routingstatus(user_id, opts = {}) ⇒ RoutingStatus

Fetch the routing status of a user

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:



1053
1054
1055
1056
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 1053

def get_user_routingstatus(user_id, opts = {})
  data, _status_code, _headers = get_user_routingstatus_with_http_info(user_id, opts)
  return data
end

#get_user_routingstatus_with_http_info(user_id, opts = {}) ⇒ Array<(RoutingStatus, Fixnum, Hash)>

Fetch the routing status of a user

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:

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

    RoutingStatus data, response status code and response headers



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
1101
1102
1103
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 1063

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

#get_user_station(user_id, opts = {}) ⇒ UserStations

Get station information for user

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:



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

def get_user_station(user_id, opts = {})
  data, _status_code, _headers = get_user_station_with_http_info(user_id, opts)
  return data
end

#get_user_station_with_http_info(user_id, opts = {}) ⇒ Array<(UserStations, Fixnum, Hash)>

Get station information for user

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Returns:

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

    UserStations data, response status code and response headers



1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 1120

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

#get_user_superiors(user_id, opts = {}) ⇒ Array<User>

Get superiors

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



1168
1169
1170
1171
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 1168

def get_user_superiors(user_id, opts = {})
  data, _status_code, _headers = get_user_superiors_with_http_info(user_id, opts)
  return data
end

#get_user_superiors_with_http_info(user_id, opts = {}) ⇒ Array<(Array<User>, Fixnum, Hash)>

Get superiors

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:

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

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



1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 1179

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

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_user_with_http_info(user_id, opts = {}) ⇒ Array<(User, Fixnum, Hash)>

Get user.

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:

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

    User data, response status code and response headers



392
393
394
395
396
397
398
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
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 392

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

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_users(opts = {}) ⇒ UserEntityListing

Get the list of available users.

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)

  • :id (Array<String>) —

    id

  • :sort_order (String) —

    Ascending or descending sort order (default to ASC)

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:



1231
1232
1233
1234
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 1231

def get_users(opts = {})
  data, _status_code, _headers = get_users_with_http_info(opts)
  return data
end

#get_users_me(opts = {}) ⇒ UserMe

Get current user details. This request is not valid when using the Client Credentials OAuth grant.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand.

Returns:



1298
1299
1300
1301
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 1298

def get_users_me(opts = {})
  data, _status_code, _headers = get_users_me_with_http_info(opts)
  return data
end

#get_users_me_with_http_info(opts = {}) ⇒ Array<(UserMe, Fixnum, Hash)>

Get current user details. This request is not valid when using the Client Credentials OAuth grant.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Which fields, if any, to expand.

Returns:

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

    UserMe data, response status code and response headers



1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 1308

def get_users_me_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.get_users_me ..."
  end
  # resource path
  local_var_path = "/api/v2/users/me".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_users_search(q64, opts = {}) ⇒ UsersSearchResponse

Search users using the q64 value returned from a previous search

Parameters:

  • q64 —

    q64

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    expand

Returns:



1355
1356
1357
1358
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 1355

def get_users_search(q64, opts = {})
  data, _status_code, _headers = get_users_search_with_http_info(q64, opts)
  return data
end

#get_users_search_with_http_info(q64, opts = {}) ⇒ Array<(UsersSearchResponse, Fixnum, Hash)>

Search users using the q64 value returned from a previous search

Parameters:

  • q64 —

    q64

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    expand

Returns:

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

    UsersSearchResponse data, response status code and response headers



1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 1366

def get_users_search_with_http_info(q64, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.get_users_search ..."
  end
  # verify the required parameter 'q64' is set
  fail ArgumentError, "Missing the required parameter 'q64' when calling UsersApi.get_users_search" if q64.nil?
  # resource path
  local_var_path = "/api/v2/users/search".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'q64'] = q64
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_users_with_http_info(opts = {}) ⇒ Array<(UserEntityListing, Fixnum, Hash)>

Get the list of available users.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    Page size

  • :page_number (Integer) —

    Page number

  • :id (Array<String>) —

    id

  • :sort_order (String) —

    Ascending or descending sort order

  • :expand (Array<String>) —

    Which fields, if any, to expand

Returns:

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

    UserEntityListing data, response status code and response headers



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

def get_users_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.get_users ..."
  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/users".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[:'id'] = @api_client.build_collection_param(opts[:'id'], :multi) if opts[:'id']
  query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand']

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#patch_user(user_id, body, opts = {}) ⇒ User

Update user

Parameters:

  • user_id —

    User ID

  • body —

    User

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

    the optional parameters

Returns:



1416
1417
1418
1419
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 1416

def patch_user(user_id, body, opts = {})
  data, _status_code, _headers = patch_user_with_http_info(user_id, body, opts)
  return data
end

#patch_user_callforwarding(user_id, body, opts = {}) ⇒ CallForwarding

Patch a user’s CallForwarding

Parameters:

  • user_id —

    User ID

  • body —

    Call forwarding

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

    the optional parameters

Returns:



1477
1478
1479
1480
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 1477

def patch_user_callforwarding(user_id, body, opts = {})
  data, _status_code, _headers = patch_user_callforwarding_with_http_info(user_id, body, opts)
  return data
end

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

Patch a user&#39;s CallForwarding

Parameters:

  • user_id —

    User ID

  • body —

    Call forwarding

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

    the optional parameters

Returns:

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

    CallForwarding data, response status code and response headers



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#patch_user_geolocation(user_id, client_id, body, opts = {}) ⇒ Geolocation

Patch a user’s Geolocation The geolocation object can be patched one of three ways. Option 1: Set the ‘primary’ property to true. This will set the client as the user’s primary geolocation source. Option 2: Provide the ‘latitude’ and ‘longitude’ values. This will enqueue an asynchronous update of the ‘city’, ‘region’, and ‘country’, generating a notification. A subsequent GET operation will include the new values for ‘city’, ‘region’ and ‘country’. Option 3: Provide the ‘city’, ‘region’, ‘country’ values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.

Parameters:

  • user_id —

    user Id

  • client_id —

    client Id

  • body —

    Geolocation

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

    the optional parameters

Returns:



1539
1540
1541
1542
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 1539

def patch_user_geolocation(user_id, client_id, body, opts = {})
  data, _status_code, _headers = patch_user_geolocation_with_http_info(user_id, client_id, body, opts)
  return data
end

#patch_user_geolocation_with_http_info(user_id, client_id, body, opts = {}) ⇒ Array<(Geolocation, Fixnum, Hash)>

Patch a user&#39;s Geolocation The geolocation object can be patched one of three ways. Option 1: Set the &#39;primary&#39; property to true. This will set the client as the user&#39;s primary geolocation source. Option 2: Provide the &#39;latitude&#39; and &#39;longitude&#39; values. This will enqueue an asynchronous update of the &#39;city&#39;, &#39;region&#39;, and &#39;country&#39;, generating a notification. A subsequent GET operation will include the new values for &#39;city&#39;, &#39;region&#39; and &#39;country&#39;. Option 3: Provide the &#39;city&#39;, &#39;region&#39;, &#39;country&#39; values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.

Parameters:

  • user_id —

    user Id

  • client_id —

    client Id

  • body —

    Geolocation

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

    the optional parameters

Returns:

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

    Geolocation data, response status code and response headers



1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 1551

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Geolocation')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#patch_user_geolocation\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:



1604
1605
1606
1607
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 1604

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



1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 1616

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: UsersApi.patch_user_queue ..."
  end
  # verify the required parameter 'queue_id' is set
  fail ArgumentError, "Missing the required parameter 'queue_id' when calling UsersApi.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 UsersApi.patch_user_queue" if user_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.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 Auth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'UserQueue')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#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

Returns:



1668
1669
1670
1671
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 1668

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

Returns:

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

    UserQueueEntityListing data, response status code and response headers



1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 1679

def patch_user_queues_with_http_info(user_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsersApi.patch_user_queues ..."
  end
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.patch_user_queues" if user_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.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 = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Update user

Parameters:

  • user_id —

    User ID

  • body —

    User

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

    the optional parameters

Returns:

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

    User data, response status code and response headers



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#post_analytics_users_aggregates_query(body, opts = {}) ⇒ PresenceQueryResponse

Query for user aggregates

Parameters:

  • body —

    query

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

    the optional parameters

Returns:



1728
1729
1730
1731
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 1728

def post_analytics_users_aggregates_query(body, opts = {})
  data, _status_code, _headers = post_analytics_users_aggregates_query_with_http_info(body, opts)
  return data
end

#post_analytics_users_aggregates_query_with_http_info(body, opts = {}) ⇒ Array<(PresenceQueryResponse, Fixnum, Hash)>

Query for user aggregates

Parameters:

  • body —

    query

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

    the optional parameters

Returns:

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

    PresenceQueryResponse data, response status code and response headers



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
1772
1773
1774
1775
1776
1777
1778
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 1738

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#post_analytics_users_details_query(body, opts = {}) ⇒ AnalyticsUserDetailsQueryResponse

Query for user details

Parameters:

  • body —

    query

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

    the optional parameters

Returns:



1785
1786
1787
1788
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 1785

def post_analytics_users_details_query(body, opts = {})
  data, _status_code, _headers = post_analytics_users_details_query_with_http_info(body, opts)
  return data
end

#post_analytics_users_details_query_with_http_info(body, opts = {}) ⇒ Array<(AnalyticsUserDetailsQueryResponse, Fixnum, Hash)>

Query for user details

Parameters:

  • body —

    query

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

    the optional parameters

Returns:



1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 1795

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#post_analytics_users_observations_query(body, opts = {}) ⇒ ObservationQueryResponse

Query for user observations

Parameters:

  • body —

    query

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

    the optional parameters

Returns:



1842
1843
1844
1845
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 1842

def post_analytics_users_observations_query(body, opts = {})
  data, _status_code, _headers = post_analytics_users_observations_query_with_http_info(body, opts)
  return data
end

#post_analytics_users_observations_query_with_http_info(body, opts = {}) ⇒ Array<(ObservationQueryResponse, Fixnum, Hash)>

Query for user observations

Parameters:

  • body —

    query

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

    the optional parameters

Returns:

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

    ObservationQueryResponse data, response status code and response headers



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ObservationQueryResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#post_analytics_users_observations_query\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:



1900
1901
1902
1903
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 1900

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



1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 1911

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#post_users(body, opts = {}) ⇒ User

Create user

Parameters:

  • body —

    User

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

    the optional parameters

Returns:



1960
1961
1962
1963
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 1960

def post_users(body, opts = {})
  data, _status_code, _headers = post_users_with_http_info(body, opts)
  return data
end

#post_users_search(body, opts = {}) ⇒ UsersSearchResponse

Search users

Parameters:

  • body —

    Search request options

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

    the optional parameters

Returns:



2017
2018
2019
2020
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 2017

def post_users_search(body, opts = {})
  data, _status_code, _headers = post_users_search_with_http_info(body, opts)
  return data
end

#post_users_search_with_http_info(body, opts = {}) ⇒ Array<(UsersSearchResponse, Fixnum, Hash)>

Search users

Parameters:

  • body —

    Search request options

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

    the optional parameters

Returns:

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

    UsersSearchResponse data, response status code and response headers



2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 2027

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#post_users_with_http_info(body, opts = {}) ⇒ Array<(User, Fixnum, Hash)>

Create user

Parameters:

  • body —

    User

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

    the optional parameters

Returns:

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

    User data, response status code and response headers



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#put_user_callforwarding(user_id, body, opts = {}) ⇒ CallForwarding

Update a user’s CallForwarding

Parameters:

  • user_id —

    User ID

  • body —

    Call forwarding

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

    the optional parameters

Returns:



2075
2076
2077
2078
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 2075

def put_user_callforwarding(user_id, body, opts = {})
  data, _status_code, _headers = put_user_callforwarding_with_http_info(user_id, body, opts)
  return data
end

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

Update a user&#39;s CallForwarding

Parameters:

  • user_id —

    User ID

  • body —

    Call forwarding

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

    the optional parameters

Returns:

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

    CallForwarding data, response status code and response headers



2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 2086

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#put_user_outofoffice(user_id, body, opts = {}) ⇒ OutOfOffice

Update an OutOfOffice

Parameters:

  • user_id —

    User ID

  • body —

    The updated UserPresence

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

    the optional parameters

Returns:



2136
2137
2138
2139
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 2136

def put_user_outofoffice(user_id, body, opts = {})
  data, _status_code, _headers = put_user_outofoffice_with_http_info(user_id, body, opts)
  return data
end

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

Update an OutOfOffice

Parameters:

  • user_id —

    User ID

  • body —

    The updated UserPresence

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

    the optional parameters

Returns:

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

    OutOfOffice data, response status code and response headers



2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 2147

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#put_user_profileskills(user_id, opts = {}) ⇒ Array<String>

Update profile skills for a user

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>) —

    Skills

Returns:

  • (Array<String>) 


2197
2198
2199
2200
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 2197

def put_user_profileskills(user_id, opts = {})
  data, _status_code, _headers = put_user_profileskills_with_http_info(user_id, opts)
  return data
end

#put_user_profileskills_with_http_info(user_id, opts = {}) ⇒ Array<(Array<String>, Fixnum, Hash)>

Update profile skills for a user

Parameters:

  • user_id —

    User ID

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

    the optional parameters

Options Hash (opts):

  • :body (Array<String>) —

    Skills

Returns:

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

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



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

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

#put_user_roles(user_id, body, opts = {}) ⇒ UserAuthorization

Sets the user’s roles

Parameters:

  • user_id —

    User ID

  • body —

    List of roles

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

    the optional parameters

Returns:



2256
2257
2258
2259
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 2256

def put_user_roles(user_id, body, opts = {})
  data, _status_code, _headers = put_user_roles_with_http_info(user_id, body, opts)
  return data
end

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

Sets the user&#39;s roles

Parameters:

  • user_id —

    User ID

  • body —

    List of roles

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

    the optional parameters

Returns:

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

    UserAuthorization data, response status code and response headers



2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 2267

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(: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 => 'UserAuthorization')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsersApi#put_user_roles\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:



2318
2319
2320
2321
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 2318

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



2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 2330

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: UsersApi.put_user_routingskill ..."
  end
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.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 UsersApi.put_user_routingskill" if skill_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling UsersApi.put_user_routingskill" if body.nil?
  # resource path
  local_var_path = "/api/v2/users/{userId}/routingskills/{skillId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'skillId' + '}', skill_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#put_user_routingstatus(user_id, body, opts = {}) ⇒ RoutingStatus

Update the routing status of a user

Parameters:

  • user_id —

    User ID

  • body —

    Routing Status

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

    the optional parameters

Returns:



2382
2383
2384
2385
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 2382

def put_user_routingstatus(user_id, body, opts = {})
  data, _status_code, _headers = put_user_routingstatus_with_http_info(user_id, body, opts)
  return data
end

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

Update the routing status of a user

Parameters:

  • user_id —

    User ID

  • body —

    Routing Status

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

    the optional parameters

Returns:

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

    RoutingStatus data, response status code and response headers



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#put_user_station_associatedstation_station_id(user_id, station_id, opts = {}) ⇒ nil

Set associated station

Parameters:

  • user_id —

    User ID

  • station_id —

    stationId

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

    the optional parameters

Returns:

  • (nil) 


2443
2444
2445
2446
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 2443

def put_user_station_associatedstation_station_id(user_id, station_id, opts = {})
  put_user_station_associatedstation_station_id_with_http_info(user_id, station_id, opts)
  return nil
end

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

Set associated station

Parameters:

  • user_id —

    User ID

  • station_id —

    stationId

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 2454

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#put_user_station_defaultstation_station_id(user_id, station_id, opts = {}) ⇒ nil

Set default station

Parameters:

  • user_id —

    User ID

  • station_id —

    stationId

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

    the optional parameters

Returns:

  • (nil) 


2503
2504
2505
2506
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 2503

def put_user_station_defaultstation_station_id(user_id, station_id, opts = {})
  put_user_station_defaultstation_station_id_with_http_info(user_id, station_id, opts)
  return nil
end

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

Set default station

Parameters:

  • user_id —

    User ID

  • station_id —

    stationId

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
 
# File 'lib/purecloudplatformclientv2/api/users_api.rb', line 2514

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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