purecloud-platform-client-v2 254.0.0 → 255.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist/node/purecloud-platform-client-v2.js +815 -95
- package/dist/web-amd/purecloud-platform-client-v2.js +816 -95
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +285 -94
- package/dist/web-cjs/purecloud-platform-client-v2.js +292 -2913
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +568 -50
- package/package.json +1 -2
- package/src/purecloud-platform-client-v2/ApiClient.js +5 -5
- package/src/purecloud-platform-client-v2/PureCloudRegionHosts.js +1 -0
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +64 -1
- package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BackgroundAssistantApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +710 -53
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5,7 +5,7 @@ class WorkforceManagementApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* WorkforceManagement service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 255.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -156,6 +156,81 @@ class WorkforceManagementApi {
|
|
|
156
156
|
);
|
|
157
157
|
}
|
|
158
158
|
|
|
159
|
+
/**
|
|
160
|
+
* Delete a schedule bid
|
|
161
|
+
*
|
|
162
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
163
|
+
* @param {String} bidId The ID of the schedule bid
|
|
164
|
+
* @param {Object} opts Optional parameters
|
|
165
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
166
|
+
*/
|
|
167
|
+
deleteWorkforcemanagementBusinessunitSchedulebid(businessUnitId, bidId, opts) {
|
|
168
|
+
opts = opts || {};
|
|
169
|
+
|
|
170
|
+
// verify the required parameter 'businessUnitId' is set
|
|
171
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
172
|
+
throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitSchedulebid';
|
|
173
|
+
}
|
|
174
|
+
// verify the required parameter 'bidId' is set
|
|
175
|
+
if (bidId === undefined || bidId === null || bidId === '') {
|
|
176
|
+
throw 'Missing the required parameter "bidId" when calling deleteWorkforcemanagementBusinessunitSchedulebid';
|
|
177
|
+
}
|
|
178
|
+
|
|
179
|
+
return this.apiClient.callApi(
|
|
180
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}',
|
|
181
|
+
'DELETE',
|
|
182
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId },
|
|
183
|
+
{ },
|
|
184
|
+
{ },
|
|
185
|
+
{ },
|
|
186
|
+
null,
|
|
187
|
+
['PureCloud OAuth'],
|
|
188
|
+
['application/json'],
|
|
189
|
+
['application/json'],
|
|
190
|
+
opts['customHeaders']
|
|
191
|
+
);
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
/**
|
|
195
|
+
* Delete a schedule bid group by bid group Id
|
|
196
|
+
*
|
|
197
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
198
|
+
* @param {String} bidId The ID of the schedule bid associated with the bid groups
|
|
199
|
+
* @param {String} bidGroupId Schedule Bid Group id
|
|
200
|
+
* @param {Object} opts Optional parameters
|
|
201
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
202
|
+
*/
|
|
203
|
+
deleteWorkforcemanagementBusinessunitSchedulebidGroup(businessUnitId, bidId, bidGroupId, opts) {
|
|
204
|
+
opts = opts || {};
|
|
205
|
+
|
|
206
|
+
// verify the required parameter 'businessUnitId' is set
|
|
207
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
208
|
+
throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitSchedulebidGroup';
|
|
209
|
+
}
|
|
210
|
+
// verify the required parameter 'bidId' is set
|
|
211
|
+
if (bidId === undefined || bidId === null || bidId === '') {
|
|
212
|
+
throw 'Missing the required parameter "bidId" when calling deleteWorkforcemanagementBusinessunitSchedulebidGroup';
|
|
213
|
+
}
|
|
214
|
+
// verify the required parameter 'bidGroupId' is set
|
|
215
|
+
if (bidGroupId === undefined || bidGroupId === null || bidGroupId === '') {
|
|
216
|
+
throw 'Missing the required parameter "bidGroupId" when calling deleteWorkforcemanagementBusinessunitSchedulebidGroup';
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
return this.apiClient.callApi(
|
|
220
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/{bidGroupId}',
|
|
221
|
+
'DELETE',
|
|
222
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
|
|
223
|
+
{ },
|
|
224
|
+
{ },
|
|
225
|
+
{ },
|
|
226
|
+
null,
|
|
227
|
+
['PureCloud OAuth'],
|
|
228
|
+
['application/json'],
|
|
229
|
+
['application/json'],
|
|
230
|
+
opts['customHeaders']
|
|
231
|
+
);
|
|
232
|
+
}
|
|
233
|
+
|
|
159
234
|
/**
|
|
160
235
|
* Cancel a scheduling run
|
|
161
236
|
*
|
|
@@ -1969,6 +2044,188 @@ class WorkforceManagementApi {
|
|
|
1969
2044
|
);
|
|
1970
2045
|
}
|
|
1971
2046
|
|
|
2047
|
+
/**
|
|
2048
|
+
* Get a schedule bid
|
|
2049
|
+
*
|
|
2050
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
2051
|
+
* @param {String} bidId The ID of the schedule bid
|
|
2052
|
+
* @param {Object} opts Optional parameters
|
|
2053
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2054
|
+
*/
|
|
2055
|
+
getWorkforcemanagementBusinessunitSchedulebid(businessUnitId, bidId, opts) {
|
|
2056
|
+
opts = opts || {};
|
|
2057
|
+
|
|
2058
|
+
// verify the required parameter 'businessUnitId' is set
|
|
2059
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
2060
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitSchedulebid';
|
|
2061
|
+
}
|
|
2062
|
+
// verify the required parameter 'bidId' is set
|
|
2063
|
+
if (bidId === undefined || bidId === null || bidId === '') {
|
|
2064
|
+
throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitSchedulebid';
|
|
2065
|
+
}
|
|
2066
|
+
|
|
2067
|
+
return this.apiClient.callApi(
|
|
2068
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}',
|
|
2069
|
+
'GET',
|
|
2070
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId },
|
|
2071
|
+
{ },
|
|
2072
|
+
{ },
|
|
2073
|
+
{ },
|
|
2074
|
+
null,
|
|
2075
|
+
['PureCloud OAuth'],
|
|
2076
|
+
['application/json'],
|
|
2077
|
+
['application/json'],
|
|
2078
|
+
opts['customHeaders']
|
|
2079
|
+
);
|
|
2080
|
+
}
|
|
2081
|
+
|
|
2082
|
+
/**
|
|
2083
|
+
* Get a schedule bid group
|
|
2084
|
+
*
|
|
2085
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
2086
|
+
* @param {String} bidId The ID of the schedule bid associated with the bid groups
|
|
2087
|
+
* @param {String} bidGroupId Schedule Bid Group id
|
|
2088
|
+
* @param {Object} opts Optional parameters
|
|
2089
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2090
|
+
*/
|
|
2091
|
+
getWorkforcemanagementBusinessunitSchedulebidGroup(businessUnitId, bidId, bidGroupId, opts) {
|
|
2092
|
+
opts = opts || {};
|
|
2093
|
+
|
|
2094
|
+
// verify the required parameter 'businessUnitId' is set
|
|
2095
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
2096
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitSchedulebidGroup';
|
|
2097
|
+
}
|
|
2098
|
+
// verify the required parameter 'bidId' is set
|
|
2099
|
+
if (bidId === undefined || bidId === null || bidId === '') {
|
|
2100
|
+
throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitSchedulebidGroup';
|
|
2101
|
+
}
|
|
2102
|
+
// verify the required parameter 'bidGroupId' is set
|
|
2103
|
+
if (bidGroupId === undefined || bidGroupId === null || bidGroupId === '') {
|
|
2104
|
+
throw 'Missing the required parameter "bidGroupId" when calling getWorkforcemanagementBusinessunitSchedulebidGroup';
|
|
2105
|
+
}
|
|
2106
|
+
|
|
2107
|
+
return this.apiClient.callApi(
|
|
2108
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/{bidGroupId}',
|
|
2109
|
+
'GET',
|
|
2110
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
|
|
2111
|
+
{ },
|
|
2112
|
+
{ },
|
|
2113
|
+
{ },
|
|
2114
|
+
null,
|
|
2115
|
+
['PureCloud OAuth'],
|
|
2116
|
+
['application/json'],
|
|
2117
|
+
['application/json'],
|
|
2118
|
+
opts['customHeaders']
|
|
2119
|
+
);
|
|
2120
|
+
}
|
|
2121
|
+
|
|
2122
|
+
/**
|
|
2123
|
+
* Get agents schedule bid preferences for a bid group
|
|
2124
|
+
*
|
|
2125
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
2126
|
+
* @param {String} bidId The ID of the schedule bid associated with the bid groups
|
|
2127
|
+
* @param {String} bidGroupId The ID of the schedule bid group
|
|
2128
|
+
* @param {Object} opts Optional parameters
|
|
2129
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
2130
|
+
* @param {Array.<String>} opts.expand Include to fetch agents' preferences with priorities
|
|
2131
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2132
|
+
*/
|
|
2133
|
+
getWorkforcemanagementBusinessunitSchedulebidGroupPreferences(businessUnitId, bidId, bidGroupId, opts) {
|
|
2134
|
+
opts = opts || {};
|
|
2135
|
+
|
|
2136
|
+
// verify the required parameter 'businessUnitId' is set
|
|
2137
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
2138
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitSchedulebidGroupPreferences';
|
|
2139
|
+
}
|
|
2140
|
+
// verify the required parameter 'bidId' is set
|
|
2141
|
+
if (bidId === undefined || bidId === null || bidId === '') {
|
|
2142
|
+
throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitSchedulebidGroupPreferences';
|
|
2143
|
+
}
|
|
2144
|
+
// verify the required parameter 'bidGroupId' is set
|
|
2145
|
+
if (bidGroupId === undefined || bidGroupId === null || bidGroupId === '') {
|
|
2146
|
+
throw 'Missing the required parameter "bidGroupId" when calling getWorkforcemanagementBusinessunitSchedulebidGroupPreferences';
|
|
2147
|
+
}
|
|
2148
|
+
|
|
2149
|
+
return this.apiClient.callApi(
|
|
2150
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/{bidGroupId}/preferences',
|
|
2151
|
+
'GET',
|
|
2152
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
|
|
2153
|
+
{ 'forceDownloadService': opts['forceDownloadService'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
2154
|
+
{ },
|
|
2155
|
+
{ },
|
|
2156
|
+
null,
|
|
2157
|
+
['PureCloud OAuth'],
|
|
2158
|
+
['application/json'],
|
|
2159
|
+
['application/json'],
|
|
2160
|
+
opts['customHeaders']
|
|
2161
|
+
);
|
|
2162
|
+
}
|
|
2163
|
+
|
|
2164
|
+
/**
|
|
2165
|
+
* Get summary of bid groups that belong to a schedule bid
|
|
2166
|
+
*
|
|
2167
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
2168
|
+
* @param {String} bidId The ID of the schedule bid associated with the bid groups
|
|
2169
|
+
* @param {Object} opts Optional parameters
|
|
2170
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2171
|
+
*/
|
|
2172
|
+
getWorkforcemanagementBusinessunitSchedulebidGroupsSummary(businessUnitId, bidId, opts) {
|
|
2173
|
+
opts = opts || {};
|
|
2174
|
+
|
|
2175
|
+
// verify the required parameter 'businessUnitId' is set
|
|
2176
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
2177
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitSchedulebidGroupsSummary';
|
|
2178
|
+
}
|
|
2179
|
+
// verify the required parameter 'bidId' is set
|
|
2180
|
+
if (bidId === undefined || bidId === null || bidId === '') {
|
|
2181
|
+
throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitSchedulebidGroupsSummary';
|
|
2182
|
+
}
|
|
2183
|
+
|
|
2184
|
+
return this.apiClient.callApi(
|
|
2185
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/summary',
|
|
2186
|
+
'GET',
|
|
2187
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId },
|
|
2188
|
+
{ },
|
|
2189
|
+
{ },
|
|
2190
|
+
{ },
|
|
2191
|
+
null,
|
|
2192
|
+
['PureCloud OAuth'],
|
|
2193
|
+
['application/json'],
|
|
2194
|
+
['application/json'],
|
|
2195
|
+
opts['customHeaders']
|
|
2196
|
+
);
|
|
2197
|
+
}
|
|
2198
|
+
|
|
2199
|
+
/**
|
|
2200
|
+
* Get list of schedule bids
|
|
2201
|
+
*
|
|
2202
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
2203
|
+
* @param {Object} opts Optional parameters
|
|
2204
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2205
|
+
*/
|
|
2206
|
+
getWorkforcemanagementBusinessunitSchedulebids(businessUnitId, opts) {
|
|
2207
|
+
opts = opts || {};
|
|
2208
|
+
|
|
2209
|
+
// verify the required parameter 'businessUnitId' is set
|
|
2210
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
2211
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitSchedulebids';
|
|
2212
|
+
}
|
|
2213
|
+
|
|
2214
|
+
return this.apiClient.callApi(
|
|
2215
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids',
|
|
2216
|
+
'GET',
|
|
2217
|
+
{ 'businessUnitId': businessUnitId },
|
|
2218
|
+
{ },
|
|
2219
|
+
{ },
|
|
2220
|
+
{ },
|
|
2221
|
+
null,
|
|
2222
|
+
['PureCloud OAuth'],
|
|
2223
|
+
['application/json'],
|
|
2224
|
+
['application/json'],
|
|
2225
|
+
opts['customHeaders']
|
|
2226
|
+
);
|
|
2227
|
+
}
|
|
2228
|
+
|
|
1972
2229
|
/**
|
|
1973
2230
|
* Get scheduler settings for a business unit
|
|
1974
2231
|
*
|
|
@@ -4446,6 +4703,91 @@ class WorkforceManagementApi {
|
|
|
4446
4703
|
);
|
|
4447
4704
|
}
|
|
4448
4705
|
|
|
4706
|
+
/**
|
|
4707
|
+
* Gets an agent's schedule bidding preference
|
|
4708
|
+
*
|
|
4709
|
+
* @param {String} bidId The ID of the schedule bid
|
|
4710
|
+
* @param {Object} opts Optional parameters
|
|
4711
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4712
|
+
*/
|
|
4713
|
+
getWorkforcemanagementSchedulebidPreference(bidId, opts) {
|
|
4714
|
+
opts = opts || {};
|
|
4715
|
+
|
|
4716
|
+
// verify the required parameter 'bidId' is set
|
|
4717
|
+
if (bidId === undefined || bidId === null || bidId === '') {
|
|
4718
|
+
throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementSchedulebidPreference';
|
|
4719
|
+
}
|
|
4720
|
+
|
|
4721
|
+
return this.apiClient.callApi(
|
|
4722
|
+
'/api/v2/workforcemanagement/schedulebids/{bidId}/preference',
|
|
4723
|
+
'GET',
|
|
4724
|
+
{ 'bidId': bidId },
|
|
4725
|
+
{ },
|
|
4726
|
+
{ },
|
|
4727
|
+
{ },
|
|
4728
|
+
null,
|
|
4729
|
+
['PureCloud OAuth'],
|
|
4730
|
+
['application/json'],
|
|
4731
|
+
['application/json'],
|
|
4732
|
+
opts['customHeaders']
|
|
4733
|
+
);
|
|
4734
|
+
}
|
|
4735
|
+
|
|
4736
|
+
/**
|
|
4737
|
+
* Gets an agent's schedule sets for a bid
|
|
4738
|
+
*
|
|
4739
|
+
* @param {String} bidId The ID of the schedule bid
|
|
4740
|
+
* @param {Object} opts Optional parameters
|
|
4741
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4742
|
+
*/
|
|
4743
|
+
getWorkforcemanagementSchedulebidSchedulesets(bidId, opts) {
|
|
4744
|
+
opts = opts || {};
|
|
4745
|
+
|
|
4746
|
+
// verify the required parameter 'bidId' is set
|
|
4747
|
+
if (bidId === undefined || bidId === null || bidId === '') {
|
|
4748
|
+
throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementSchedulebidSchedulesets';
|
|
4749
|
+
}
|
|
4750
|
+
|
|
4751
|
+
return this.apiClient.callApi(
|
|
4752
|
+
'/api/v2/workforcemanagement/schedulebids/{bidId}/schedulesets',
|
|
4753
|
+
'GET',
|
|
4754
|
+
{ 'bidId': bidId },
|
|
4755
|
+
{ },
|
|
4756
|
+
{ },
|
|
4757
|
+
{ },
|
|
4758
|
+
null,
|
|
4759
|
+
['PureCloud OAuth'],
|
|
4760
|
+
['application/json'],
|
|
4761
|
+
['application/json'],
|
|
4762
|
+
opts['customHeaders']
|
|
4763
|
+
);
|
|
4764
|
+
}
|
|
4765
|
+
|
|
4766
|
+
/**
|
|
4767
|
+
* Gets the list of schedule bids that belong to an agent. It will fetch an open bid or upcoming bid or a bid that is closed recently
|
|
4768
|
+
*
|
|
4769
|
+
* @param {Object} opts Optional parameters
|
|
4770
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4771
|
+
*/
|
|
4772
|
+
getWorkforcemanagementSchedulebids(opts) {
|
|
4773
|
+
opts = opts || {};
|
|
4774
|
+
|
|
4775
|
+
|
|
4776
|
+
return this.apiClient.callApi(
|
|
4777
|
+
'/api/v2/workforcemanagement/schedulebids',
|
|
4778
|
+
'GET',
|
|
4779
|
+
{ },
|
|
4780
|
+
{ },
|
|
4781
|
+
{ },
|
|
4782
|
+
{ },
|
|
4783
|
+
null,
|
|
4784
|
+
['PureCloud OAuth'],
|
|
4785
|
+
['application/json'],
|
|
4786
|
+
['application/json'],
|
|
4787
|
+
opts['customHeaders']
|
|
4788
|
+
);
|
|
4789
|
+
}
|
|
4790
|
+
|
|
4449
4791
|
/**
|
|
4450
4792
|
* Get status of the scheduling job
|
|
4451
4793
|
*
|
|
@@ -5215,13 +5557,123 @@ class WorkforceManagementApi {
|
|
|
5215
5557
|
}
|
|
5216
5558
|
// verify the required parameter 'body' is set
|
|
5217
5559
|
if (body === undefined || body === null) {
|
|
5218
|
-
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitActivityplan';
|
|
5560
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitActivityplan';
|
|
5561
|
+
}
|
|
5562
|
+
|
|
5563
|
+
return this.apiClient.callApi(
|
|
5564
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}',
|
|
5565
|
+
'PATCH',
|
|
5566
|
+
{ 'businessUnitId': businessUnitId,'activityPlanId': activityPlanId },
|
|
5567
|
+
{ },
|
|
5568
|
+
{ },
|
|
5569
|
+
{ },
|
|
5570
|
+
body,
|
|
5571
|
+
['PureCloud OAuth'],
|
|
5572
|
+
['application/json'],
|
|
5573
|
+
['application/json'],
|
|
5574
|
+
opts['customHeaders']
|
|
5575
|
+
);
|
|
5576
|
+
}
|
|
5577
|
+
|
|
5578
|
+
/**
|
|
5579
|
+
* Update alternative shifts settings for a business unit
|
|
5580
|
+
*
|
|
5581
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
5582
|
+
* @param {Object} body body
|
|
5583
|
+
* @param {Object} opts Optional parameters
|
|
5584
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5585
|
+
*/
|
|
5586
|
+
patchWorkforcemanagementBusinessunitAlternativeshiftsSettings(businessUnitId, body, opts) {
|
|
5587
|
+
opts = opts || {};
|
|
5588
|
+
|
|
5589
|
+
// verify the required parameter 'businessUnitId' is set
|
|
5590
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
5591
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitAlternativeshiftsSettings';
|
|
5592
|
+
}
|
|
5593
|
+
// verify the required parameter 'body' is set
|
|
5594
|
+
if (body === undefined || body === null) {
|
|
5595
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitAlternativeshiftsSettings';
|
|
5596
|
+
}
|
|
5597
|
+
|
|
5598
|
+
return this.apiClient.callApi(
|
|
5599
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/settings',
|
|
5600
|
+
'PATCH',
|
|
5601
|
+
{ 'businessUnitId': businessUnitId },
|
|
5602
|
+
{ },
|
|
5603
|
+
{ },
|
|
5604
|
+
{ },
|
|
5605
|
+
body,
|
|
5606
|
+
['PureCloud OAuth'],
|
|
5607
|
+
['application/json'],
|
|
5608
|
+
['application/json'],
|
|
5609
|
+
opts['customHeaders']
|
|
5610
|
+
);
|
|
5611
|
+
}
|
|
5612
|
+
|
|
5613
|
+
/**
|
|
5614
|
+
* Update a capacity plan configuration
|
|
5615
|
+
*
|
|
5616
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
5617
|
+
* @param {String} capacityPlanId The ID of the capacity plan
|
|
5618
|
+
* @param {Object} body body
|
|
5619
|
+
* @param {Object} opts Optional parameters
|
|
5620
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5621
|
+
*/
|
|
5622
|
+
patchWorkforcemanagementBusinessunitCapacityplan(businessUnitId, capacityPlanId, body, opts) {
|
|
5623
|
+
opts = opts || {};
|
|
5624
|
+
|
|
5625
|
+
// verify the required parameter 'businessUnitId' is set
|
|
5626
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
5627
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitCapacityplan';
|
|
5628
|
+
}
|
|
5629
|
+
// verify the required parameter 'capacityPlanId' is set
|
|
5630
|
+
if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
|
|
5631
|
+
throw 'Missing the required parameter "capacityPlanId" when calling patchWorkforcemanagementBusinessunitCapacityplan';
|
|
5632
|
+
}
|
|
5633
|
+
// verify the required parameter 'body' is set
|
|
5634
|
+
if (body === undefined || body === null) {
|
|
5635
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitCapacityplan';
|
|
5636
|
+
}
|
|
5637
|
+
|
|
5638
|
+
return this.apiClient.callApi(
|
|
5639
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}',
|
|
5640
|
+
'PATCH',
|
|
5641
|
+
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
5642
|
+
{ },
|
|
5643
|
+
{ },
|
|
5644
|
+
{ },
|
|
5645
|
+
body,
|
|
5646
|
+
['PureCloud OAuth'],
|
|
5647
|
+
['application/json'],
|
|
5648
|
+
['application/json'],
|
|
5649
|
+
opts['customHeaders']
|
|
5650
|
+
);
|
|
5651
|
+
}
|
|
5652
|
+
|
|
5653
|
+
/**
|
|
5654
|
+
* Update minimum staffing settings for a business unit
|
|
5655
|
+
*
|
|
5656
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
5657
|
+
* @param {Object} body body
|
|
5658
|
+
* @param {Object} opts Optional parameters
|
|
5659
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5660
|
+
*/
|
|
5661
|
+
patchWorkforcemanagementBusinessunitMinimumstaffingSettings(businessUnitId, body, opts) {
|
|
5662
|
+
opts = opts || {};
|
|
5663
|
+
|
|
5664
|
+
// verify the required parameter 'businessUnitId' is set
|
|
5665
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
5666
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitMinimumstaffingSettings';
|
|
5667
|
+
}
|
|
5668
|
+
// verify the required parameter 'body' is set
|
|
5669
|
+
if (body === undefined || body === null) {
|
|
5670
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitMinimumstaffingSettings';
|
|
5219
5671
|
}
|
|
5220
5672
|
|
|
5221
5673
|
return this.apiClient.callApi(
|
|
5222
|
-
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/
|
|
5674
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/minimumstaffing/settings',
|
|
5223
5675
|
'PATCH',
|
|
5224
|
-
{ 'businessUnitId': businessUnitId
|
|
5676
|
+
{ 'businessUnitId': businessUnitId },
|
|
5225
5677
|
{ },
|
|
5226
5678
|
{ },
|
|
5227
5679
|
{ },
|
|
@@ -5234,29 +5686,34 @@ class WorkforceManagementApi {
|
|
|
5234
5686
|
}
|
|
5235
5687
|
|
|
5236
5688
|
/**
|
|
5237
|
-
* Update
|
|
5238
|
-
*
|
|
5689
|
+
* Update the opportunity
|
|
5690
|
+
* Only opportunities with Draft status can be updated.
|
|
5239
5691
|
* @param {String} businessUnitId The ID of the business unit
|
|
5692
|
+
* @param {String} opportunityId The ID of the opportunity
|
|
5240
5693
|
* @param {Object} body body
|
|
5241
5694
|
* @param {Object} opts Optional parameters
|
|
5242
5695
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5243
5696
|
*/
|
|
5244
|
-
|
|
5697
|
+
patchWorkforcemanagementBusinessunitOpportunity(businessUnitId, opportunityId, body, opts) {
|
|
5245
5698
|
opts = opts || {};
|
|
5246
5699
|
|
|
5247
5700
|
// verify the required parameter 'businessUnitId' is set
|
|
5248
5701
|
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
5249
|
-
throw 'Missing the required parameter "businessUnitId" when calling
|
|
5702
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitOpportunity';
|
|
5703
|
+
}
|
|
5704
|
+
// verify the required parameter 'opportunityId' is set
|
|
5705
|
+
if (opportunityId === undefined || opportunityId === null || opportunityId === '') {
|
|
5706
|
+
throw 'Missing the required parameter "opportunityId" when calling patchWorkforcemanagementBusinessunitOpportunity';
|
|
5250
5707
|
}
|
|
5251
5708
|
// verify the required parameter 'body' is set
|
|
5252
5709
|
if (body === undefined || body === null) {
|
|
5253
|
-
throw 'Missing the required parameter "body" when calling
|
|
5710
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitOpportunity';
|
|
5254
5711
|
}
|
|
5255
5712
|
|
|
5256
5713
|
return this.apiClient.callApi(
|
|
5257
|
-
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/
|
|
5714
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/{opportunityId}',
|
|
5258
5715
|
'PATCH',
|
|
5259
|
-
{ 'businessUnitId': businessUnitId },
|
|
5716
|
+
{ 'businessUnitId': businessUnitId,'opportunityId': opportunityId },
|
|
5260
5717
|
{ },
|
|
5261
5718
|
{ },
|
|
5262
5719
|
{ },
|
|
@@ -5269,34 +5726,34 @@ class WorkforceManagementApi {
|
|
|
5269
5726
|
}
|
|
5270
5727
|
|
|
5271
5728
|
/**
|
|
5272
|
-
*
|
|
5273
|
-
*
|
|
5274
|
-
* @param {String} businessUnitId The ID of the business unit
|
|
5275
|
-
* @param {String}
|
|
5729
|
+
* Updates the planning group
|
|
5730
|
+
* If the request body contains queue references in route paths, routing:queue:view is required in each referenced queues division.
|
|
5731
|
+
* @param {String} businessUnitId The ID of the business unit.
|
|
5732
|
+
* @param {String} planningGroupId The ID of a planning group to update
|
|
5276
5733
|
* @param {Object} body body
|
|
5277
5734
|
* @param {Object} opts Optional parameters
|
|
5278
5735
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5279
5736
|
*/
|
|
5280
|
-
|
|
5737
|
+
patchWorkforcemanagementBusinessunitPlanninggroup(businessUnitId, planningGroupId, body, opts) {
|
|
5281
5738
|
opts = opts || {};
|
|
5282
5739
|
|
|
5283
5740
|
// verify the required parameter 'businessUnitId' is set
|
|
5284
5741
|
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
5285
|
-
throw 'Missing the required parameter "businessUnitId" when calling
|
|
5742
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitPlanninggroup';
|
|
5286
5743
|
}
|
|
5287
|
-
// verify the required parameter '
|
|
5288
|
-
if (
|
|
5289
|
-
throw 'Missing the required parameter "
|
|
5744
|
+
// verify the required parameter 'planningGroupId' is set
|
|
5745
|
+
if (planningGroupId === undefined || planningGroupId === null || planningGroupId === '') {
|
|
5746
|
+
throw 'Missing the required parameter "planningGroupId" when calling patchWorkforcemanagementBusinessunitPlanninggroup';
|
|
5290
5747
|
}
|
|
5291
5748
|
// verify the required parameter 'body' is set
|
|
5292
5749
|
if (body === undefined || body === null) {
|
|
5293
|
-
throw 'Missing the required parameter "body" when calling
|
|
5750
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitPlanninggroup';
|
|
5294
5751
|
}
|
|
5295
5752
|
|
|
5296
5753
|
return this.apiClient.callApi(
|
|
5297
|
-
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/
|
|
5754
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}',
|
|
5298
5755
|
'PATCH',
|
|
5299
|
-
{ 'businessUnitId': businessUnitId,'
|
|
5756
|
+
{ 'businessUnitId': businessUnitId,'planningGroupId': planningGroupId },
|
|
5300
5757
|
{ },
|
|
5301
5758
|
{ },
|
|
5302
5759
|
{ },
|
|
@@ -5309,29 +5766,34 @@ class WorkforceManagementApi {
|
|
|
5309
5766
|
}
|
|
5310
5767
|
|
|
5311
5768
|
/**
|
|
5312
|
-
* Update
|
|
5769
|
+
* Update a schedule bid
|
|
5313
5770
|
*
|
|
5314
5771
|
* @param {String} businessUnitId The ID of the business unit
|
|
5315
|
-
* @param {
|
|
5772
|
+
* @param {String} bidId The ID of the schedule bid
|
|
5773
|
+
* @param {Object} body The schedule bid to be updated
|
|
5316
5774
|
* @param {Object} opts Optional parameters
|
|
5317
5775
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5318
5776
|
*/
|
|
5319
|
-
|
|
5777
|
+
patchWorkforcemanagementBusinessunitSchedulebid(businessUnitId, bidId, body, opts) {
|
|
5320
5778
|
opts = opts || {};
|
|
5321
5779
|
|
|
5322
5780
|
// verify the required parameter 'businessUnitId' is set
|
|
5323
5781
|
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
5324
|
-
throw 'Missing the required parameter "businessUnitId" when calling
|
|
5782
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitSchedulebid';
|
|
5783
|
+
}
|
|
5784
|
+
// verify the required parameter 'bidId' is set
|
|
5785
|
+
if (bidId === undefined || bidId === null || bidId === '') {
|
|
5786
|
+
throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementBusinessunitSchedulebid';
|
|
5325
5787
|
}
|
|
5326
5788
|
// verify the required parameter 'body' is set
|
|
5327
5789
|
if (body === undefined || body === null) {
|
|
5328
|
-
throw 'Missing the required parameter "body" when calling
|
|
5790
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitSchedulebid';
|
|
5329
5791
|
}
|
|
5330
5792
|
|
|
5331
5793
|
return this.apiClient.callApi(
|
|
5332
|
-
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/
|
|
5794
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}',
|
|
5333
5795
|
'PATCH',
|
|
5334
|
-
{ 'businessUnitId': businessUnitId },
|
|
5796
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId },
|
|
5335
5797
|
{ },
|
|
5336
5798
|
{ },
|
|
5337
5799
|
{ },
|
|
@@ -5344,34 +5806,39 @@ class WorkforceManagementApi {
|
|
|
5344
5806
|
}
|
|
5345
5807
|
|
|
5346
5808
|
/**
|
|
5347
|
-
* Update
|
|
5348
|
-
*
|
|
5809
|
+
* Update a schedule bid group by bid group Id
|
|
5810
|
+
*
|
|
5349
5811
|
* @param {String} businessUnitId The ID of the business unit
|
|
5350
|
-
* @param {String}
|
|
5812
|
+
* @param {String} bidId The ID of the schedule bid associated with the bid groups
|
|
5813
|
+
* @param {String} bidGroupId Schedule Bid Group id
|
|
5351
5814
|
* @param {Object} body body
|
|
5352
5815
|
* @param {Object} opts Optional parameters
|
|
5353
5816
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5354
5817
|
*/
|
|
5355
|
-
|
|
5818
|
+
patchWorkforcemanagementBusinessunitSchedulebidGroup(businessUnitId, bidId, bidGroupId, body, opts) {
|
|
5356
5819
|
opts = opts || {};
|
|
5357
5820
|
|
|
5358
5821
|
// verify the required parameter 'businessUnitId' is set
|
|
5359
5822
|
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
5360
|
-
throw 'Missing the required parameter "businessUnitId" when calling
|
|
5823
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitSchedulebidGroup';
|
|
5361
5824
|
}
|
|
5362
|
-
// verify the required parameter '
|
|
5363
|
-
if (
|
|
5364
|
-
throw 'Missing the required parameter "
|
|
5825
|
+
// verify the required parameter 'bidId' is set
|
|
5826
|
+
if (bidId === undefined || bidId === null || bidId === '') {
|
|
5827
|
+
throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementBusinessunitSchedulebidGroup';
|
|
5828
|
+
}
|
|
5829
|
+
// verify the required parameter 'bidGroupId' is set
|
|
5830
|
+
if (bidGroupId === undefined || bidGroupId === null || bidGroupId === '') {
|
|
5831
|
+
throw 'Missing the required parameter "bidGroupId" when calling patchWorkforcemanagementBusinessunitSchedulebidGroup';
|
|
5365
5832
|
}
|
|
5366
5833
|
// verify the required parameter 'body' is set
|
|
5367
5834
|
if (body === undefined || body === null) {
|
|
5368
|
-
throw 'Missing the required parameter "body" when calling
|
|
5835
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitSchedulebidGroup';
|
|
5369
5836
|
}
|
|
5370
5837
|
|
|
5371
5838
|
return this.apiClient.callApi(
|
|
5372
|
-
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/
|
|
5839
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/{bidGroupId}',
|
|
5373
5840
|
'PATCH',
|
|
5374
|
-
{ 'businessUnitId': businessUnitId,'
|
|
5841
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
|
|
5375
5842
|
{ },
|
|
5376
5843
|
{ },
|
|
5377
5844
|
{ },
|
|
@@ -5384,34 +5851,39 @@ class WorkforceManagementApi {
|
|
|
5384
5851
|
}
|
|
5385
5852
|
|
|
5386
5853
|
/**
|
|
5387
|
-
*
|
|
5388
|
-
*
|
|
5389
|
-
* @param {String} businessUnitId The ID of the business unit
|
|
5390
|
-
* @param {String}
|
|
5854
|
+
* Overrides the assigned schedule bid for the specified agents
|
|
5855
|
+
*
|
|
5856
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
5857
|
+
* @param {String} bidId The ID of the schedule bid associated with the bid groups
|
|
5858
|
+
* @param {String} bidGroupId The ID of the schedule bid group
|
|
5391
5859
|
* @param {Object} body body
|
|
5392
5860
|
* @param {Object} opts Optional parameters
|
|
5393
5861
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5394
5862
|
*/
|
|
5395
|
-
|
|
5863
|
+
patchWorkforcemanagementBusinessunitSchedulebidGroupPreferences(businessUnitId, bidId, bidGroupId, body, opts) {
|
|
5396
5864
|
opts = opts || {};
|
|
5397
5865
|
|
|
5398
5866
|
// verify the required parameter 'businessUnitId' is set
|
|
5399
5867
|
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
5400
|
-
throw 'Missing the required parameter "businessUnitId" when calling
|
|
5868
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitSchedulebidGroupPreferences';
|
|
5401
5869
|
}
|
|
5402
|
-
// verify the required parameter '
|
|
5403
|
-
if (
|
|
5404
|
-
throw 'Missing the required parameter "
|
|
5870
|
+
// verify the required parameter 'bidId' is set
|
|
5871
|
+
if (bidId === undefined || bidId === null || bidId === '') {
|
|
5872
|
+
throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementBusinessunitSchedulebidGroupPreferences';
|
|
5873
|
+
}
|
|
5874
|
+
// verify the required parameter 'bidGroupId' is set
|
|
5875
|
+
if (bidGroupId === undefined || bidGroupId === null || bidGroupId === '') {
|
|
5876
|
+
throw 'Missing the required parameter "bidGroupId" when calling patchWorkforcemanagementBusinessunitSchedulebidGroupPreferences';
|
|
5405
5877
|
}
|
|
5406
5878
|
// verify the required parameter 'body' is set
|
|
5407
5879
|
if (body === undefined || body === null) {
|
|
5408
|
-
throw 'Missing the required parameter "body" when calling
|
|
5880
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitSchedulebidGroupPreferences';
|
|
5409
5881
|
}
|
|
5410
5882
|
|
|
5411
5883
|
return this.apiClient.callApi(
|
|
5412
|
-
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/
|
|
5884
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/{bidGroupId}/preferences',
|
|
5413
5885
|
'PATCH',
|
|
5414
|
-
{ 'businessUnitId': businessUnitId,'
|
|
5886
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
|
|
5415
5887
|
{ },
|
|
5416
5888
|
{ },
|
|
5417
5889
|
{ },
|
|
@@ -7744,6 +8216,156 @@ class WorkforceManagementApi {
|
|
|
7744
8216
|
);
|
|
7745
8217
|
}
|
|
7746
8218
|
|
|
8219
|
+
/**
|
|
8220
|
+
* Copy a schedule bid
|
|
8221
|
+
*
|
|
8222
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
8223
|
+
* @param {String} bidId The ID of the schedule bid to copy
|
|
8224
|
+
* @param {Object} body body
|
|
8225
|
+
* @param {Object} opts Optional parameters
|
|
8226
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8227
|
+
*/
|
|
8228
|
+
postWorkforcemanagementBusinessunitSchedulebidCopy(businessUnitId, bidId, body, opts) {
|
|
8229
|
+
opts = opts || {};
|
|
8230
|
+
|
|
8231
|
+
// verify the required parameter 'businessUnitId' is set
|
|
8232
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
8233
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitSchedulebidCopy';
|
|
8234
|
+
}
|
|
8235
|
+
// verify the required parameter 'bidId' is set
|
|
8236
|
+
if (bidId === undefined || bidId === null || bidId === '') {
|
|
8237
|
+
throw 'Missing the required parameter "bidId" when calling postWorkforcemanagementBusinessunitSchedulebidCopy';
|
|
8238
|
+
}
|
|
8239
|
+
// verify the required parameter 'body' is set
|
|
8240
|
+
if (body === undefined || body === null) {
|
|
8241
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitSchedulebidCopy';
|
|
8242
|
+
}
|
|
8243
|
+
|
|
8244
|
+
return this.apiClient.callApi(
|
|
8245
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/copy',
|
|
8246
|
+
'POST',
|
|
8247
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId },
|
|
8248
|
+
{ },
|
|
8249
|
+
{ },
|
|
8250
|
+
{ },
|
|
8251
|
+
body,
|
|
8252
|
+
['PureCloud OAuth'],
|
|
8253
|
+
['application/json'],
|
|
8254
|
+
['application/json'],
|
|
8255
|
+
opts['customHeaders']
|
|
8256
|
+
);
|
|
8257
|
+
}
|
|
8258
|
+
|
|
8259
|
+
/**
|
|
8260
|
+
* Add a bid group in a given schedule bid
|
|
8261
|
+
*
|
|
8262
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
8263
|
+
* @param {String} bidId The ID of the schedule bid associated with the bid groups
|
|
8264
|
+
* @param {Object} body body
|
|
8265
|
+
* @param {Object} opts Optional parameters
|
|
8266
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8267
|
+
*/
|
|
8268
|
+
postWorkforcemanagementBusinessunitSchedulebidGroups(businessUnitId, bidId, body, opts) {
|
|
8269
|
+
opts = opts || {};
|
|
8270
|
+
|
|
8271
|
+
// verify the required parameter 'businessUnitId' is set
|
|
8272
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
8273
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitSchedulebidGroups';
|
|
8274
|
+
}
|
|
8275
|
+
// verify the required parameter 'bidId' is set
|
|
8276
|
+
if (bidId === undefined || bidId === null || bidId === '') {
|
|
8277
|
+
throw 'Missing the required parameter "bidId" when calling postWorkforcemanagementBusinessunitSchedulebidGroups';
|
|
8278
|
+
}
|
|
8279
|
+
// verify the required parameter 'body' is set
|
|
8280
|
+
if (body === undefined || body === null) {
|
|
8281
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitSchedulebidGroups';
|
|
8282
|
+
}
|
|
8283
|
+
|
|
8284
|
+
return this.apiClient.callApi(
|
|
8285
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups',
|
|
8286
|
+
'POST',
|
|
8287
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId },
|
|
8288
|
+
{ },
|
|
8289
|
+
{ },
|
|
8290
|
+
{ },
|
|
8291
|
+
body,
|
|
8292
|
+
['PureCloud OAuth'],
|
|
8293
|
+
['application/json'],
|
|
8294
|
+
['application/json'],
|
|
8295
|
+
opts['customHeaders']
|
|
8296
|
+
);
|
|
8297
|
+
}
|
|
8298
|
+
|
|
8299
|
+
/**
|
|
8300
|
+
* Create a new schedule bid
|
|
8301
|
+
*
|
|
8302
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
8303
|
+
* @param {Object} body The schedule bid to be created
|
|
8304
|
+
* @param {Object} opts Optional parameters
|
|
8305
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8306
|
+
*/
|
|
8307
|
+
postWorkforcemanagementBusinessunitSchedulebids(businessUnitId, body, opts) {
|
|
8308
|
+
opts = opts || {};
|
|
8309
|
+
|
|
8310
|
+
// verify the required parameter 'businessUnitId' is set
|
|
8311
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
8312
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitSchedulebids';
|
|
8313
|
+
}
|
|
8314
|
+
// verify the required parameter 'body' is set
|
|
8315
|
+
if (body === undefined || body === null) {
|
|
8316
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitSchedulebids';
|
|
8317
|
+
}
|
|
8318
|
+
|
|
8319
|
+
return this.apiClient.callApi(
|
|
8320
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids',
|
|
8321
|
+
'POST',
|
|
8322
|
+
{ 'businessUnitId': businessUnitId },
|
|
8323
|
+
{ },
|
|
8324
|
+
{ },
|
|
8325
|
+
{ },
|
|
8326
|
+
body,
|
|
8327
|
+
['PureCloud OAuth'],
|
|
8328
|
+
['application/json'],
|
|
8329
|
+
['application/json'],
|
|
8330
|
+
opts['customHeaders']
|
|
8331
|
+
);
|
|
8332
|
+
}
|
|
8333
|
+
|
|
8334
|
+
/**
|
|
8335
|
+
* Fetch all the agents with effective schedule set for the given BU
|
|
8336
|
+
*
|
|
8337
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
8338
|
+
* @param {Object} body body
|
|
8339
|
+
* @param {Object} opts Optional parameters
|
|
8340
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8341
|
+
*/
|
|
8342
|
+
postWorkforcemanagementBusinessunitSchedulebidsEffectiveschedulesets(businessUnitId, body, opts) {
|
|
8343
|
+
opts = opts || {};
|
|
8344
|
+
|
|
8345
|
+
// verify the required parameter 'businessUnitId' is set
|
|
8346
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
8347
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitSchedulebidsEffectiveschedulesets';
|
|
8348
|
+
}
|
|
8349
|
+
// verify the required parameter 'body' is set
|
|
8350
|
+
if (body === undefined || body === null) {
|
|
8351
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitSchedulebidsEffectiveschedulesets';
|
|
8352
|
+
}
|
|
8353
|
+
|
|
8354
|
+
return this.apiClient.callApi(
|
|
8355
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/effectiveschedulesets',
|
|
8356
|
+
'POST',
|
|
8357
|
+
{ 'businessUnitId': businessUnitId },
|
|
8358
|
+
{ },
|
|
8359
|
+
{ },
|
|
8360
|
+
{ },
|
|
8361
|
+
body,
|
|
8362
|
+
['PureCloud OAuth'],
|
|
8363
|
+
['application/json'],
|
|
8364
|
+
['application/json'],
|
|
8365
|
+
opts['customHeaders']
|
|
8366
|
+
);
|
|
8367
|
+
}
|
|
8368
|
+
|
|
7747
8369
|
/**
|
|
7748
8370
|
* Adds a new service goal template
|
|
7749
8371
|
*
|
|
@@ -10748,6 +11370,41 @@ class WorkforceManagementApi {
|
|
|
10748
11370
|
);
|
|
10749
11371
|
}
|
|
10750
11372
|
|
|
11373
|
+
/**
|
|
11374
|
+
* Update an agent's schedule set preference
|
|
11375
|
+
*
|
|
11376
|
+
* @param {String} bidId The ID of the schedule bid
|
|
11377
|
+
* @param {Object} body body
|
|
11378
|
+
* @param {Object} opts Optional parameters
|
|
11379
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
11380
|
+
*/
|
|
11381
|
+
putWorkforcemanagementSchedulebidPreference(bidId, body, opts) {
|
|
11382
|
+
opts = opts || {};
|
|
11383
|
+
|
|
11384
|
+
// verify the required parameter 'bidId' is set
|
|
11385
|
+
if (bidId === undefined || bidId === null || bidId === '') {
|
|
11386
|
+
throw 'Missing the required parameter "bidId" when calling putWorkforcemanagementSchedulebidPreference';
|
|
11387
|
+
}
|
|
11388
|
+
// verify the required parameter 'body' is set
|
|
11389
|
+
if (body === undefined || body === null) {
|
|
11390
|
+
throw 'Missing the required parameter "body" when calling putWorkforcemanagementSchedulebidPreference';
|
|
11391
|
+
}
|
|
11392
|
+
|
|
11393
|
+
return this.apiClient.callApi(
|
|
11394
|
+
'/api/v2/workforcemanagement/schedulebids/{bidId}/preference',
|
|
11395
|
+
'PUT',
|
|
11396
|
+
{ 'bidId': bidId },
|
|
11397
|
+
{ },
|
|
11398
|
+
{ },
|
|
11399
|
+
{ },
|
|
11400
|
+
body,
|
|
11401
|
+
['PureCloud OAuth'],
|
|
11402
|
+
['application/json'],
|
|
11403
|
+
['application/json'],
|
|
11404
|
+
opts['customHeaders']
|
|
11405
|
+
);
|
|
11406
|
+
}
|
|
11407
|
+
|
|
10751
11408
|
}
|
|
10752
11409
|
|
|
10753
11410
|
|