Class: PureCloud::PresenceApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloud/api/presence_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PresenceApi

Returns a new instance of PresenceApi.



23
24
25
 
# File 'lib/purecloud/api/presence_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/purecloud/api/presence_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_presence_id(presence_id, opts = {}) ⇒ nil

Delete a Presence Definition

Parameters:

  • presence_id —

    Organization Presence ID

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

    the optional parameters

Returns:

  • (nil) 


32
33
34
35
 
# File 'lib/purecloud/api/presence_api.rb', line 32

def delete_presence_id(presence_id, opts = {})
  delete_presence_id_with_http_info(presence_id, opts)
  return nil
end

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

Delete a Presence Definition

Parameters:

  • presence_id —

    Organization Presence ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def delete_presence_id_with_http_info(presence_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PresenceApi#delete_presence_id ..."
  end
  
  # verify the required parameter 'presence_id' is set
  fail "Missing the required parameter 'presence_id' when calling delete_presence_id" if presence_id.nil?
  
  # resource path
  local_var_path = "/api/v2/presencedefinitions/{presenceId}".sub('{format}','json').sub('{' + 'presenceId' + '}', presence_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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: PresenceApi#delete_presence_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_presence_id(presence_id, opts = {}) ⇒ OrganizationPresence

Get a Presence Definition

Parameters:

  • presence_id —

    Organization Presence ID

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

    the optional parameters

Options Hash (opts):

  • :locale_code (String) —

    The locale code to fetch for the presence definition. Use ALL to fetch everything.

Returns:



92
93
94
95
 
# File 'lib/purecloud/api/presence_api.rb', line 92

def get_presence_id(presence_id, opts = {})
  data, status_code, headers = get_presence_id_with_http_info(presence_id, opts)
  return data
end

#get_presence_id_with_http_info(presence_id, opts = {}) ⇒ Array<(OrganizationPresence, Fixnum, Hash)>

Get a Presence Definition

Parameters:

  • presence_id —

    Organization Presence ID

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

    the optional parameters

Options Hash (opts):

  • :locale_code (String) —

    The locale code to fetch for the presence definition. Use ALL to fetch everything.

Returns:

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

    OrganizationPresence data, response status code and response headers



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
139
140
141
142
143
144
145
146
147
 
# File 'lib/purecloud/api/presence_api.rb', line 103

def get_presence_id_with_http_info(presence_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PresenceApi#get_presence_id ..."
  end
  
  # verify the required parameter 'presence_id' is set
  fail "Missing the required parameter 'presence_id' when calling get_presence_id" if presence_id.nil?
  
  # resource path
  local_var_path = "/api/v2/presencedefinitions/{presenceId}".sub('{format}','json').sub('{' + 'presenceId' + '}', presence_id.to_s)

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

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'OrganizationPresence')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PresenceApi#get_presence_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_presencedefinitions(opts = {}) ⇒ OrganizationPresenceEntityListing

Get an Organization’s list of Presence Definitions

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number (default to 1)

  • :page_size (Integer) —

    Page size (default to 25)

  • :deleted (String) —

    Deleted query can be TRUE, FALSE or ALL (default to false)

  • :locale_code (String) —

    The locale code to fetch for each presence definition. Use ALL to fetch everything.

Returns:



157
158
159
160
 
# File 'lib/purecloud/api/presence_api.rb', line 157

def get_presencedefinitions(opts = {})
  data, status_code, headers = get_presencedefinitions_with_http_info(opts)
  return data
end

#get_presencedefinitions_with_http_info(opts = {}) ⇒ Array<(OrganizationPresenceEntityListing, Fixnum, Hash)>

Get an Organization&#39;s list of Presence Definitions

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

  • :deleted (String) —

    Deleted query can be TRUE, FALSE or ALL

  • :locale_code (String) —

    The locale code to fetch for each presence definition. Use ALL to fetch everything.

Returns:



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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/purecloud/api/presence_api.rb', line 170

def get_presencedefinitions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PresenceApi#get_presencedefinitions ..."
  end
  
  # resource path
  local_var_path = "/api/v2/presencedefinitions".sub('{format}','json')

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

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'OrganizationPresenceEntityListing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PresenceApi#get_presencedefinitions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_systempresences(opts = {}) ⇒ Array<SystemPresence>

Get the list of SystemPresences

Parameters:

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

    the optional parameters

Returns:



220
221
222
223
 
# File 'lib/purecloud/api/presence_api.rb', line 220

def get_systempresences(opts = {})
  data, status_code, headers = get_systempresences_with_http_info(opts)
  return data
end

#get_systempresences_with_http_info(opts = {}) ⇒ Array<(Array<SystemPresence>, Fixnum, Hash)>

Get the list of SystemPresences

Parameters:

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

    the optional parameters

Returns:

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

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



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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/purecloud/api/presence_api.rb', line 229

def get_systempresences_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PresenceApi#get_systempresences ..."
  end
  
  # resource path
  local_var_path = "/api/v2/systempresences".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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<SystemPresence>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PresenceApi#get_systempresences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_user_id_presences_source_id(user_id, source_id, opts = {}) ⇒ UserPresence

Get a user’s Presence

Parameters:

  • user_id —

    user Id

  • source_id —

    Source

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

    the optional parameters

Returns:



277
278
279
280
 
# File 'lib/purecloud/api/presence_api.rb', line 277

def get_user_id_presences_source_id(user_id, source_id, opts = {})
  data, status_code, headers = get_user_id_presences_source_id_with_http_info(user_id, source_id, opts)
  return data
end

#get_user_id_presences_source_id_with_http_info(user_id, source_id, opts = {}) ⇒ Array<(UserPresence, Fixnum, Hash)>

Get a user&#39;s Presence

Parameters:

  • user_id —

    user Id

  • source_id —

    Source

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

    the optional parameters

Returns:

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

    UserPresence data, response status code and response headers



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/purecloud/api/presence_api.rb', line 288

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'UserPresence')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PresenceApi#get_user_id_presences_source_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_user_id_presences_source_id(user_id, source_id, body, opts = {}) ⇒ UserPresence

Patch a user’s Presence The presence object can be patched one of three ways. Option 1: Set the ‘primary’ property to true. This will set the ‘source’ defined in the path as the user’s primary presence source. Option 2: Provide the presenceDefinition value. The ‘id’ is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.

Parameters:

  • user_id —

    user Id

  • source_id —

    Source

  • body —

    User presence

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

    the optional parameters

Returns:



343
344
345
346
 
# File 'lib/purecloud/api/presence_api.rb', line 343

def patch_user_id_presences_source_id(user_id, source_id, body, opts = {})
  data, status_code, headers = patch_user_id_presences_source_id_with_http_info(user_id, source_id, body, opts)
  return data
end

#patch_user_id_presences_source_id_with_http_info(user_id, source_id, body, opts = {}) ⇒ Array<(UserPresence, Fixnum, Hash)>

Patch a user&#39;s Presence The presence object can be patched one of three ways. Option 1: Set the &#39;primary&#39; property to true. This will set the &#39;source&#39; defined in the path as the user&#39;s primary presence source. Option 2: Provide the presenceDefinition value. The &#39;id&#39; is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.

Parameters:

  • user_id —

    user Id

  • source_id —

    Source

  • body —

    User presence

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

    the optional parameters

Returns:

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

    UserPresence data, response status code and response headers



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/purecloud/api/presence_api.rb', line 355

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'UserPresence')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PresenceApi#patch_user_id_presences_source_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_presencedefinitions(body, opts = {}) ⇒ OrganizationPresence

