purecloudplatformclientv2 95.0.0 → 96.0.0

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"}
+
+

data/docs/QueryResponseStats.md

@@ -0,0 +1,13 @@
+---
+title: QueryResponseStats
+---
+## PureCloud::QueryResponseStats
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **count** | **Integer** | The count for this metric | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ReportingDataExportTopicDataExportNotification.md

@@ -8,6 +8,7 @@ title: ReportingDataExportTopicDataExportNotification
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** |  | [optional] |
+| **run_id** | **String** |  | [optional] |
 | **name** | **String** |  | [optional] |
 | **status** | **String** |  | [optional] |
 | **export_format** | **String** |  | [optional] |

data/docs/ReportingExportJobResponse.md

@@ -9,6 +9,7 @@ title: ReportingExportJobResponse
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** | The globally unique identifier for the object. | [optional] |
 | **name** | **String** |  | [optional] |
+| **run_id** | **String** | The unique run id of the export schedule execute | |
 | **status** | **String** | The current status of the export request | |
 | **time_zone** | **String** | The requested timezone of the exported data. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London | |
 | **export_format** | **String** | The requested format of the exported data | |

data/docs/RoutingApi.md

@@ -1511,7 +1511,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **messenger_type** | **String**| Messenger Type | [optional] <br />**Values**: sms, facebook, twitter, line, whatsapp |
+ **messenger_type** | **String**| Messenger Type | [optional] <br />**Values**: sms, facebook, twitter, line, whatsapp, webmessaging |
  **page_size** | **Integer**| Page size | [optional] [default to 25] |
  **page_number** | **Integer**| Page number | [optional] [default to 1] |
 {: class="table table-striped"}

data/docs/SearchApi.md

@@ -1002,8 +1002,9 @@ Search users
 
 Wraps POST /api/v2/users/search 
 
-Requires NO permissions: 
+Requires ANY permissions: 
 
+* directory:user:view
 
 
 ### Example

data/docs/SpeechTextAnalyticsApi.md

@@ -8,9 +8,75 @@ All URIs are relative to *https://api.mypurecloud.com*
 
 Method | Description
 ------------- | ------------- | -------------
