purecloudplatformclientv2 36.1.0 → 37.0.0

data/docs/DateRange.md

@@ -0,0 +1,14 @@
+---
+title: DateRange
+---
+## PureCloud::DateRange
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **start_date** | **String** | The inclusive start of a date range in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. | [optional] |
+| **end_date** | **String** | The inclusive end of a date range in yyyy-MM-dd format. Should be interpreted in the management unit's configured time zone. | [optional] |
+{: class="table table-striped"}
+
+

data/docs/DeletableUserReference.md

@@ -0,0 +1,15 @@
+---
+title: DeletableUserReference
+---
+## PureCloud::DeletableUserReference
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **delete** | **BOOLEAN** | If marked true, the user will be removed an associated entity | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/EmailMediaPolicyConditions.md

@@ -11,6 +11,7 @@ title: EmailMediaPolicyConditions
 | **date_ranges** | **Array<String>** |  | [optional] |
 | **for_queues** | [**Array<Queue>**](Queue.html) |  | [optional] |
 | **wrapup_codes** | [**Array<WrapupCode>**](WrapupCode.html) |  | [optional] |
+| **languages** | [**Array<Language>**](Language.html) |  | [optional] |
 | **time_allowed** | [**TimeAllowed**](TimeAllowed.html) |  | [optional] |
 {: class="table table-striped"}
 

data/docs/ExternalContact.md

@@ -22,11 +22,13 @@ title: ExternalContact
 | **other_email** | **String** |  | [optional] |
 | **address** | [**ContactAddress**](ContactAddress.html) |  | [optional] |
 | **twitter_id** | [**TwitterId**](TwitterId.html) |  | [optional] |
+| **line_id** | [**LineId**](LineId.html) |  | [optional] |
+| **facebook_id** | [**FacebookId**](FacebookId.html) |  | [optional] |
 | **modify_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **create_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **external_organization** | [**ExternalOrganization**](ExternalOrganization.html) |  | [optional] |
 | **survey_opt_out** | **BOOLEAN** |  | [optional] |
-| **external_system_url** | **String** | A string that identifies an external system-of-record resource that may have more detailed information on the organization. It should be a valid URL (including the HTTP protocol, port, and path [if any]). The value is automatically trimmed of any leading and trailing whitespace. | [optional] |
+| **external_system_url** | **String** | A string that identifies an external system-of-record resource that may have more detailed information on the contact. It should be a valid URL (including the http/https protocol, port, and path [if any]). The value is automatically trimmed of any leading and trailing whitespace. | [optional] |
 | **external_data_sources** | [**Array<ExternalDataSource>**](ExternalDataSource.html) | Links to the sources of data (e.g. one source might be a CRM) that contributed data to this record.  Read-only, and only populated when requested via expand param. | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}

data/docs/ExternalOrganization.md

@@ -21,7 +21,7 @@ title: ExternalOrganization
 | **websites** | **Array<String>** |  | [optional] |
 | **tickers** | [**Array<Ticker>**](Ticker.html) |  | [optional] |
 | **twitter_id** | [**TwitterId**](TwitterId.html) |  | [optional] |
-| **external_system_url** | **String** | A string that identifies an external system-of-record resource that may have more detailed information on the organization. It should be a valid URL (including the HTTP protocol, port, and path [if any]). The value is automatically trimmed of any leading and trailing whitespace. | [optional] |
+| **external_system_url** | **String** | A string that identifies an external system-of-record resource that may have more detailed information on the organization. It should be a valid URL (including the http/https protocol, port, and path [if any]). The value is automatically trimmed of any leading and trailing whitespace. | [optional] |
 | **modify_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **create_date** | **DateTime** | Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **trustor** | [**Trustor**](Trustor.html) |  | [optional] |

data/docs/FacebookId.md

@@ -0,0 +1,14 @@
+---
+title: FacebookId
+---
+## PureCloud::FacebookId
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **ids** | [**Array<FacebookScopedId>**](FacebookScopedId.html) | The set of scopedIds that this person has. Each scopedId is specific to a page or app that the user interacts with. | [optional] |
+| **display_name** | **String** | The displayName of this person's Facebook account. Roughly translates to user.first_name + ' ' + user.last_name in the Facebook API. | [optional] |
+{: class="table table-striped"}
+
+

data/docs/FacebookScopedId.md

@@ -0,0 +1,13 @@
+---
+title: FacebookScopedId
+---
+## PureCloud::FacebookScopedId
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **scoped_id** | **String** | The unique page/app-specific scopedId for the user | [optional] |
+{: class="table table-striped"}
+
+

data/docs/FlowOutcomeNotificationNotification.md

