purecloudplatformclientv2 36.1.0 → 37.0.0

data/docs/RoutingSkillReference.md

@@ -0,0 +1,14 @@
+---
+title: RoutingSkillReference
+---
+## PureCloud::RoutingSkillReference
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ScheduleGenerationWarning.md

@@ -0,0 +1,20 @@
+---
+title: ScheduleGenerationWarning
+---
+## PureCloud::ScheduleGenerationWarning
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **user_id** | **String** | ID of the user in the warning | [optional] |
+| **user_not_licensed** | **BOOLEAN** | Whether the user does not have the appropriate license to be scheduled | [optional] |
+| **unable_to_meet_max_days** | **BOOLEAN** | Whether the number of scheduled days exceeded the maximum days to schedule defined in the agent work plan | [optional] |
+| **unable_to_schedule_required_days** | **Array<String>** | Days indicated as required to work in agent work plan where no viable shift was found to schedule | [optional] |
+| **unable_to_meet_min_paid_for_the_week** | **BOOLEAN** | Whether the schedule did not meet the minimum paid time for the week defined in the agent work plan | [optional] |
+| **unable_to_meet_max_paid_for_the_week** | **BOOLEAN** | Whether the schedule exceeded the maximum paid time for the week defined in the agent work plan | [optional] |
+| **no_need_days** | **Array<String>** | Days agent was scheduled but there was no need to meet. The scheduled days have no effect on service levels | [optional] |
+| **shifts_too_close_together** | **BOOLEAN** | Whether the schedule did not meet the minimum time between shifts defined in the agent work plan | [optional] |
+{: class="table table-striped"}
+
+

data/docs/SchedulingRunListResponse.md

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

data/docs/SchedulingRunResponse.md

@@ -0,0 +1,22 @@
+---
+title: SchedulingRunResponse
+---
+## PureCloud::SchedulingRunResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **run_id** | **String** | ID of the schedule run | [optional] |
+| **state** | **String** | Status of the schedule run | [optional] |
+| **percent_complete** | **Float** | Completion percentage of the schedule run | [optional] |
+| **target_week** | **String** | The start date of the week for which the scheduling is done in yyyy-MM-dd format | [optional] |
+| **schedule_id** | **String** | ID of the schedule | [optional] |
+| **schedule_description** | **String** | Description of the schedule run | [optional] |
+| **scheduling_start_time** | **DateTime** | Start time of the schedule run. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+| **scheduling_started_by** | [**UserReference**](UserReference.html) | User that started the schedule run | [optional] |
+| **scheduling_canceled_by** | [**UserReference**](UserReference.html) | User that canceled the schedule run | [optional] |
+| **scheduling_completed_time** | **DateTime** | Time at which the scheduling run was completed. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ServiceGoalGroup.md

@@ -0,0 +1,18 @@
+---
+title: ServiceGoalGroup
+---
+## PureCloud::ServiceGoalGroup
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The globally unique identifier for the object. | [optional] |
+| **name** | **String** |  | [optional] |
+| **goals** | [**ServiceGoalGroupGoals**](ServiceGoalGroupGoals.html) | Goals defined for this service goal group | [optional] |
+| **queue_media_associations** | [**Array<QueueMediaAssociation>**](QueueMediaAssociation.html) | List of queues and media types from that queue to associate with this service goal group | [optional] |
+| **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version metadata for the list of service goal groups for the associated management unit | |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ServiceGoalGroupGoals.md

@@ -0,0 +1,14 @@
+---
+title: ServiceGoalGroupGoals
+---
+## PureCloud::ServiceGoalGroupGoals
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **service_level** | [**WfmServiceLevel**](WfmServiceLevel.html) | Service level targets for this service goal group | |
+| **average_speed_of_answer** | [**WfmAverageSpeedOfAnswer**](WfmAverageSpeedOfAnswer.html) | Average speed of answer targets for this service goal group | |
+{: class="table table-striped"}
+
+

data/docs/ServiceGoalGroupList.md

@@ -0,0 +1,14 @@
+---
+title: ServiceGoalGroupList
+---
+## PureCloud::ServiceGoalGroupList
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **entities** | [**Array<ServiceGoalGroup>**](ServiceGoalGroup.html) |  | [optional] |
+| **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version metadata for the list of service goal groups for the associated management unit | [optional] |
+{: class="table table-striped"}
+
+

data/docs/SetWrapperDayOfWeek.md

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

data/docs/ShiftStartVariance.md

@@ -0,0 +1,14 @@
+---
+title: ShiftStartVariance
+---
+## PureCloud::ShiftStartVariance
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **applicable_days** | **Array<String>** | Days for which shift start variance is configured | |
+| **max_shift_start_variance_minutes** | **Integer** | Maximum variance in minutes across shift starts | |
+{: class="table table-striped"}
+
+

data/docs/ShortTermForecast.md

