purecloudplatformclientv2 86.0.0 → 91.0.0

data/docs/ReportingDataExportTopicDataExportNotification.md

@@ -18,6 +18,7 @@ title: ReportingDataExportTopicDataExportNotification
 | **created_date_time** | **DateTime** |  | [optional] |
 | **modified_date_time** | **DateTime** |  | [optional] |
 | **percentage_complete** | **Float** |  | [optional] |
+| **email_statuses** | **Hash<String, String>** |  | [optional] |
 {: class="table table-striped"}
 
 

data/docs/ScimEmail.md

@@ -7,7 +7,7 @@ title: ScimEmail
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **value** | **String** | The email address. | [optional] |
+| **value** | **String** | The email address. Note value for type 'other'is immutable. | [optional] |
 | **type** | **String** | The type of email address. | [optional] |
 | **primary** | **BOOLEAN** | Indicates whether the email address is the primary email address. | [optional] |
 {: class="table table-striped"}

data/docs/SurveyAggregationQuery.md

@@ -9,7 +9,7 @@ title: SurveyAggregationQuery
 |------------ | ------------- | ------------- | -------------|
 | **interval** | **String** | Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | |
 | **granularity** | **String** | Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H | [optional] |
-| **time_zone** | **String** | Sets the time zone for the query interval, defaults to UTC. 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 | [optional] |
+| **time_zone** | **String** | Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. 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 | [optional] |
 | **group_by** | **Array<String>** | Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group. | [optional] |
 | **filter** | [**SurveyAggregateQueryFilter**](SurveyAggregateQueryFilter.html) | Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters | [optional] |
 | **metrics** | **Array<String>** | Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *). | [optional] |

data/docs/UpdateCoachingAppointmentRequest.md

@@ -0,0 +1,18 @@
+---
+title: UpdateCoachingAppointmentRequest
+---
+## PureCloud::UpdateCoachingAppointmentRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **name** | **String** | The name of coaching appointment. | [optional] |
+| **description** | **String** | The description of coaching appointment. | [optional] |
+| **date_start** | **DateTime** | The date/time the coaching appointment starts. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **length_in_minutes** | **Integer** | The duration of coaching appointment in minutes. | [optional] |
+| **conversation_ids** | **Array<String>** | IDs of conversations associated with this coaching appointment. | [optional] |
+| **document_ids** | **Array<String>** | IDs of documents associated with this coaching appointment. | [optional] |
+{: class="table table-striped"}
+
+

data/docs/UploadUrlRequest.md

