Class: PureCloud::PresenceApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/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/purecloudplatformclientv2/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/purecloudplatformclientv2/api/presence_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#delete_presencedefinition(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/purecloudplatformclientv2/api/presence_api.rb', line 32

def delete_presencedefinition(presence_id, opts = {})
  delete_presencedefinition_with_http_info(presence_id, opts)
  return nil
end

#delete_presencedefinition_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
85
86
87
88
89
 
# File 'lib/purecloudplatformclientv2/api/presence_api.rb', line 42

def delete_presencedefinition_with_http_info(presence_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PresenceApi.delete_presencedefinition ..."
  end
  
  
  # verify the required parameter 'presence_id' is set
  fail ArgumentError, "Missing the required parameter 'presence_id' when calling PresenceApi.delete_presencedefinition" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#get_presencedefinition(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:



97
98
99
100
 
# File 'lib/purecloudplatformclientv2/api/presence_api.rb', line 97

def get_presencedefinition(presence_id, opts = {})
  data, _status_code, _headers = get_presencedefinition_with_http_info(presence_id, opts)
  return data
end

#get_presencedefinition_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



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

def get_presencedefinition_with_http_info(presence_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PresenceApi.get_presencedefinition ..."
  end
  
  
  # verify the required parameter 'presence_id' is set
  fail ArgumentError, "Missing the required parameter 'presence_id' when calling PresenceApi.get_presencedefinition" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'OrganizationPresence')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PresenceApi#get_presencedefinition\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:



173
174
175
176
 
# File 'lib/purecloudplatformclientv2/api/presence_api.rb', line 173

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:



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/purecloudplatformclientv2/api/presence_api.rb', line 186

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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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



260
261
262
263
 
# File 'lib/purecloudplatformclientv2/api/presence_api.rb', line 260

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



269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/purecloudplatformclientv2/api/presence_api.rb', line 269

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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => '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_presence(user_id, source_id, opts = {}) ⇒ UserPresence

Get a user’s Presence Get a user’s presence for the specified source that is not specifically listed. Used to support custom presence sources.

Parameters:

  • user_id —

    user Id

  • source_id —

    Presence source ID

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

    the optional parameters

Returns:



317
318
319
320
 
# File 'lib/purecloudplatformclientv2/api/presence_api.rb', line 317

def get_user_presence(user_id, source_id, opts = {})
  data, _status_code, _headers = get_user_presence_with_http_info(user_id, source_id, opts)
  return data
end

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

Get a user&#39;s Presence Get a user&#39;s presence for the specified source that is not specifically listed. Used to support custom presence sources.

Parameters:

  • user_id —

    user Id

  • source_id —

    Presence source ID

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

    the optional parameters

Returns:

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

    UserPresence 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
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/purecloudplatformclientv2/api/presence_api.rb', line 328

def get_user_presence_with_http_info(user_id, source_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PresenceApi.get_user_presence ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling PresenceApi.get_user_presence" if user_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'source_id' is set
  fail ArgumentError, "Missing the required parameter 'source_id' when calling PresenceApi.get_user_presence" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#get_user_presences_microsoftteams(user_id, opts = {}) ⇒ PresenceExpand

Get a user’s Microsoft Teams presence. Gets the presence for a Microsoft Teams user. This will return the Microsoft Teams presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.

Parameters:

  • user_id —

    user Id

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

    the optional parameters

Returns:



391
392
393
394
 
# File 'lib/purecloudplatformclientv2/api/presence_api.rb', line 391

def get_user_presences_microsoftteams(user_id, opts = {})
  data, _status_code, _headers = get_user_presences_microsoftteams_with_http_info(user_id, opts)
  return data
end

#get_user_presences_microsoftteams_with_http_info(user_id, opts = {}) ⇒ Array<(PresenceExpand, Fixnum, Hash)>

Get a user&#39;s Microsoft Teams presence. Gets the presence for a Microsoft Teams user. This will return the Microsoft Teams presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.

Parameters:

  • user_id —

    user Id

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

    the optional parameters

Returns:

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

    PresenceExpand data, response status code and response headers



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

#get_user_presences_purecloud(user_id, opts = {}) ⇒ UserPresence

Get a user’s Genesys Cloud presence. Get the default Genesys Cloud user presence source PURECLOUD

Parameters:

  • user_id —

    user Id

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

    the optional parameters

Returns:



456
457
458
459
 
# File 'lib/purecloudplatformclientv2/api/presence_api.rb', line 456

def get_user_presences_purecloud(user_id, opts = {})
  data, _status_code, _headers = get_user_presences_purecloud_with_http_info(user_id, opts)
  return data
end

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

Get a user&#39;s Genesys Cloud presence. Get the default Genesys Cloud user presence source PURECLOUD

Parameters:

  • user_id —

    user Id

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

    the optional parameters

Returns:

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

    UserPresence data, response status code and response headers



466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
 
# File 'lib/purecloudplatformclientv2/api/presence_api.rb', line 466

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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

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

Patch a user’s Presence Patch a user’s presence for the specified source that is not specifically listed. 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 —

    Presence source ID

  • body —

    User presence

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

    the optional parameters

Returns:



523
524
525
526
 
# File 'lib/purecloudplatformclientv2/api/presence_api.rb', line 523

def patch_user_presence(user_id, source_id, body, opts = {})
  data, _status_code, _headers = patch_user_presence_with_http_info(user_id, source_id, body, opts)
  return data
end

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

Patch a user&#39;s Presence Patch a user&#39;s presence for the specified source that is not specifically listed. 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 —

    Presence source ID

  • body —

    User presence

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

    the optional parameters

Returns:

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

    UserPresence data, response status code and response headers



535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
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
 
# File 'lib/purecloudplatformclientv2/api/presence_api.rb', line 535

def patch_user_presence_with_http_info(user_id, source_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PresenceApi.patch_user_presence ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling PresenceApi.patch_user_presence" if user_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'source_id' is set
  fail ArgumentError, "Missing the required parameter 'source_id' when calling PresenceApi.patch_user_presence" if source_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling PresenceApi.patch_user_presence" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

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

Patch a Genesys Cloud 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 PURECLOUD source 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

  • body —

    User presence

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

    the optional parameters

Returns:



607
608
609
610
 
# File 'lib/purecloudplatformclientv2/api/presence_api.rb', line 607

def patch_user_presences_purecloud(user_id, body, opts = {})
  data, _status_code, _headers = patch_user_presences_purecloud_with_http_info(user_id, body, opts)
  return data
end

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

Patch a Genesys Cloud 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 PURECLOUD source 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

  • body —

    User presence

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

    the optional parameters

Returns:

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

    UserPresence data, response status code and response headers



618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
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
 
# File 'lib/purecloudplatformclientv2/api/presence_api.rb', line 618

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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



681
682
683
684
 
# File 'lib/purecloudplatformclientv2/api/presence_api.rb', line 681

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



691
692
693
694
695
696
697
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
 
# File 'lib/purecloudplatformclientv2/api/presence_api.rb', line 691

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 ArgumentError, "Missing the required parameter 'body' when calling PresenceApi.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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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



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

def put_presencedefinition(presence_id, body, opts = {})
  data, _status_code, _headers = put_presencedefinition_with_http_info(presence_id, body, opts)
  return data
end

#put_presencedefinition_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



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
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
 
# File 'lib/purecloudplatformclientv2/api/presence_api.rb', line 758

def put_presencedefinition_with_http_info(presence_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PresenceApi.put_presencedefinition ..."
  end
  
  
  # verify the required parameter 'presence_id' is set
  fail ArgumentError, "Missing the required parameter 'presence_id' when calling PresenceApi.put_presencedefinition" if presence_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling PresenceApi.put_presencedefinition" 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)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

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

  # form parameters
  form_params = {}

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

#put_users_presences_bulk(body, opts = {}) ⇒ Array<UserPresence>

Update bulk user Presences

Parameters:

  • body —

    List of User presences

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

    the optional parameters

Returns:



821
822
823
824
 
# File 'lib/purecloudplatformclientv2/api/presence_api.rb', line 821

def put_users_presences_bulk(body, opts = {})
  data, _status_code, _headers = put_users_presences_bulk_with_http_info(body, opts)
  return data
end

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

Update bulk user Presences

Parameters:

  • body —

    List of User presences

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

    the optional parameters

Returns:

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

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



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

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

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

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

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

  # form parameters
  form_params = {}

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