-
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 5, 2024
1 parent
b229c6a
commit 6a8cd9a
Showing
127 changed files
with
20,757 additions
and
8,585 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
title: AdminAgentWorkPlanBiddingPreference | ||
--- | ||
## AdminAgentWorkPlanBiddingPreference | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **agent** | [**UserReference**](UserReference.html) | The agent to whom this work plan bidding preference applies | | | ||
| **submitted** | **Bool** | Whether the preference is submitted | | | ||
| **assignedWorkPlan** | [**WorkPlanReference**](WorkPlanReference.html) | The work plan assigned to the agent by the bid process | [optional] | | ||
| **overriddenWorkPlan** | [**WorkPlanReference**](WorkPlanReference.html) | The work plan that overrides the assigned work plan for the agent | [optional] | | ||
| **overrideReason** | **String** | The reason why the assigned work plan has been overridden. This must be null without an override work plan | [optional] | | ||
| **priorities** | **[Int]** | The agent priorities for the list of work plans. The index of the priorities should match with the list of work plans that belong to bid group. It contains null if priority is not set for the work plan | [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,16 @@ | ||
--- | ||
title: AdminAgentWorkPlanPreferenceResponse | ||
--- | ||
## AdminAgentWorkPlanPreferenceResponse | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **_id** | **String** | The globally unique identifier for the object. | [optional] | | ||
| **workPlans** | [**[WorkPlanReference]**](WorkPlanReference.html) | The list of work plans that belong to this bid group | | | ||
| **agentWorkPlanBidPreferences** | [**[AdminAgentWorkPlanBiddingPreference]**](AdminAgentWorkPlanBiddingPreference.html) | The list of agents work plan bidding preferences | | | ||
| **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: AdminBulkUpdateAlternativeShiftTradeState | ||
--- | ||
## AdminBulkUpdateAlternativeShiftTradeState | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **tradeId** | **String** | The ID of the trade for this alternative shift trade | | | ||
| **state** | **String** | The new alternative shift trade state | | | ||
| **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version metadata for this alternative shift trade | | | ||
{: class="table table-striped"} | ||
|
||
|
14 changes: 14 additions & 0 deletions
14
build/docs/AdminBulkUpdateAlternativeShiftTradeStateRequest.md
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: AdminBulkUpdateAlternativeShiftTradeStateRequest | ||
--- | ||
## AdminBulkUpdateAlternativeShiftTradeStateRequest | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **entities** | [**[AdminBulkUpdateAlternativeShiftTradeState]**](AdminBulkUpdateAlternativeShiftTradeState.html) | | [optional] | | ||
| **managementUnitId** | **String** | The ID of the management unit for this alternative shift bulk trade update | | | ||
{: 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: AgentBidWorkPlanOverrideRequest | ||
--- | ||
## AgentBidWorkPlanOverrideRequest | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **agentId** | **String** | The ID of agent | | | ||
| **overrideWorkPlanId** | **String** | The ID of the work plan that overrides the assigned work plan for the agent | [optional] | | ||
| **overrideReason** | **String** | The reason for overriding the assigned work plan. This must be null if overrideWorkPlanId is not specified | [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: AgentCountRange | ||
--- | ||
## AgentCountRange | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **minimum** | **Int** | The minimum value of agent count per work plan | | | ||
| **maximum** | **Int** | The maximum value of agent count per work 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,14 @@ | ||
--- | ||
title: AgentUpdateAlternativeShiftTradeRequest | ||
--- | ||
## AgentUpdateAlternativeShiftTradeRequest | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **state** | **String** | The new state of this alternative shift trade | [optional] | | ||
| **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version metadata for this alternative shift trade | | | ||
{: 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,22 @@ | ||
--- | ||
title: AgentWorkPlan | ||
--- | ||
## AgentWorkPlan | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **_id** | **String** | The globally unique identifier for the object. | [optional] | | ||
| **name** | **String** | | [optional] | | ||
| **constrainWeeklyPaidTime** | **Bool** | Whether the weekly paid time constraint is enabled for this work plan | | | ||
| **flexibleWeeklyPaidTime** | **Bool** | Whether the weekly paid time constraint is flexible for this work plan | | | ||
| **weeklyExactPaidMinutes** | **Int** | Exact weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == false | | | ||
| **weeklyMinimumPaidMinutes** | **Int** | Minimum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true | | | ||
| **weeklyMaximumPaidMinutes** | **Int** | Maximum weekly paid time in minutes for this work plan. Used if flexibleWeeklyPaidTime == true | | | ||
| **optionalDays** | [**SetWrapperDayOfWeek**](SetWrapperDayOfWeek.html) | Optional days to schedule for this work plan | [optional] | | ||
| **shifts** | [**[AgentWorkPlanShift]**](AgentWorkPlanShift.html) | Shifts in this work 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,14 @@ | ||
--- | ||
title: AgentWorkPlanActivity | ||
--- | ||
## AgentWorkPlanActivity | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **lengthMinutes** | **Int** | Length of the activity in minutes | | | ||
| **countsAsPaidTime** | **Bool** | Whether the activity is paid | | | ||
{: 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,21 @@ | ||
--- | ||
title: AgentWorkPlanBid | ||
--- | ||
## AgentWorkPlanBid | ||
Work plan bid reference | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **_id** | **String** | The ID of the work plan bid | | | ||
| **name** | **String** | | [optional] | | ||
| **bidWindowStartDate** | [**Date**](Date.html) | The date when agents can start participating in work plan bidding. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | | | ||
| **bidWindowEndDate** | [**Date**](Date.html) | The inclusive end date of a bid window. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | | | ||
| **effectiveDate** | [**Date**](Date.html) | The date when agents will be assigned to the new work plan. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd | | | ||
| **status** | **String** | The state of the bid | | | ||
| **workPlanFieldsVisibleToAgents** | **[String]** | The work plan fields visible to agents whenever work plan preferences are made | | | ||
| **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: AgentWorkPlanBiddingPreference | ||
--- | ||
## AgentWorkPlanBiddingPreference | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **workPlan** | [**WorkPlanReference**](WorkPlanReference.html) | The work plan that belongs to the agent's bid group | | | ||
| **priority** | **Int** | The agent's priority for this work plan, with 1 being the best priority. Null if priority is not set for the work plan | [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: AgentWorkPlanBiddingPreferenceRequest | ||
--- | ||
## AgentWorkPlanBiddingPreferenceRequest | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **workPlanId** | **String** | The ID of the work plan that belongs to agent's bid group | | | ||
| **priority** | **Int** | The agent's priority for this work plan, with 1 being the best priority. Null if priority is not set for the work plan | [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,19 @@ | ||
--- | ||
title: AgentWorkPlanBiddingPreferenceResponse | ||
--- | ||
## AgentWorkPlanBiddingPreferenceResponse | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **_id** | **String** | The globally unique identifier for the object. | [optional] | | ||
| **submitted** | **Bool** | Whether the preference is submitted | | | ||
| **assignedWorkPlan** | [**WorkPlanReference**](WorkPlanReference.html) | The work plan assigned to the agent by the bid process | [optional] | | ||
| **overriddenWorkPlan** | [**WorkPlanReference**](WorkPlanReference.html) | The work plan that overrides the assigned work plan for the agent | [optional] | | ||
| **overrideReason** | **String** | The reason why the assigned work plan has been overridden. This must be null without an override work plan | [optional] | | ||
| **agentWorkPlanBidPreferences** | [**[AgentWorkPlanBiddingPreference]**](AgentWorkPlanBiddingPreference.html) | The list of work plan bidding preferences | | | ||
| **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,16 @@ | ||
--- | ||
title: AgentWorkPlanBids | ||
--- | ||
## AgentWorkPlanBids | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **_id** | **String** | The globally unique identifier for the object. | [optional] | | ||
| **businessUnit** | [**BusinessUnitReference**](BusinessUnitReference.html) | The business unit to which the bids belong | [optional] | | ||
| **agentWorkPlanBids** | [**[AgentWorkPlanBid]**](AgentWorkPlanBid.html) | Work plan bid summaries associated with this agent | | | ||
| **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: AgentWorkPlanListResponse | ||
--- | ||
## AgentWorkPlanListResponse | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **entities** | [**[AgentWorkPlan]**](AgentWorkPlan.html) | | [optional] | | ||
| **managementUnit** | [**ManagementUnitReference**](ManagementUnitReference.html) | The management unit of the work plans | | | ||
{: 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,25 @@ | ||
--- | ||
title: AgentWorkPlanShift | ||
--- | ||
## AgentWorkPlanShift | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **days** | [**SetWrapperDayOfWeek**](SetWrapperDayOfWeek.html) | Days of the week applicable for this shift | | | ||
| **flexibleStartTime** | **Bool** | Whether the start time of the shift is flexible | | | ||
| **exactStartTimeMinutesFromMidnight** | **Int** | Exact start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == false | | | ||
| **earliestStartTimeMinutesFromMidnight** | **Int** | Earliest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true | | | ||
| **latestStartTimeMinutesFromMidnight** | **Int** | Latest start time of the shift defined as offset minutes from midnight. Used if flexibleStartTime == true | | | ||
| **earliestStopTimeMinutesFromMidnight** | **Int** | This is the earliest time a shift can end | | | ||
| **constrainLatestStopTime** | **Bool** | Whether the latest stop time constraint for the shift is enabled | | | ||
| **latestStopTimeMinutesFromMidnight** | **Int** | Latest stop time of the shift defined as offset minutes from midnight. Used if constrainStopTime == true | | | ||
| **flexiblePaidTime** | **Bool** | Whether the paid time setting for the shift is flexible | | | ||
| **exactPaidTimeMinutes** | **Int** | Exact paid time in minutes configured for the shift. Used if flexiblePaidTime == false | | | ||
| **minimumPaidTimeMinutes** | **Int** | Minimum paid time in minutes configured for the shift. Used if flexiblePaidTime == true | | | ||
| **maximumPaidTimeMinutes** | **Int** | Maximum paid time in minutes configured for the shift. Used if flexiblePaidTime == true | | | ||
| **activities** | [**[AgentWorkPlanActivity]**](AgentWorkPlanActivity.html) | Activities configured for this shift | | | ||
{: 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: AgentsBidAssignedWorkPlanOverrideRequest | ||
--- | ||
## AgentsBidAssignedWorkPlanOverrideRequest | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **agentWorkPlanOverrides** | [**[AgentBidWorkPlanOverrideRequest]**](AgentBidWorkPlanOverrideRequest.html) | The list of agent work plan overrides | | | ||
{: 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,17 @@ | ||
--- | ||
title: AlternativeShiftAgentScheduledShift | ||
--- | ||
## AlternativeShiftAgentScheduledShift | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **dayIndex** | **Int** | The number of days since start of schedule | | | ||
| **referenceKey** | **String** | A key generated for an offer to help facilitate alternative shift trading | | | ||
| **startDate** | [**Date**](Date.html) | The start date of this shift in ISO-8601 format | | | ||
| **lengthMinutes** | **Int** | The length of this shift in minutes | | | ||
| **activities** | [**[BuAgentScheduleActivity]**](BuAgentScheduleActivity.html) | A list of activities in this shift | | | ||
{: 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: AlternativeShiftAsyncResponse | ||
--- | ||
## AlternativeShiftAsyncResponse | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **job** | [**AlternativeShiftJobReference**](AlternativeShiftJobReference.html) | The job related to the async request | | | ||
{: 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,16 @@ | ||
--- | ||
title: AlternativeShiftBuSettingsResponse | ||
--- | ||
## AlternativeShiftBuSettingsResponse | ||
|
||
## Properties | ||
|
||
|Name | Type | Description | Notes| | ||
|------------ | ------------- | ------------- | -------------| | ||
| **enabledGranularities** | **[String]** | The granularity at which alternative shifts is allowed. An empty list means Alternative Shifts is disabled | | | ||
| **minMinutesBeforeStartTime** | **Int** | The minimum number of minutes before the start of a shift that an alternative shift can be automatically approved | | | ||
| **retainedActivityCategories** | **[String]** | Categories of activities that are required to remain at the same time slot for the alternative shifts offered. An empty list represents no retained activities | | | ||
| **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version metadata for this business unit's alternative shift settings | | | ||
{: class="table table-striped"} | ||
|
||
|
Oops, something went wrong.