@@ -10,6 +10,7 @@ title: UploadUrlRequest
 | **file_name** | **String** | Name of the file to upload. It must not start with a dot and not end with a forward slash. Whitespace and the following characters are not allowed: \\{^}%`]\">[~<#| | [optional] |
 | **content_md5** | **String** | Content MD-5 of the file to upload | [optional] |
 | **signed_url_timeout_seconds** | **Integer** | The number of seconds the presigned URL is valid for (from 1 to 604800 seconds). If none provided, defaults to 600 seconds | [optional] |
+| **server_side_encryption** | **String** |  | [optional] |
 {: class="table table-striped"}
 
 

data/docs/UsageApi.md

@@ -0,0 +1,144 @@
+---
+title: UsageApi
+---
+
+## PureCloud::UsageApi
+
+All URIs are relative to *https://api.mypurecloud.com*
+
+Method | Description
+------------- | ------------- | -------------
+[**get_usage_query_execution_id_results**](UsageApi.html#get_usage_query_execution_id_results) | Get the results of a usage query
+[**post_usage_query**](UsageApi.html#post_usage_query) | Query organization API Usage - 
+{: class="table table-striped"}
+
+<a name="get_usage_query_execution_id_results"></a>
+
+## [**ApiUsageQueryResult**](ApiUsageQueryResult.html) get_usage_query_execution_id_results(execution_id)
+
+
+
+Get the results of a usage query
+
+
+
+Wraps GET /api/v2/usage/query/{executionId}/results 
+
+Requires ANY permissions: 
+
+* oauth:client: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::UsageApi.new
+
+execution_id = "execution_id_example" # String | ID of the query execution
+
+
+begin
+  #Get the results of a usage query
+  result = api_instance.get_usage_query_execution_id_results(execution_id)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling UsageApi->get_usage_query_execution_id_results: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **execution_id** | **String**| ID of the query execution |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**ApiUsageQueryResult**](ApiUsageQueryResult.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+<a name="post_usage_query"></a>
+
+## [**UsageExecutionResult**](UsageExecutionResult.html) post_usage_query(body)
+
+
+
+Query organization API Usage - 
+
+After calling this method, you will then need to poll for the query results based on the returned execution Id
+
+Wraps POST /api/v2/usage/query 
+
+Requires ANY permissions: 
+
+* oauth:client: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::UsageApi.new
+
+body = PureCloud::ApiUsageQuery.new # ApiUsageQuery | Query
+
+
+begin
+  #Query organization API Usage - 
+  result = api_instance.post_usage_query(body)
+  p result
+rescue PureCloud::ApiError => e
+  puts "Exception when calling UsageApi->post_usage_query: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**ApiUsageQuery**](ApiUsageQuery.html)| Query |  |
+{: class="table table-striped"}
+
+
+### Return type
+
+[**UsageExecutionResult**](UsageExecutionResult.html)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/UsageExecutionResult.md

@@ -0,0 +1,14 @@
+---
+title: UsageExecutionResult
+---
+## PureCloud::UsageExecutionResult
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **execution_id** | **String** | The id of the query execution | [optional] |
+| **results_uri** | **String** | URI where the query results can be retrieved | [optional] |
+{: class="table table-striped"}
+
+

data/docs/UserAggregationQuery.md

@@ -9,7 +9,7 @@ title: UserAggregationQuery
 |------------ | ------------- | ------------- | -------------|
 | **interval** | **String** | Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | |
 | **granularity** | **String** | Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H | [optional] |
-| **time_zone** | **String** | Sets the time zone for the query interval, defaults to UTC. 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 | [optional] |
+| **time_zone** | **String** | Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. 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 | [optional] |
 | **group_by** | **Array<String>** | Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group. | [optional] |
 | **filter** | [**UserAggregateQueryFilter**](UserAggregateQueryFilter.html) | Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters | [optional] |
 | **metrics** | **Array<String>** | Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *). | [optional] |

data/docs/UserQueue.md

@@ -17,6 +17,7 @@ title: UserQueue
 | **created_by** | **String** | The ID of the user that created the queue. | [optional] |
 | **member_count** | **Integer** | The number of users in the queue. | [optional] |
 | **media_settings** | [**Hash<String, MediaSetting>**](MediaSetting.html) | The media settings for the queue. Valid key values: CALL, CALLBACK, CHAT, EMAIL, MESSAGE, SOCIAL_EXPRESSION, VIDEO_COMM | [optional] |
+| **routing_rules** | [**Array<RoutingRule>**](RoutingRule.html) | The routing rules for the queue, used for routing to known or preferred agents. | [optional] |
 | **bullseye** | [**Bullseye**](Bullseye.html) | The bulls-eye settings for the queue. | [optional] |
 | **acw_settings** | [**AcwSettings**](AcwSettings.html) | The ACW settings for the queue. | [optional] |
 | **skill_evaluation_method** | **String** | The skill evaluation method to use when routing conversations. | [optional] |

data/docs/UsersApi.md

@@ -1145,11 +1145,11 @@ Name | Type | Description  | Notes
 
 ## [**UserProfileEntityListing**](UserProfileEntityListing.html) get_profiles_users(opts)
 
-
+<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
 
 Get a user profile listing
 
-
+This api is deprecated. User /api/v2/users
 
 Wraps GET /api/v2/profiles/users 
 
@@ -1761,11 +1761,11 @@ Name | Type | Description  | Notes
 
 ## [**UserProfile**](UserProfile.html) get_user_profile(user_id, opts)
 
-
+<span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span>
 
 Get user profile
 
-
+This api has been deprecated. Use api/v2/users instead
 
 Wraps GET /api/v2/users/{userId}/profile 
 
@@ -1810,7 +1810,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **user_id** | **String**| userId |  |
- **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, lasttokenissued, authorization.unusedRoles, team, profileSkills, certifications, locations, groups, skills, languages, languagePreference, employerInfo, biography |
+ **expand** | [**Array&lt;String&gt;**](String.html)| Which fields, if any, to expand | [optional] <br />**Values**: routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, lasttokenissued, authorization.unusedRoles, team |
 {: class="table table-striped"}
 
 

data/docs/ViewFilter.md

@@ -85,6 +85,8 @@ title: ViewFilter
 | **location_ids** | **Array<String>** | The location Ids used to filter the view | [optional] |
 | **flow_out_types** | **Array<String>** | A list of flow out types | [optional] |
 | **provider_list** | **Array<String>** | A list of providers | [optional] |
+| **callback_number_list** | **Array<String>** | A list of callback numbers or substrings of numbers (ex: [\"317\", \"13172222222\"]) | [optional] |
+| **callback_interval** | **String** | An interval of time to filter for scheduled callbacks. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss | [optional] |
 {: class="table table-striped"}
 
 

data/docs/VoicemailMessagesTopicOwner.md

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

data/docs/VoicemailMessagesTopicVoicemailCopyRecord.md

@@ -0,0 +1,14 @@
+---
+title: VoicemailMessagesTopicVoicemailCopyRecord
+---
+## PureCloud::VoicemailMessagesTopicVoicemailCopyRecord
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **user** | [**VoicemailMessagesTopicOwner**](VoicemailMessagesTopicOwner.html) |  | [optional] |
+| **group** | [**VoicemailMessagesTopicOwner**](VoicemailMessagesTopicOwner.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/VoicemailMessagesTopicVoicemailMessage.md

@@ -19,6 +19,8 @@ title: VoicemailMessagesTopicVoicemailMessage
 | **note** | **String** |  | [optional] |
 | **deleted** | **BOOLEAN** |  | [optional] |
 | **modified_by_user_id** | **String** |  | [optional] |
+| **copied_to** | [**Array<VoicemailMessagesTopicVoicemailCopyRecord>**](VoicemailMessagesTopicVoicemailCopyRecord.html) |  | [optional] |
+| **copied_from** | [**VoicemailMessagesTopicVoicemailCopyRecord**](VoicemailMessagesTopicVoicemailCopyRecord.html) |  | [optional] |
 {: class="table table-striped"}
 
 

data/docs/WemLearningAssignmentRuleRunTopicLearningAssignmentRuleRunNotification.md

@@ -0,0 +1,14 @@
+---
+title: WemLearningAssignmentRuleRunTopicLearningAssignmentRuleRunNotification
+---
+## PureCloud::WemLearningAssignmentRuleRunTopicLearningAssignmentRuleRunNotification
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **entities** | [**Array<WemLearningAssignmentRuleRunTopicWemLearningAssignmentsCreated>**](WemLearningAssignmentRuleRunTopicWemLearningAssignmentsCreated.html) |  | [optional] |
+| **total** | **Integer** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/WemLearningAssignmentRuleRunTopicLearningModuleReference.md

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

data/docs/WemLearningAssignmentRuleRunTopicWemLearningAssignmentsCreated.md

@@ -0,0 +1,13 @@
+---
+title: WemLearningAssignmentRuleRunTopicWemLearningAssignmentsCreated
+---
+## PureCloud::WemLearningAssignmentRuleRunTopicWemLearningAssignmentsCreated
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **_module** | [**WemLearningAssignmentRuleRunTopicLearningModuleReference**](WemLearningAssignmentRuleRunTopicLearningModuleReference.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/WemLearningAssignmentTopicLearningAssignmentNotification.md

@@ -0,0 +1,22 @@
+---
+title: WemLearningAssignmentTopicLearningAssignmentNotification
+---
+## PureCloud::WemLearningAssignmentTopicLearningAssignmentNotification
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** |  | [optional] |
+| **user** | [**WemLearningAssignmentTopicUserReference**](WemLearningAssignmentTopicUserReference.html) |  | [optional] |
+| **_module** | [**WemLearningAssignmentTopicLearningModuleReference**](WemLearningAssignmentTopicLearningModuleReference.html) |  | [optional] |
+| **version** | **Integer** |  | [optional] |
+| **state** | **String** |  | [optional] |
+| **date_recommended_for_completion** | **DateTime** |  | [optional] |
+| **created_by** | [**WemLearningAssignmentTopicUserReference**](WemLearningAssignmentTopicUserReference.html) |  | [optional] |
+| **date_created** | **DateTime** |  | [optional] |
+| **modified_by** | [**WemLearningAssignmentTopicUserReference**](WemLearningAssignmentTopicUserReference.html) |  | [optional] |
+| **date_modified** | **DateTime** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/WemLearningAssignmentTopicLearningModuleReference.md

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

data/docs/WemLearningAssignmentTopicUserReference.md

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

data/docs/WfmBuShortTermForecastImportCompleteTopicBuForecastModification.md

@@ -0,0 +1,23 @@
+---
+title: WfmBuShortTermForecastImportCompleteTopicBuForecastModification
+---
+## PureCloud::WfmBuShortTermForecastImportCompleteTopicBuForecastModification
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **type** | **String** |  | [optional] |
+| **start_interval_index** | **Integer** |  | [optional] |
+| **end_interval_index** | **Integer** |  | [optional] |
+| **metric** | **String** |  | [optional] |
+| **legacy_metric** | **String** |  | [optional] |
+| **value** | **Float** |  | [optional] |
+| **values** | [**Array<WfmBuShortTermForecastImportCompleteTopicModificationIntervalOffsetValue>**](WfmBuShortTermForecastImportCompleteTopicModificationIntervalOffsetValue.html) |  | [optional] |
+| **enabled** | **BOOLEAN** |  | [optional] |
+| **granularity** | **String** |  | [optional] |
+| **display_granularity** | **String** |  | [optional] |
+| **planning_group_ids** | **Array<String>** |  | [optional] |
+{: class="table table-striped"}
+
+