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.



7
8
9
 
# File 'lib/purecloud/api/presence_api.rb', line 7

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



5
6
7
 
# File 'lib/purecloud/api/presence_api.rb', line 5

def api_client
  @api_client
end

Instance Method Details

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

Delete an OrganizationPresence

Parameters:

  • presence_id —

    Organization Presence ID

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

    the optional parameters

Returns:



266
267
268
269
 
# File 'lib/purecloud/api/presence_api.rb', line 266

def delete_presence_id(presence_id, opts = {})
  data, status_code, headers = delete_presence_id_with_http_info(presence_id, opts)
  return data
end

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

Delete an OrganizationPresence

Parameters:

  • presence_id —

    Organization Presence ID

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

    the optional parameters

Returns:

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

    OrganizationPresence data, response status code and response headers



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
312
313
314
315
316
317
318
319
320
 
# File 'lib/purecloud/api/presence_api.rb', line 276

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
  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, 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#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 an OrganizationPresence

Parameters:

  • presence_id —

    Organization Presence ID

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

    the optional parameters

Returns:



139
140
141
142
 
# File 'lib/purecloud/api/presence_api.rb', line 139

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 an OrganizationPresence

Parameters:

  • presence_id —

    Organization Presence ID

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

    the optional parameters

Returns:

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

    OrganizationPresence data, response status code and response headers



149
150
151
152
153
154
155
156
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
 
# File 'lib/purecloud/api/presence_api.rb', line 149

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
  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(:GET, 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&#39;s list of Presences

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

Returns:



17
18
19
20
 
# File 'lib/purecloud/api/presence_api.rb', line 17

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 Presences

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_number (Integer) —

    Page number

  • :page_size (Integer) —

    Page size

Returns:



28
29
30
31
32
33
34
35
36
37
38
39
40
41
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
 
# File 'lib/purecloud/api/presence_api.rb', line 28

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

  # 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, 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_user_id_presences_source(user_id, source, opts = {}) ⇒ UserPresence

Get a user&#39;s Presence

Parameters:

  • user_id —

    user Id

  • source —

    source

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

    the optional parameters

Returns:



328
329
330
331
 
# File 'lib/purecloud/api/presence_api.rb', line 328

def get_user_id_presences_source(user_id, source, opts = {})
  data, status_code, headers = get_user_id_presences_source_with_http_info(user_id, source, opts)
  return data
end

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

Get a user&#39;s Presence

Parameters:

  • user_id —

    user Id

  • source —

    source

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

    the optional parameters

Returns:

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

    UserPresence data, response status code and response headers



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
385
386
 
# File 'lib/purecloud/api/presence_api.rb', line 339

def get_user_id_presences_source_with_http_info(user_id, source, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PresenceApi#get_user_id_presences_source ..."
  end
  
  # verify the required parameter 'user_id' is set
  fail "Missing the required parameter 'user_id' when calling get_user_id_presences_source" if user_id.nil?
  
  # verify the required parameter 'source' is set
  fail "Missing the required parameter 'source' when calling get_user_id_presences_source" if source.nil?
  
  # resource path
  path = "/api/v2/users/{userId}/presences/{source}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'source' + '}', source.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, 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\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_user_id_presences_source(user_id, source, opts = {}) ⇒ UserPresence

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. Option 3: Provide the message value. Option 1 can be combined with Option2 and/or Option 3.

Parameters:

  • user_id —

    user Id

  • source —

    source

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

    the optional parameters

Options Hash (opts):

Returns:



395
396
397
398
 
# File 'lib/purecloud/api/presence_api.rb', line 395

def patch_user_id_presences_source(user_id, source, opts = {})
  data, status_code, headers = patch_user_id_presences_source_with_http_info(user_id, source, opts)
  return data
end

#patch_user_id_presences_source_with_http_info(user_id, source, 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. Option 3: Provide the message value. Option 1 can be combined with Option2 and/or Option 3.

Parameters:

  • user_id —

    user Id

  • source —

    source

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

    the optional parameters

Options Hash (opts):

Returns:

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

    UserPresence data, response status code and response headers



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
450
451
452
453
454
 
# File 'lib/purecloud/api/presence_api.rb', line 407

def patch_user_id_presences_source_with_http_info(user_id, source, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PresenceApi#patch_user_id_presences_source ..."
  end
  
  # verify the required parameter 'user_id' is set
  fail "Missing the required parameter 'user_id' when calling patch_user_id_presences_source" if user_id.nil?
  
  # verify the required parameter 'source' is set
  fail "Missing the required parameter 'source' when calling patch_user_id_presences_source" if source.nil?
  
  # resource path
  path = "/api/v2/users/{userId}/presences/{source}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s).sub('{' + 'source' + '}', source.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(opts[:'body'])
  

  auth_names = ['PureCloud Auth']
  data, status_code, headers = @api_client.call_api(:PATCH, 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\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Create an OrganizationPresence

Parameters:

  • body —

    The OrganizationPresence to create

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

    the optional parameters

Returns:



78
79
80
81
 
# File 'lib/purecloud/api/presence_api.rb', line 78

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 an OrganizationPresence

Parameters:

  • body —

    The OrganizationPresence to create

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

    the optional parameters

Returns:

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

    OrganizationPresence data, response status code and response headers



88
89
90
91
92
93
94
95
96
97
98
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
 
# File 'lib/purecloud/api/presence_api.rb', line 88

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
  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, 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 an OrganizationPresence

Parameters:

  • presence_id —

    Organization Presence ID

  • body —

    The OrganizationPresence to update

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

    the optional parameters

Returns:



201
202
203
204
 
# File 'lib/purecloud/api/presence_api.rb', line 201

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 an OrganizationPresence

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



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
255
256
257
258
259
 
# File 'lib/purecloud/api/presence_api.rb', line 212

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