Create a Presence Definition

Parameters:

  • body —

    The Presence Definition to create

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

    the optional parameters

Returns:



411
412
413
414
 
# File 'lib/purecloud/api/presence_api.rb', line 411

def post_presencedefinitions(body, opts = {})
  data, status_code, headers = post_presencedefinitions_with_http_info(body, opts)
  return data
end

#post_presencedefinitions_with_http_info(body, opts = {}) ⇒ Array<(OrganizationPresence, Fixnum, Hash)>

Create a Presence Definition

Parameters:

  • body —

    The Presence Definition to create

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

    the optional parameters

Returns:

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

    OrganizationPresence data, response status code and response headers



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/purecloud/api/presence_api.rb', line 421

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'OrganizationPresence')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PresenceApi#post_presencedefinitions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_presence_id(presence_id, body, opts = {}) ⇒ OrganizationPresence

Update a Presence Definition

Parameters:

  • presence_id —

    Organization Presence ID

  • body —

    The OrganizationPresence to update

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

    the optional parameters

Returns:



472
473
474
475
 
# File 'lib/purecloud/api/presence_api.rb', line 472

def put_presence_id(presence_id, body, opts = {})
  data, status_code, headers = put_presence_id_with_http_info(presence_id, body, opts)
  return data
end

#put_presence_id_with_http_info(presence_id, body, opts = {}) ⇒ Array<(OrganizationPresence, Fixnum, Hash)>

Update a Presence Definition

Parameters:

  • presence_id —

    Organization Presence ID

  • body —

    The OrganizationPresence to update

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

    the optional parameters

Returns:

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

    OrganizationPresence data, response status code and response headers



483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/purecloud/api/presence_api.rb', line 483

def put_presence_id_with_http_info(presence_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PresenceApi#put_presence_id ..."
  end
  
  # verify the required parameter 'presence_id' is set
  fail "Missing the required parameter 'presence_id' when calling put_presence_id" if presence_id.nil?
  
  # verify the required parameter 'body' is set
  fail "Missing the required parameter 'body' when calling put_presence_id" if body.nil?
  
  # resource path
  local_var_path = "/api/v2/presencedefinitions/{presenceId}".sub('{format}','json').sub('{' + 'presenceId' + '}', presence_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

  # HTTP header 'Content-Type'
  _header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(_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 => 'OrganizationPresence')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PresenceApi#put_presence_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end