@@ -0,0 +1,22 @@
+---
+title: ShortTermForecast
+---
+## PureCloud::ShortTermForecast
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The id of the short term forecast | |
+| **week_date** | **String** | The weekDate of the short term forecast in yyyy-MM-dd format | |
+| **description** | **String** | The description of the short term forecast | [optional] |
+| **creation_method** | **String** | The method used to create this forecast | [optional] |
+| **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Metadata for this forecast | |
+| **source_data** | [**ListWrapperForecastSourceDayPointer**](ListWrapperForecastSourceDayPointer.html) | The source data references and metadata for this forecast | [optional] |
+| **reference_start_date** | **DateTime** | ISO-8601 date that serves as the reference date for interval-based modifications | [optional] |
+| **modifications** | [**ListWrapperWfmForecastModification**](ListWrapperWfmForecastModification.html) | The modifications that have been applied to this forecast | [optional] |
+| **generation_results** | [**ForecastGenerationResult**](ForecastGenerationResult.html) | Forecast generation results, if applicable | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ShortTermForecastListItemResponse.md

@@ -0,0 +1,18 @@
+---
+title: ShortTermForecastListItemResponse
+---
+## PureCloud::ShortTermForecastListItemResponse
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The id of the short term forecast | |
+| **week_date** | **String** | The weekDate of the short term forecast in yyyy-MM-dd format | |
+| **description** | **String** | The description of the short term forecast | [optional] |
+| **creation_method** | **String** | The method used to create this forecast | [optional] |
+| **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Metadata for this forecast | |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ShortTermForecastListResponse.md

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

data/docs/ShortTermForecastReference.md

@@ -0,0 +1,16 @@
+---
+title: ShortTermForecastReference
+---
+## PureCloud::ShortTermForecastReference
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The id of the short term forecast | |
+| **week_date** | **String** | The weekDate of the short term forecast in yyyy-MM-dd format | |
+| **description** | **String** | The description of the short term forecast | [optional] |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/ShortTermForecastResponse.md

@@ -0,0 +1,15 @@
+---
+title: ShortTermForecastResponse
+---
+## PureCloud::ShortTermForecastResponse
+
+## 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] |
+{: class="table table-striped"}
+
+

data/docs/SurveyAssignment.md

@@ -7,9 +7,11 @@ title: SurveyAssignment
 
 |Name | Type | Description | Notes|
 |------------ | ------------- | ------------- | -------------|
-| **survey_form** | [**SurveyFormUriReference**](SurveyFormUriReference.html) | The survey form used for this survey. | [optional] |
+| **survey_form** | [**PublishedSurveyFormReference**](PublishedSurveyFormReference.html) | The survey form used for this survey. | [optional] |
 | **flow** | [**UriReference**](UriReference.html) | The URI reference to the flow associated with this survey. | [optional] |
 | **invite_time_interval** | **String** | An ISO 8601 repeated interval consisting of the number of repetitions, the start datetime, and the interval (e.g. R2/2018-03-01T13:00:00Z/P1M10DT2H30M). Total duration must not exceed 90 days. | [optional] |
+| **sending_user** | **String** | User together with sendingDomain used to send email, null to use no-reply | [optional] |
+| **sending_domain** | **String** | Validated email domain, required | |
 {: class="table table-striped"}
 
 

data/docs/SurveyForm.md

@@ -13,6 +13,7 @@ title: SurveyForm
 | **published** | **BOOLEAN** | Is this form published | [optional] |
 | **disabled** | **BOOLEAN** | Is this form disabled | [optional] |
 | **context_id** | **String** | Unique Id for all versions of this form | |
+| **language** | **String** | Language for survey viewer localization. Currently localized languages: da, de, en-US, es, fi, fr, it, ja, ko, nl, no, pl, pt-BR, sv, th, tr, zh-CH, zh-TW | |
 | **header_image_id** | **String** | Id of the header image appearing at the top of the form. | [optional] |
 | **header_image_url** | **String** | Temporary URL for accessing header image | [optional] |
 | **header** | **String** | Markdown text for the top of the form. | [optional] |

data/docs/TimeOffRequestEntityList.md

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

data/docs/TimeOffRequestLookup.md

@@ -0,0 +1,15 @@
+---
+title: TimeOffRequestLookup
+---
+## PureCloud::TimeOffRequestLookup
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **id** | **String** | The id of the time off request | |
+| **user** | [**User**](User.html) | The user that the time off request belongs to | |
+| **self_uri** | **String** | The URI for this object | [optional] |
+{: class="table table-striped"}
+
+

data/docs/TimeOffRequestLookupList.md

@@ -0,0 +1,13 @@
+---
+title: TimeOffRequestLookupList
+---
+## PureCloud::TimeOffRequestLookupList
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **entities** | [**Array<TimeOffRequestLookup>**](TimeOffRequestLookup.html) | List of time off request look up objects | |
+{: class="table table-striped"}
+
+

data/docs/TimeOffRequestQueryBody.md

@@ -0,0 +1,15 @@
+---
+title: TimeOffRequestQueryBody
+---
+## PureCloud::TimeOffRequestQueryBody
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **user_ids** | **Array<String>** | The set of user ids to filter time off requests | [optional] |
+| **statuses** | **Array<String>** | The set of statuses to filter time off requests | [optional] |
+| **date_range** | [**DateRange**](DateRange.html) | The inclusive range of dates to filter time off requests | [optional] |
+{: class="table table-striped"}
+
+

