PresenceApi.md in purecloudplatformclientv2-94.0.0

- old
+ new

@@ -11,11 +11,14 @@
 [**delete_presencedefinition**](PresenceApi.html#delete_presencedefinition) | Delete a Presence Definition
 [**get_presencedefinition**](PresenceApi.html#get_presencedefinition) | Get a Presence Definition
 [**get_presencedefinitions**](PresenceApi.html#get_presencedefinitions) | Get an Organization&#39;s list of Presence Definitions
 [**get_systempresences**](PresenceApi.html#get_systempresences) | Get the list of SystemPresences
 [**get_user_presence**](PresenceApi.html#get_user_presence) | Get a user&#39;s Presence
+[**get_user_presences_microsoftteams**](PresenceApi.html#get_user_presences_microsoftteams) | Get a user&#39;s Microsoft Teams presence.
+[**get_user_presences_purecloud**](PresenceApi.html#get_user_presences_purecloud) | Get a user&#39;s GenesysCloud presence.
 [**patch_user_presence**](PresenceApi.html#patch_user_presence) | Patch a user&#39;s Presence
+[**patch_user_presences_purecloud**](PresenceApi.html#patch_user_presences_purecloud) | Patch a GenesysCloud user&#39;s presence
 [**post_presencedefinitions**](PresenceApi.html#post_presencedefinitions) | Create a Presence Definition
 [**put_presencedefinition**](PresenceApi.html#put_presencedefinition) | Update a Presence Definition
 [**put_users_presences_bulk**](PresenceApi.html#put_users_presences_bulk) | Update bulk user Presences
 {: class="table table-striped"}
 
@@ -286,12 +289,12 @@
 
 
 
 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.
 
-
 Wraps GET /api/v2/users/{userId}/presences/{sourceId} 
 
 Requires NO permissions: 
 
 
@@ -313,11 +316,11 @@
 
 api_instance = PureCloud::PresenceApi.new
 
 user_id = "user_id_example" # String | user Id
 
-source_id = "source_id_example" # String | Source
+source_id = "source_id_example" # String | Presence source ID
 
 
 begin
   #Get a user's Presence
   result = api_instance.get_user_presence(user_id, source_id)
@@ -330,11 +333,11 @@
 ### Parameters
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **user_id** | **String**| user Id |  |
- **source_id** | **String**| Source |  |
+ **source_id** | **String**| Presence source ID |  |
 {: class="table table-striped"}
 
 
 ### Return type
 
@@ -345,19 +348,149 @@
  - **Content-Type**: application/json
  - **Accept**: application/json
 
 
 
+<a name="get_user_presences_microsoftteams"></a>
+
+## [**PresenceExpand**](PresenceExpand.html) get_user_presences_microsoftteams(user_id)
+
+
+
+Get a user's Microsoft Teams presence.
+
+Gets the presence for a Microsoft Teams user.  This will return the Microsoft Teams presence mapped to GenesysCloud presence with additional activity details in the message field. This presence source is read-only.
+
+Wraps GET /api/v2/users/{userId}/presences/microsoftteams 
+
+Requires ANY permissions: 
+
+* integration:microsoftTeams:view
+* integrations:integration:view
+
+
+### Example
+```{"language":"ruby"}
+# load the gem
+require 'purecloudplatformclientv2'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+
+api_instance = PureCloud::PresenceApi.new
+
+user_id = "user_id_example" # String | user Id
+
+
+begin
+  #Get a user's Microsoft Teams presence.
+  result = api_instance.get_user_presences_microsoftteams(user_id)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling PresenceApi->get_user_presences_microsoftteams: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| user Id |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**PresenceExpand**](PresenceExpand.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="get_user_presences_purecloud"></a>
+
+## [**UserPresence**](UserPresence.html) get_user_presences_purecloud(user_id)
+
+
+
+Get a user's GenesysCloud presence.
+
+Get the default GenesysCloud user presence source PURECLOUD
+
+Wraps GET /api/v2/users/{userId}/presences/purecloud 
+
+Requires NO permissions: 
+
+
+
+### Example
+```{"language":"ruby"}
+# load the gem
+require 'purecloudplatformclientv2'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+
+api_instance = PureCloud::PresenceApi.new
+
+user_id = "user_id_example" # String | user Id
+
+
+begin
+  #Get a user's GenesysCloud presence.
+  result = api_instance.get_user_presences_purecloud(user_id)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling PresenceApi->get_user_presences_purecloud: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| user Id |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**UserPresence**](UserPresence.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="patch_user_presence"></a>
 
 ## [**UserPresence**](UserPresence.html) patch_user_presence(user_id, source_id, body)
 
 
 
 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.
+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.
 
 Wraps PATCH /api/v2/users/{userId}/presences/{sourceId} 
 
 Requires NO permissions: 
 
@@ -380,11 +513,11 @@
 
 api_instance = PureCloud::PresenceApi.new
 
 user_id = "user_id_example" # String | user Id
 
-source_id = "source_id_example" # String | Source
+source_id = "source_id_example" # String | Presence source ID
 
 body = PureCloud::UserPresence.new # UserPresence | User presence
 
 
 begin
@@ -399,10 +532,77 @@
 ### Parameters
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **user_id** | **String**| user Id |  |
- **source_id** | **String**| Source |  |
+ **source_id** | **String**| Presence source ID |  |
+ **body** | [**UserPresence**](UserPresence.html)| User presence |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**UserPresence**](UserPresence.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="patch_user_presences_purecloud"></a>
+
+## [**UserPresence**](UserPresence.html) patch_user_presences_purecloud(user_id, body)
+
+
+
+Patch a GenesysCloud 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.
+
+Wraps PATCH /api/v2/users/{userId}/presences/purecloud 
+
+Requires NO permissions: 
+
+
+
+### Example
+```{"language":"ruby"}
+# load the gem
+require 'purecloudplatformclientv2'
+# setup authorization
+@secret = ENV['PURECLOUD_SECRET']
+@id = ENV['PURECLOUD_CLIENT_ID']
+environment = "mypurecloud.com"
+
+@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
+
+PureCloud.configure do |config|
+  config.access_token = @authToken
+end
+
+api_instance = PureCloud::PresenceApi.new
+
+user_id = "user_id_example" # String | user Id
+
+body = PureCloud::UserPresence.new # UserPresence | User presence
+
+
+begin
+  #Patch a GenesysCloud user's presence
+  result = api_instance.patch_user_presences_purecloud(user_id, body)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling PresenceApi->patch_user_presences_purecloud: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_id** | **String**| user Id |  |
  **body** | [**UserPresence**](UserPresence.html)| User presence |  |
 {: class="table table-striped"}
 
 
 ### Return type