purecloudplatformclientv2 91.0.0 → 96.0.0

data/docs/Permissions.md

@@ -7,8 +7,6 @@ title: Permissions
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **id** | **String** | The globally unique identifier for the object. | [optional] |
-| **name** | **String** |  | [optional] |
 | **ids** | **Array<String>** | List of permission ids. | |
 {: class="table table-striped"}
 

data/docs/PhoneCapabilities.md

@@ -15,6 +15,7 @@ title: PhoneCapabilities
 | **no_rebalance** | **BOOLEAN** |  | [optional] |
 | **no_cloud_provisioning** | **BOOLEAN** |  | [optional] |
 | **media_codecs** | **Array<String>** |  | [optional] |
+| **cdm** | **BOOLEAN** |  | [optional] |
 {: class="table table-striped"}
 
 

data/docs/PostTextMessage.md

@@ -0,0 +1,15 @@
+---
+title: PostTextMessage
+---
+## PureCloud::PostTextMessage
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **type** | **String** | Message type | |
+| **text** | **String** | Message text. If type is structured, used as fallback for clients that do not support particular structured content | [optional] |
+| **content** | [**Array<MessageContent>**](MessageContent.html) | A list of content elements in message | [optional] |
+{: class="table table-striped"}
+
+

data/docs/PostTextRequest.md