@@ -0,0 +1,16 @@
+---
+title: FlowOutcomeNotificationNotification
+---
+## PureCloud::FlowOutcomeNotificationNotification
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **current_operation** | [**PromptNotificationNotificationCurrentOperation**](PromptNotificationNotificationCurrentOperation.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/FlowOutcomeNotificationNotificationArchitectOperation.md

@@ -0,0 +1,21 @@
+---
+title: FlowOutcomeNotificationNotificationArchitectOperation
+---
+## PureCloud::FlowOutcomeNotificationNotificationArchitectOperation
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** |  | [optional] |
+| **complete** | **BOOLEAN** |  | [optional] |
+| **user** | [**DependencyTrackingBuildNotificationNotificationUser**](DependencyTrackingBuildNotificationNotificationUser.html) |  | [optional] |
+| **action_name** | **String** |  | [optional] |
+| **action_status** | **String** |  | [optional] |
+| **error_message** | **String** |  | [optional] |
+| **error_code** | **String** |  | [optional] |
+| **error_message_params** | [**PromptNotificationNotificationCurrentOperationErrorMessageParams**](PromptNotificationNotificationCurrentOperationErrorMessageParams.html) |  | [optional] |
+| **error_details** | [**Array<PromptNotificationNotificationCurrentOperationErrorDetails>**](PromptNotificationNotificationCurrentOperationErrorDetails.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/FlowOutcomeNotificationNotificationErrorDetail.md

@@ -0,0 +1,16 @@
+---
+title: FlowOutcomeNotificationNotificationErrorDetail
+---
+## PureCloud::FlowOutcomeNotificationNotificationErrorDetail
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **error_code** | **String** |  | [optional] |
+| **entity_id** | **String** |  | [optional] |
+| **entity_name** | **String** |  | [optional] |
+| **field_name** | **String** |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/FlowOutcomeNotificationNotificationErrorMessageParams.md

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

data/docs/{SurveyFormUriReference.md → FlowOutcomeNotificationNotificationHomeOrganization.md}

@@ -1,7 +1,7 @@
 ---
-title: SurveyFormUriReference
+title: FlowOutcomeNotificationNotificationHomeOrganization
 ---
-## PureCloud::SurveyFormUriReference
+## PureCloud::FlowOutcomeNotificationNotificationHomeOrganization
 
 ## Properties
 
@@ -9,8 +9,7 @@ title: SurveyFormUriReference
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** |  | [optional] |
 | **name** | **String** |  | [optional] |
-| **self_uri** | **String** |  | [optional] |
-| **context_id** | **String** | The context id of this form. | [optional] |
+| **third_party_org_name** | **String** |  | [optional] |
 {: class="table table-striped"}
 
 

data/docs/FlowOutcomeNotificationNotificationUser.md

@@ -0,0 +1,15 @@
+---
+title: FlowOutcomeNotificationNotificationUser
+---
+## PureCloud::FlowOutcomeNotificationNotificationUser
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **home_org** | [**DependencyTrackingBuildNotificationNotificationUserHomeOrg**](DependencyTrackingBuildNotificationNotificationUserHomeOrg.html) |  | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ForecastGenerationResult.md

@@ -0,0 +1,13 @@
+---
+title: ForecastGenerationResult
+---
+## PureCloud::ForecastGenerationResult
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **route_group_results** | [**Array<ForecastGenerationRouteGroupResult>**](ForecastGenerationRouteGroupResult.html) | Generation results, broken down by route group | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ForecastGenerationRouteGroupResult.md

@@ -0,0 +1,14 @@
+---
+title: ForecastGenerationRouteGroupResult
+---
+## PureCloud::ForecastGenerationRouteGroupResult
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **route_group** | [**RouteGroupAttributes**](RouteGroupAttributes.html) | The route group this result represents | [optional] |
+| **metric_results** | [**Array<ForecastTimeSeriesResult>**](ForecastTimeSeriesResult.html) | The generation results for the associated route group | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ForecastResultResponse.md

@@ -0,0 +1,14 @@
+---
+title: ForecastResultResponse
+---
+## PureCloud::ForecastResultResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **result** | [**RouteGroupList**](RouteGroupList.html) | The forecast result.  If null, fetch the result from the url in downloadUrl | [optional] |
+| **download_url** | **String** | The downloadUrl to fetch the result if it is too large to be sent directly | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ForecastSourceDayPointer.md

@@ -0,0 +1,17 @@
+---
+title: ForecastSourceDayPointer
+---
+## PureCloud::ForecastSourceDayPointer
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **day_of_week** | **String** | The forecast day of week for this source data | [optional] |
+| **weight** | **Integer** | The relative weight to apply to this source data item for weighted averages | [optional] |
+| **date** | **String** | The date this source data represents, in yyyy-MM-dd format | [optional] |
+| **file_name** | **String** | The name of the source file this data came from if it originated from a data import | [optional] |
+| **data_key** | **String** | The key to look up the forecast source data for this source day | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ForecastTimeSeriesResult.md

@@ -0,0 +1,14 @@
+---
+title: ForecastTimeSeriesResult
+---
+## PureCloud::ForecastTimeSeriesResult
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **metric** | **String** | The metric this result applies to | [optional] |
+| **forecasting_method** | **String** | The forecasting method that was used for this metric | [optional] |
+{: class="table table-striped"}
+
+

data/docs/GenerateShortTermForecastRequest.md

@@ -0,0 +1,13 @@
+---
+title: GenerateShortTermForecastRequest
+---
+## PureCloud::GenerateShortTermForecastRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **description** | **String** | Description for the generated forecast.  Pass an empty string for no description | |
+{: class="table table-striped"}
+
+

data/docs/GenerateShortTermForecastResponse.md

@@ -0,0 +1,16 @@
+---
+title: GenerateShortTermForecastResponse
+---
+## PureCloud::GenerateShortTermForecastResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **status** | **String** | The status of the request | [optional] |
+| **result** | [**ShortTermForecast**](ShortTermForecast.html) | The resulting forecast.  May be sent asynchronously via notification depending on the complexity of the forecast | [optional] |
+| **operation_id** | **String** | The operation id to watch for on the notification topic | [optional] |
+| **progress** | **Integer** | Percent progress.  Subscribe to the corresponding notification to view progress and await the result | [optional] |
+{: class="table table-striped"}
+
+

data/docs/GenerateWeekScheduleRequest.md

@@ -0,0 +1,14 @@
+---
+title: GenerateWeekScheduleRequest
+---
+## PureCloud::GenerateWeekScheduleRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **description** | **String** | Description for the generated week schedule | |
+| **short_term_forecast_id** | **String** | ID of short term forecast used for schedule generation | |
+{: class="table table-striped"}
+
+

data/docs/GenerateWeekScheduleResponse.md

@@ -0,0 +1,15 @@
+---
+title: GenerateWeekScheduleResponse
+---
+## PureCloud::GenerateWeekScheduleResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **status** | **String** | The status of the request | [optional] |
+| **operation_id** | **String** | The operation id to watch for on the notification topic if status == Processing | [optional] |
+| **download_url** | **String** | The url to fetch the result for large responses. The value will be null if result contains the data | [optional] |
+{: class="table table-striped"}
+
+

data/docs/GroupsApi.md

@@ -39,6 +39,7 @@ Wraps DELETE /api/v2/groups/{groupId}
 Requires ANY permissions: 
 
 * group_administration
+* admin
 
 
 ### Example
@@ -911,6 +912,7 @@ Wraps PUT /api/v2/groups/{groupId}
 Requires ANY permissions: 
 
 * group_administration
+* admin
 
 
 ### Example

data/docs/HeadcountForecastResponse.md

@@ -0,0 +1,14 @@
+---
+title: HeadcountForecastResponse
+---
+## PureCloud::HeadcountForecastResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **required** | [**Array<HeadcountIntervalResponse>**](HeadcountIntervalResponse.html) | Headcount information with shrinkage | [optional] |
+| **required_without_shrinkage** | [**Array<HeadcountIntervalResponse>**](HeadcountIntervalResponse.html) | Headcount information without shrinkage | [optional] |
+{: class="table table-striped"}
+
+

data/docs/HeadcountIntervalResponse.md

@@ -0,0 +1,14 @@
+---
+title: HeadcountIntervalResponse
+---
+## PureCloud::HeadcountIntervalResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **interval** | **DateTime** | The start date-time for this headcount interval in ISO-8601 format. | [optional] |
+| **value** | **Float** | Headcount value for this interval | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ImportShortTermForecastRequest.md

@@ -0,0 +1,16 @@
+---
+title: ImportShortTermForecastRequest
+---
+## PureCloud::ImportShortTermForecastRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **file_name** | **String** | The file name, if applicable, this data was extracted from (display purposes only) | [optional] |
+| **description** | **String** | Description for the imported forecast.  Pass an empty string for no description | |
+| **route_group_list** | [**RouteGroupList**](RouteGroupList.html) | The raw data to import | |
+| **partial_upload_ids** | **Array<String>** | IDs of partial uploads to include in this imported forecast.  Only relevant for large forecasts | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ImportWeekScheduleRequest.md

@@ -0,0 +1,17 @@
+---
+title: ImportWeekScheduleRequest
+---
+## PureCloud::ImportWeekScheduleRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **description** | **String** | Description for the schedule | |
+| **user_schedules** | [**Hash<String, UserSchedule>**](UserSchedule.html) | User schedules | [optional] |
+| **published** | **BOOLEAN** | Whether the schedule is published | [optional] |
+| **short_term_forecast_id** | **String** | Short term forecast that should be associated with this schedule | [optional] |
+| **partial_upload_ids** | **Array<String>** | IDs of partial uploads of user schedules to import week schedule. It is applicable only for large schedules where activity count in schedule is greater than 17500 | [optional] |
+{: class="table table-striped"}
+
+

data/docs/IntradayDataUpdateNotificationDateTime.md

@@ -8,9 +8,9 @@ title: IntradayDataUpdateNotificationDateTime
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
 | **i_millis** | **Integer** |  | [optional] |
-| **before_now** | **BOOLEAN** |  | [optional] |
 | **after_now** | **BOOLEAN** |  | [optional] |
 | **equal_now** | **BOOLEAN** |  | [optional] |
+| **before_now** | **BOOLEAN** |  | [optional] |
 {: class="table table-striped"}