data/docs/TrustUser.md

@@ -9,6 +9,7 @@ title: TrustUser
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** | The globally unique identifier for the object. | [optional] |
 | **name** | **String** |  | [optional] |
+| **division** | [**Division**](Division.html) | The division to which this entity belongs. | [optional] |
 | **chat** | [**Chat**](Chat.html) |  | [optional] |
 | **department** | **String** |  | [optional] |
 | **email** | **String** |  | [optional] |

data/docs/TrusteeAuthorization.md

@@ -0,0 +1,13 @@
+---
+title: TrusteeAuthorization
+---
+## PureCloud::TrusteeAuthorization
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **permissions** | **Array<String>** | Permissions that the trustee user has in the trustor organization | [optional] |
+{: class="table table-striped"}
+
+

data/docs/Trustor.md

@@ -12,6 +12,7 @@ title: Trustor
 | **date_created** | **DateTime** | Date Trust was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
 | **created_by** | [**OrgUser**](OrgUser.html) | User that created trust. | [optional] |
 | **organization** | [**Organization**](Organization.html) | Organization associated with this trust. | [optional] |
+| **authorization** | [**TrusteeAuthorization**](TrusteeAuthorization.html) | Authorization for the trustee user has in this trustor organization | [optional] |
 | **self_uri** | **String** | The URI for this object | [optional] |
 {: class="table table-striped"}
 

data/docs/UpdateActivityCodeRequest.md

@@ -0,0 +1,19 @@
+---
+title: UpdateActivityCodeRequest
+---
+## PureCloud::UpdateActivityCodeRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **name** | **String** | The name of the activity code | [optional] |
+| **category** | **String** | The activity code's category. Attempting to change the category of a default activity code will return an error | [optional] |
+| **length_in_minutes** | **Integer** | The default length of the activity in minutes | [optional] |
+| **counts_as_paid_time** | **BOOLEAN** | Whether an agent is paid while performing this activity | [optional] |
+| **counts_as_work_time** | **BOOLEAN** | Indicates whether or not the activity should be counted as work time | [optional] |
+| **agent_time_off_selectable** | **BOOLEAN** | Whether an agent can select this activity code when creating or editing a time off request | [optional] |
+| **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version metadata for the associated management unit's list of activity codes | |
+{: class="table table-striped"}
+
+

data/docs/UpdateWeekScheduleRequest.md

@@ -0,0 +1,18 @@
+---
+title: UpdateWeekScheduleRequest
+---
+## PureCloud::UpdateWeekScheduleRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **description** | **String** | Description of the week schedule | [optional] |
+| **published** | **BOOLEAN** | Whether the week schedule is published | [optional] |
+| **user_schedules** | [**Hash<String, UserSchedule>**](UserSchedule.html) | User schedules in the week | [optional] |
+| **partial_upload_ids** | **Array<String>** | IDs of partial uploads to include in this imported schedule. It is applicable only for large schedules where activity count in schedule is greater than 17500 | [optional] |
+| **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version metadata for this work plan | |
+| **agent_schedules_version** | **Integer** | Version of agent schedules in the week schedule | |
+{: class="table table-striped"}
+
+

data/docs/User.md

@@ -9,6 +9,7 @@ title: User
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** | The globally unique identifier for the object. | [optional] |
 | **name** | **String** |  | [optional] |
+| **division** | [**Division**](Division.html) | The division to which this entity belongs. | [optional] |
 | **chat** | [**Chat**](Chat.html) |  | [optional] |
 | **department** | **String** |  | [optional] |
 | **email** | **String** |  | [optional] |

data/docs/UserMe.md

@@ -9,6 +9,7 @@ title: UserMe
 |------------ | ------------- | ------------- | -------------|
 | **id** | **String** | The globally unique identifier for the object. | [optional] |
 | **name** | **String** |  | [optional] |
+| **division** | [**Division**](Division.html) | The division to which this entity belongs. | [optional] |
 | **chat** | [**Chat**](Chat.html) |  | [optional] |
 | **department** | **String** |  | [optional] |
 | **email** | **String** |  | [optional] |

data/docs/UserScheduleAdherenceUpdateNotificationDateTime.md

@@ -8,9 +8,9 @@ title: UserScheduleAdherenceUpdateNotificationDateTime
 |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"}
 
 

data/docs/UserSchedulesPartialUploadRequest.md

@@ -0,0 +1,13 @@
+---
+title: UserSchedulesPartialUploadRequest
+---
+## PureCloud::UserSchedulesPartialUploadRequest
+
+## Properties
+
+|Name | Type | Description | Notes|
+|------------ | ------------- | ------------- | -------------|
+| **user_schedules** | [**Hash<String, UserSchedule>**](UserSchedule.html) | User schedules that are part of partial request | |
+{: class="table table-striped"}
+
+