-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
PureCloud Jenkins
committed
Aug 14, 2024
1 parent
6a8cd9a
commit 62df5e2
Showing
355 changed files
with
9,968 additions
and
4,721 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
title: ActivityCodeReference | ||
--- | ||
## ActivityCodeReference | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **_id** | **String** | The globally unique identifier for the object. | | | ||
| **selfUri** | **String** | The URI for this object | [optional] | | ||
{: class="table table-striped"} | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
title: ActivityPlanAbandonRateImpactOverride | ||
--- | ||
## ActivityPlanAbandonRateImpactOverride | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **increaseByPercent** | **Double** | Allowed abandon rate increase percent, from 0.0 to 100.0 | | | ||
{: class="table table-striped"} | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
title: ActivityPlanAsaImpactOverride | ||
--- | ||
## ActivityPlanAsaImpactOverride | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **increaseByPercent** | **Double** | Allowed average speed of answer increase percent, from 0.0 to 100.0 | | | ||
{: class="table table-striped"} | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
title: ActivityPlanJobException | ||
--- | ||
## ActivityPlanJobException | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **exceptionType** | **String** | The type of error | | | ||
| **occurrences** | [**[ActivityPlanOccurrenceReference]**](ActivityPlanOccurrenceReference.html) | The occurrences in which this error occurred | | | ||
{: class="table table-striped"} | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
title: ActivityPlanJobListing | ||
--- | ||
## ActivityPlanJobListing | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **entities** | [**[ActivityPlanJobResponse]**](ActivityPlanJobResponse.html) | | [optional] | | ||
{: class="table table-striped"} | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
title: ActivityPlanJobResponse | ||
--- | ||
## ActivityPlanJobResponse | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **_id** | **String** | The globally unique identifier for the object. | [optional] | | ||
| **activityPlan** | [**ActivityPlanReference**](ActivityPlanReference.html) | The activity plan associated with this job | | | ||
| **status** | **String** | The status of the job | | | ||
| **exceptions** | [**[ActivityPlanJobException]**](ActivityPlanJobException.html) | The list of exceptions that occurred while running this activity plan job. These are exceptions that affect individual occurrences but didn't prevent the job from completing | | | ||
| **error** | [**ErrorBody**](ErrorBody.html) | Error details if status == 'Error'. These are errors that caused the job to fail to complete | [optional] | | ||
| **occurrence** | [**ActivityPlanOccurrenceReference**](ActivityPlanOccurrenceReference.html) | The occurrence associated with this job if type == 'DeleteOccurrence' | [optional] | | ||
| **type** | **String** | The type of the job | | | ||
| **selfUri** | **String** | The URI for this object | [optional] | | ||
{: class="table table-striped"} | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
--- | ||
title: ActivityPlanListItem | ||
--- | ||
## ActivityPlanListItem | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **_id** | **String** | The globally unique identifier for the object. | [optional] | | ||
| **name** | **String** | The name of the activity plan | | | ||
| **managementUnits** | [**[ManagementUnitReference]**](ManagementUnitReference.html) | The management units to which this activity plan applies. Empty list or null means this activity plan applies to all management units in the business unit | [optional] | | ||
| **_description** | **String** | The description of this activity plan | | | ||
| **activityCode** | [**ActivityCodeReference**](ActivityCodeReference.html) | The activity code to which this activity plan applies. Note: It is recommended to load and cache the entire list of activity codes rather than look up individual codes | | | ||
| **type** | **String** | The type of the activity plan | | | ||
| **optimizationObjective** | **String** | The optimization objective of this activity plan | | | ||
| **recurrenceSettings** | [**RecurrenceSettings**](RecurrenceSettings.html) | Recurrence settings for this activity plan | [optional] | | ||
| **state** | **String** | The state of this activity plan | | | ||
| **lastRunDate** | [**Date**](Date.html) | The date the activity plan was last run, in ISO-8601 format | [optional] | | ||
| **lastRunBy** | [**UserReference**](UserReference.html) | The last user to run this activity plan | [optional] | | ||
| **createdDate** | [**Date**](Date.html) | The date the activity plan was created, in ISO-8601 format | | | ||
| **createdBy** | [**UserReference**](UserReference.html) | The user who created this activity plan | | | ||
| **modifiedDate** | [**Date**](Date.html) | The date the activity plan was modified, in ISO-8601 format | | | ||
| **modifiedBy** | [**UserReference**](UserReference.html) | The last user to modify this activity plan | | | ||
| **selfUri** | **String** | The URI for this object | [optional] | | ||
{: class="table table-striped"} | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
title: ActivityPlanListing | ||
--- | ||
## ActivityPlanListing | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **entities** | [**[ActivityPlanListItem]**](ActivityPlanListItem.html) | | [optional] | | ||
{: class="table table-striped"} | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
title: ActivityPlanOccurrenceReference | ||
--- | ||
## ActivityPlanOccurrenceReference | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **_id** | **String** | The globally unique identifier for the object. | [optional] | | ||
| **selfUri** | **String** | The URI for this object | [optional] | | ||
{: class="table table-striped"} | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
title: ActivityPlanReference | ||
--- | ||
## ActivityPlanReference | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **_id** | **String** | The globally unique identifier for the object. | [optional] | | ||
| **selfUri** | **String** | The URI for this object | [optional] | | ||
{: class="table table-striped"} | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
title: ActivityPlanResponse | ||
--- | ||
## ActivityPlanResponse | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **_id** | **String** | The globally unique identifier for the object. | [optional] | | ||
| **name** | **String** | The name of the activity plan | | | ||
| **managementUnits** | [**[ManagementUnitReference]**](ManagementUnitReference.html) | The management units to which this activity plan applies. Empty list or null means this activity plan applies to the entire business unit | [optional] | | ||
| **_description** | **String** | The description of this activity plan | | | ||
| **activityCode** | [**ActivityCodeReference**](ActivityCodeReference.html) | The activity code associated with this activity plan. It is recommended to load and cache the entire list of activity codes rather than look up individual codes | | | ||
| **type** | **String** | The type of the activity plan | | | ||
| **initialSchedulePeriod** | [**SchedulingPeriod**](SchedulingPeriod.html) | The initial schedule period of the activity plan | | | ||
| **lengthMinutes** | **Int** | The length of the activity in minutes | | | ||
| **groupSettings** | [**GroupSettings**](GroupSettings.html) | Group settings for this activity plan | [optional] | | ||
| **recurrenceSettings** | [**RecurrenceSettings**](RecurrenceSettings.html) | Recurrence settings for this activity plan | [optional] | | ||
| **attendeesSearchRule** | [**UserSearchRule**](UserSearchRule.html) | Attendee search rule for this activity plan | [optional] | | ||
| **facilitated** | **Bool** | Whether the sessions created by this activity plan should be facilitated | | | ||
| **facilitatorsSearchRule** | [**UserSearchRule**](UserSearchRule.html) | Facilitator search rule for this activity plan | [optional] | | ||
| **transitionTimeMinutes** | **Int** | Transition time in minutes between facilitated sessions | | | ||
| **serviceGoalImpactOverrides** | [**ActivityPlanServiceGoalImpactOverrides**](ActivityPlanServiceGoalImpactOverrides.html) | Allowable service goal impact override settings for this activity plan | [optional] | | ||
| **optimizationObjective** | **String** | The optimization objective of this activity plan | | | ||
| **fixedAvailability** | [**[FixedAvailability]**](FixedAvailability.html) | Fixed availability configuration for this activity plan | [optional] | | ||
| **state** | **String** | The state of this activity plan | | | ||
| **countsAsPaidTime** | **Bool** | Whether the activity should count as paid time | | | ||
| **createdDate** | [**Date**](Date.html) | The date the activity plan was created, in ISO-8601 format | | | ||
| **createdBy** | [**UserReference**](UserReference.html) | The user who created this activity plan | | | ||
| **modifiedDate** | [**Date**](Date.html) | The date the activity plan was modified, in ISO-8601 format | | | ||
| **modifiedBy** | [**UserReference**](UserReference.html) | The last user to modify this activity plan | | | ||
| **lastRunDate** | [**Date**](Date.html) | The date the activity plan was last run, in ISO-8601 format | [optional] | | ||
| **lastRunBy** | [**UserReference**](UserReference.html) | The last user to run this activity plan | [optional] | | ||
| **selfUri** | **String** | The URI for this object | [optional] | | ||
{: class="table table-striped"} | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
title: ActivityPlanRunJobResponse | ||
--- | ||
## ActivityPlanRunJobResponse | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **_id** | **String** | The globally unique identifier for the object. | [optional] | | ||
| **activityPlan** | [**ActivityPlanReference**](ActivityPlanReference.html) | The activity plan associated with this job | | | ||
| **status** | **String** | The status of the job | | | ||
| **exceptions** | [**[ActivityPlanJobException]**](ActivityPlanJobException.html) | The list of exceptions that occurred while running this activity plan job. These are exceptions that affect individual occurrences but didn't prevent the job from completing | | | ||
| **error** | [**ErrorBody**](ErrorBody.html) | Error details if status == 'Error'. These are errors that caused the job to fail to complete | [optional] | | ||
| **selfUri** | **String** | The URI for this object | [optional] | | ||
{: class="table table-striped"} | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
title: ActivityPlanServiceGoalImpactOverrides | ||
--- | ||
## ActivityPlanServiceGoalImpactOverrides | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **abandonRate** | [**ActivityPlanAbandonRateImpactOverride**](ActivityPlanAbandonRateImpactOverride.html) | Abandon rate service goal override for the associated activity plan | | | ||
| **serviceLevel** | [**ActivityPlanServiceLevelImpactOverride**](ActivityPlanServiceLevelImpactOverride.html) | Service level goal override for the associated activity plan | | | ||
| **averageSpeedOfAnswer** | [**ActivityPlanAsaImpactOverride**](ActivityPlanAsaImpactOverride.html) | Average speed of answer service goal override for the associated activity plan | | | ||
{: class="table table-striped"} | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
title: ActivityPlanServiceLevelImpactOverride | ||
--- | ||
## ActivityPlanServiceLevelImpactOverride | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **decreaseByPercent** | **Double** | Allowed service level decrease percent, from 0.0 to 100.0 | | | ||
{: class="table table-striped"} | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.