doc_out/PresenceApi.html.md in purecloud-0.67.1 vs doc_out/PresenceApi.html.md in purecloud-0.68.1
- old
+ new
@@ -4,30 +4,33 @@
## PureCloud::PresenceApi
All URIs are relative to *https://api.mypurecloud.com*
-Method | HTTP request | Description
+Method | Description
------------- | ------------- | -------------
-|[**delete_presence_id**](PresenceApi.html#delete_presence_id) | **DELETE** /api/v2/presencedefinitions/{presenceId} | Delete a Presence Definition|
-|[**get_presence_id**](PresenceApi.html#get_presence_id) | **GET** /api/v2/presencedefinitions/{presenceId} | Get a Presence Definition|
-|[**get_presencedefinitions**](PresenceApi.html#get_presencedefinitions) | **GET** /api/v2/presencedefinitions | Get an Organization's list of Presence Definitions|
-|[**get_systempresences**](PresenceApi.html#get_systempresences) | **GET** /api/v2/systempresences | Get the list of SystemPresences|
-|[**get_user_id_presences_source_id**](PresenceApi.html#get_user_id_presences_source_id) | **GET** /api/v2/users/{userId}/presences/{sourceId} | Get a user's Presence|
-|[**patch_user_id_presences_source_id**](PresenceApi.html#patch_user_id_presences_source_id) | **PATCH** /api/v2/users/{userId}/presences/{sourceId} | Patch a user's Presence|
-|[**post_presencedefinitions**](PresenceApi.html#post_presencedefinitions) | **POST** /api/v2/presencedefinitions | Create a Presence Definition|
-|[**put_presence_id**](PresenceApi.html#put_presence_id) | **PUT** /api/v2/presencedefinitions/{presenceId} | Update a Presence Definition|
+[**delete_presence_id**](PresenceApi.html#delete_presence_id) | Delete a Presence Definition
+[**get_presence_id**](PresenceApi.html#get_presence_id) | Get a Presence Definition
+[**get_presencedefinitions**](PresenceApi.html#get_presencedefinitions) | Get an Organization's list of Presence Definitions
+[**get_systempresences**](PresenceApi.html#get_systempresences) | Get the list of SystemPresences
+[**get_user_id_presences_source_id**](PresenceApi.html#get_user_id_presences_source_id) | Get a user's Presence
+[**patch_user_id_presences_source_id**](PresenceApi.html#patch_user_id_presences_source_id) | Patch a user's Presence
+[**post_presencedefinitions**](PresenceApi.html#post_presencedefinitions) | Create a Presence Definition
+[**put_presence_id**](PresenceApi.html#put_presence_id) | Update a Presence Definition
{: class="table table-striped"}
<a name="delete_presence_id"></a>
## - delete_presence_id(presence_id)
Delete a Presence Definition
+Wraps DELETE /api/v2/presencedefinitions/{presenceId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -79,10 +82,13 @@
Get a Presence Definition
+Wraps GET /api/v2/presencedefinitions/{presenceId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -139,10 +145,13 @@
Get an Organization's list of Presence Definitions
+Wraps GET /api/v2/presencedefinitions
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -202,10 +211,13 @@
Get the list of SystemPresences
+Wraps GET /api/v2/systempresences
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -252,10 +264,13 @@
Get a user's Presence
+Wraps GET /api/v2/users/{userId}/presences/{sourceId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -311,10 +326,13 @@
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.
+Wraps PATCH /api/v2/users/{userId}/presences/{sourceId}
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -373,10 +391,13 @@
Create a Presence Definition
+Wraps POST /api/v2/presencedefinitions
+
+
### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@@ -427,9 +448,12 @@
## -[**OrganizationPresence**](OrganizationPresence.html) put_presence_id(presence_id, body)
Update a Presence Definition
+
+
+Wraps PUT /api/v2/presencedefinitions/{presenceId}
### Example
~~~ruby
# load the gem