@@ -0,0 +1,23 @@
+---
+title: PostTextRequest
+---
+## PureCloud::PostTextRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **bot_id** | **String** | ID of the bot to send the text to. | |
+| **bot_alias** | **String** | Alias/Version of the bot | [optional] |
+| **integration_id** | **String** | the integration service id for the bot's credentials | |
+| **bot_session_id** | **String** | GUID for this bot's session | |
+| **post_text_message** | [**PostTextMessage**](PostTextMessage.html) | Message to send to the bot | |
+| **language_code** | **String** | The launguage code the bot will run under | [optional] |
+| **bot_session_timeout_minutes** | **Integer** | Override timeout for the bot session. This should be greater than 10 minutes. | [optional] |
+| **bot_channels** | **Array<String>** | The channels this bot is utilizing | [optional] |
+| **bot_correlation_id** | **String** | Id for tracking the activity - this will be returned in the response | [optional] |
+| **amazon_lex_request** | [**AmazonLexRequest**](AmazonLexRequest.html) |  | [optional] |
+| **google_dialogflow** | [**GoogleDialogflowCustomSettings**](GoogleDialogflowCustomSettings.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/PostTextResponse.md

@@ -0,0 +1,20 @@
+---
+title: PostTextResponse
+---
+## PureCloud::PostTextResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **bot_state** | **String** | The state of the bot after completion of the request | |
+| **reply_messages** | [**Array<PostTextMessage>**](PostTextMessage.html) | The list of messages to respond with, if any | [optional] |
+| **intent_name** | **String** | The name of the intent the bot is either processing or has processed, this will be blank if no intent could be detected. | [optional] |
+| **slots** | **Hash<String, String>** | Data parameters detected and filled by the bot. | [optional] |
+| **bot_correlation_id** | **String** | The optional ID specified in the request | [optional] |
+| **amazon_lex** | **Hash<String, Object>** | Raw data response from AWS (if called) | [optional] |
+| **google_dialog_flow** | **Hash<String, Object>** | Raw data response from Google Dialogflow (if called) | [optional] |
+| **genesys_dialog_engine** | **Hash<String, Object>** | Raw data response from Genesys' Dialogengine (if called) | [optional] |
+{: class="table table-striped"}
+
+

data/docs/PresenceApi.md

@@ -13,7 +13,10 @@ Method | Description
 [**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_presence**](PresenceApi.html#get_user_presence) | Get a user's Presence
+[**get_user_presences_microsoftteams**](PresenceApi.html#get_user_presences_microsoftteams) | Get a user's Microsoft Teams presence.
+[**get_user_presences_purecloud**](PresenceApi.html#get_user_presences_purecloud) | Get a user's Genesys Cloud presence.
 [**patch_user_presence**](PresenceApi.html#patch_user_presence) | Patch a user's Presence
+[**patch_user_presences_purecloud**](PresenceApi.html#patch_user_presences_purecloud) | Patch a Genesys Cloud user'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
@@ -288,7 +291,7 @@ This endpoint does not need any parameter.
 
 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} 
 
@@ -315,7 +318,7 @@ 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
@@ -332,7 +335,137 @@ end
 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
+
+[**UserPresence**](UserPresence.html)
+
+### HTTP request headers
+
+ - **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 Genesys Cloud 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 Genesys Cloud presence.
+
+Get the default Genesys Cloud 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 Genesys Cloud 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"}
 
 
@@ -355,7 +488,7 @@ Name | Type | Description  | Notes
 
 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} 
 
@@ -382,7 +515,7 @@ 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
 
@@ -401,7 +534,74 @@ end
 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 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.
+
+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 Genesys Cloud 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"}
 

data/docs/PresenceExpand.md

@@ -0,0 +1,17 @@
+---
+title: PresenceExpand
+---
+## PureCloud::PresenceExpand
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **name** | **String** |  | [optional] |
+| **presences** | [**Array<UserPresence>**](UserPresence.html) | An array of user presences | [optional] |
+| **out_of_offices** | [**Array<OutOfOffice>**](OutOfOffice.html) | An array of out of office statuses | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/QueryRequestClause.md

@@ -0,0 +1,14 @@
+---
+title: QueryRequestClause
+---
+## PureCloud::QueryRequestClause
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **type** | **String** | The logic used to combine the predicates | |
+| **predicates** | [**Array<QueryRequestPredicate>**](QueryRequestPredicate.html) | The list of predicates used to filter the data | |
+{: class="table table-striped"}
+
+

data/docs/QueryRequestFilter.md

@@ -0,0 +1,14 @@
+---
+title: QueryRequestFilter
+---
+## PureCloud::QueryRequestFilter
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **type** | **String** | The logic used to combine the clauses | |
+| **clauses** | [**Array<QueryRequestClause>**](QueryRequestClause.html) | The list of clauses used to filter the data | |
+{: class="table table-striped"}
+
+

data/docs/QueryRequestPredicate.md

@@ -0,0 +1,14 @@
+---
+title: QueryRequestPredicate
+---
+## PureCloud::QueryRequestPredicate
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **dimension** | **String** | The dimension to be filtered | |
+| **value** | **String** | The value to filter by | |
+{: class="table table-striped"}
+
+

data/docs/QueryResponseData.md

@@ -0,0 +1,14 @@
+---
+title: QueryResponseData
+---
+## PureCloud::QueryResponseData
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **interval** | **String** | Interval with start and end represented as ISO-8601 string. i.e: yyyy-MM-dd'T'HH:mm:ss.SSS'Z'/yyyy-MM-dd'T'HH:mm:ss.SSS'Z' | [optional] |
+| **metrics** | [**Array<QueryResponseMetric>**](QueryResponseMetric.html) | A list of aggregated metrics | [optional] |
+{: class="table table-striped"}
+
+

data/docs/QueryResponseGroupedData.md

@@ -0,0 +1,14 @@
+---
+title: QueryResponseGroupedData
+---
+## PureCloud::QueryResponseGroupedData
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **group** | **Hash<String, String>** | The group values for this data | [optional] |
+| **data** | [**Array<QueryResponseData>**](QueryResponseData.html) | The metrics in this group | [optional] |
+{: class="table table-striped"}
+
+

data/docs/QueryResponseMetric.md

@@ -0,0 +1,14 @@
+---
+title: QueryResponseMetric
+---
+## PureCloud::QueryResponseMetric
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **metric** | **String** | The metric this applies to | [optional] |
+| **stats** | [**QueryResponseStats**](QueryResponseStats.html) | The aggregated values for this metric | [optional] |
+{: class="table table-striped"}
+
+