+[**get_speechandtextanalytics_conversation**](SpeechTextAnalyticsApi.html#get_speechandtextanalytics_conversation) | Get Speech and Text Analytics for a specific conversation
 [**get_speechandtextanalytics_conversation_communication_transcripturl**](SpeechTextAnalyticsApi.html#get_speechandtextanalytics_conversation_communication_transcripturl) | Get the pre-signed S3 URL for the transcript of a specific communication of a conversation
 {: class="table table-striped"}
 
+<a name="get_speechandtextanalytics_conversation"></a>
+
+## [**ConversationMetrics**](ConversationMetrics.html) get_speechandtextanalytics_conversation(conversation_id)
+
+
+
+Get Speech and Text Analytics for a specific conversation
+
+
+
+Wraps GET /api/v2/speechandtextanalytics/conversations/{conversationId} 
+
+Requires ANY permissions: 
+
+* recording:recording: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::SpeechTextAnalyticsApi.new
+
+conversation_id = "conversation_id_example" # String | Conversation Id
+
+
+begin
+  #Get Speech and Text Analytics for a specific conversation
+  result = api_instance.get_speechandtextanalytics_conversation(conversation_id)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_conversation: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **conversation_id** | **String**| Conversation Id |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**ConversationMetrics**](ConversationMetrics.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 <a name="get_speechandtextanalytics_conversation_communication_transcripturl"></a>
 
 ## [**TranscriptUrl**](TranscriptUrl.html) get_speechandtextanalytics_conversation_communication_transcripturl(conversation_id, communication_id)

data/docs/StatEventFlowOutcomeTopicDatum.md

@@ -0,0 +1,14 @@
+---
+title: StatEventFlowOutcomeTopicDatum
+---
+## PureCloud::StatEventFlowOutcomeTopicDatum
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **interval** | **String** |  | [optional] |
+| **metrics** | [**Array<StatEventFlowOutcomeTopicMetric>**](StatEventFlowOutcomeTopicMetric.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/StatEventFlowOutcomeTopicMetric.md

@@ -0,0 +1,15 @@
+---
+title: StatEventFlowOutcomeTopicMetric
+---
+## PureCloud::StatEventFlowOutcomeTopicMetric
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **metric** | **String** |  | [optional] |
+| **qualifier** | **String** |  | [optional] |
+| **stats** | **Hash<String, Float>** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/StatEventFlowOutcomeTopicStatsNotification.md

@@ -0,0 +1,14 @@
+---
+title: StatEventFlowOutcomeTopicStatsNotification
+---
+## PureCloud::StatEventFlowOutcomeTopicStatsNotification
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **group** | **Hash<String, String>** |  | [optional] |
+| **data** | [**Array<StatEventFlowOutcomeTopicDatum>**](StatEventFlowOutcomeTopicDatum.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/StatEventFlowTopicDatum.md

@@ -0,0 +1,14 @@
+---
+title: StatEventFlowTopicDatum
+---
+## PureCloud::StatEventFlowTopicDatum
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **interval** | **String** |  | [optional] |
+| **metrics** | [**Array<StatEventFlowTopicMetric>**](StatEventFlowTopicMetric.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/StatEventFlowTopicMetric.md

@@ -0,0 +1,15 @@
+---
+title: StatEventFlowTopicMetric
+---
+## PureCloud::StatEventFlowTopicMetric
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **metric** | **String** |  | [optional] |
+| **qualifier** | **String** |  | [optional] |
+| **stats** | **Hash<String, Float>** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/StatEventFlowTopicStatsNotification.md

@@ -0,0 +1,14 @@
+---
+title: StatEventFlowTopicStatsNotification
+---
+## PureCloud::StatEventFlowTopicStatsNotification
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **group** | **Hash<String, String>** |  | [optional] |
+| **data** | [**Array<StatEventFlowTopicDatum>**](StatEventFlowTopicDatum.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/StatEventWrapUpCodeTopicDatum.md

@@ -0,0 +1,14 @@
+---
+title: StatEventWrapUpCodeTopicDatum
+---
+## PureCloud::StatEventWrapUpCodeTopicDatum
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **interval** | **String** |  | [optional] |
+| **metrics** | [**Array<StatEventWrapUpCodeTopicMetric>**](StatEventWrapUpCodeTopicMetric.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/StatEventWrapUpCodeTopicMetric.md

@@ -0,0 +1,15 @@
+---
+title: StatEventWrapUpCodeTopicMetric
+---
+## PureCloud::StatEventWrapUpCodeTopicMetric
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **metric** | **String** |  | [optional] |
+| **qualifier** | **String** |  | [optional] |
+| **stats** | **Hash<String, Float>** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/StatEventWrapUpCodeTopicStatsNotification.md

@@ -0,0 +1,14 @@
+---
+title: StatEventWrapUpCodeTopicStatsNotification
+---
+## PureCloud::StatEventWrapUpCodeTopicStatsNotification
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **group** | **Hash<String, String>** |  | [optional] |
+| **data** | [**Array<StatEventWrapUpCodeTopicDatum>**](StatEventWrapUpCodeTopicDatum.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/UserScheduleAdherence.md

@@ -11,6 +11,7 @@ title: UserScheduleAdherence
 | **name** | **String** |  | [optional] |
 | **user** | [**UserReference**](UserReference.html) | The user for whom this status applies | [optional] |
 | **management_unit** | [**ManagementUnit**](ManagementUnit.html) | The management unit to which this user belongs | [optional] |
+| **team** | [**Team**](Team.html) | The team to which this user belongs | [optional] |
 | **scheduled_activity_category** | **String** | Activity for which the user is scheduled | [optional] |
 | **system_presence** | **String** | Actual underlying system presence value | [optional] |
 | **organization_secondary_presence_id** | **String** | Organization Secondary Presence Id. | [optional] |

data/docs/UserSearchRequest.md

@@ -15,6 +15,7 @@ title: UserSearchRequest
 | **expand** | **Array<String>** | Provides more details about a specified resource | [optional] |
 | **query** | [**Array<UserSearchCriteria>**](UserSearchCriteria.html) |  | [optional] |
 | **integration_presence_source** | **String** | Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \"expand\". When using this parameter the maximum number of users that can be returned is 10. | [optional] |
+| **enforce_permissions** | **BOOLEAN** | Enforce view permission on request | [optional] |
 {: class="table table-striped"}
 
 

data/docs/UsersApi.md

@@ -4171,8 +4171,9 @@ Search users
 
 Wraps POST /api/v2/users/search 
 
-Requires NO permissions: 
+Requires ANY permissions: 
 
+* directory:user:view
 
 
 ### Example

data/docs/WemCoachingAppointmentTopicCoachingAppointmentNotification.md

@@ -21,6 +21,7 @@ title: WemCoachingAppointmentTopicCoachingAppointmentNotification
 | **conversations** | [**Array<WemCoachingAppointmentTopicCoachingAppointmentConversation>**](WemCoachingAppointmentTopicCoachingAppointmentConversation.html) |  | [optional] |
 | **documents** | [**Array<WemCoachingAppointmentTopicCoachingAppointmentDocument>**](WemCoachingAppointmentTopicCoachingAppointmentDocument.html) |  | [optional] |
 | **change_type** | **String** |  | [optional] |
+| **date_completed** | **DateTime** |  | [optional] |
 {: class="table table-striped"}
 
 

data/docs/WfmBusinessUnitReference.md

@@ -7,7 +7,7 @@ title: WfmBusinessUnitReference
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **id** | **String** | The ID of the business unit | |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

data/docs/WfmScheduleReference.md

@@ -7,9 +7,9 @@ title: WfmScheduleReference
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **id** | **String** | The globally unique identifier for the object. | [optional] |
-| **business_unit** | [**WfmBusinessUnitReference**](WfmBusinessUnitReference.html) | A reference to a Workforce Management Business Unit | [optional] |
-| **week_date** | **Date** | The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | [optional] |
+| **id** | **String** | The ID of the WFM schedule | |
+| **business_unit** | [**WfmBusinessUnitReference**](WfmBusinessUnitReference.html) | A reference to a Workforce Management Business Unit | |
+| **week_date** | **Date** | The start week date for this schedule. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

data/docs/WfmUserScheduleAdherenceUpdatedMuTopicUriReference.md

@@ -0,0 +1,14 @@
+---
+title: WfmUserScheduleAdherenceUpdatedMuTopicUriReference
+---
+## PureCloud::WfmUserScheduleAdherenceUpdatedMuTopicUriReference
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/WfmUserScheduleAdherenceUpdatedMuTopicUserScheduleAdherenceUpdate.md

@@ -9,6 +9,7 @@ title: WfmUserScheduleAdherenceUpdatedMuTopicUserScheduleAdherenceUpdate
 |------------ | ------------- | ------------- | -------------|
 | **user** | [**WfmUserScheduleAdherenceUpdatedMuTopicUserReference**](WfmUserScheduleAdherenceUpdatedMuTopicUserReference.html) |  | [optional] |
 | **management_unit_id** | **String** |  | [optional] |
+| **team** | [**WfmUserScheduleAdherenceUpdatedMuTopicUriReference**](WfmUserScheduleAdherenceUpdatedMuTopicUriReference.html) |  | [optional] |
 | **scheduled_activity_category** | **String** |  | [optional] |
 | **system_presence** | **String** |  | [optional] |
 | **organization_secondary_presence_id** | **String** |  | [optional] |

data/docs/WfmUserScheduleAdherenceUpdatedTeamTopicQueueReference.md

@@ -0,0 +1,13 @@
+---
+title: WfmUserScheduleAdherenceUpdatedTeamTopicQueueReference
+---
+## PureCloud::WfmUserScheduleAdherenceUpdatedTeamTopicQueueReference
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** |  | [optional] |
+{: class="table table-striped"}
+
+