purecloud-platform-client-v2 95.0.0 → 98.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 +2 -2
- package/dist/node/purecloud-platform-client-v2.js +412 -1256
- package/dist/web-amd/purecloud-platform-client-v2.js +412 -1256
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +412 -1256
- package/dist/web-cjs/purecloud-platform-client-v2.js +418 -1263
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +319 -128
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +4 -2
- package/src/purecloud-platform-client-v2/api/BillingApi.js +3 -3
- 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 +26 -10
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- 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/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/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +6 -4
- 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/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.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/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/QualityApi.js +9 -8
- 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 +26 -26
- 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/SpeechTextAnalyticsApi.js +1 -1
- 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/TelephonyApi.js +3 -3
- 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 +123 -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/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +309 -1148
- package/src/purecloud-platform-client-v2/index.js +1 -7
- package/src/purecloud-platform-client-v2/api/UserDevelopmentApi.js +0 -148
|
@@ -128,9 +128,7 @@ function fromByteArray (uint8) {
|
|
|
128
128
|
|
|
129
129
|
// go through the array every three bytes, we'll deal with trailing stuff later
|
|
130
130
|
for (var i = 0, len2 = len - extraBytes; i < len2; i += maxChunkLength) {
|
|
131
|
-
parts.push(encodeChunk(
|
|
132
|
-
uint8, i, (i + maxChunkLength) > len2 ? len2 : (i + maxChunkLength)
|
|
133
|
-
))
|
|
131
|
+
parts.push(encodeChunk(uint8, i, (i + maxChunkLength) > len2 ? len2 : (i + maxChunkLength)))
|
|
134
132
|
}
|
|
135
133
|
|
|
136
134
|
// pad the end with zeros, but make sure to not forget the extra bytes
|
|
@@ -155,7 +153,7 @@ function fromByteArray (uint8) {
|
|
|
155
153
|
}
|
|
156
154
|
|
|
157
155
|
},{}],3:[function(require,module,exports){
|
|
158
|
-
(function (Buffer){
|
|
156
|
+
(function (Buffer){(function (){
|
|
159
157
|
/*!
|
|
160
158
|
* The buffer module from node.js, for the browser.
|
|
161
159
|
*
|
|
@@ -1934,8 +1932,9 @@ function numberIsNaN (obj) {
|
|
|
1934
1932
|
return obj !== obj // eslint-disable-line no-self-compare
|
|
1935
1933
|
}
|
|
1936
1934
|
|
|
1937
|
-
}).call(this,require("buffer").Buffer)
|
|
1935
|
+
}).call(this)}).call(this,require("buffer").Buffer)
|
|
1938
1936
|
},{"base64-js":2,"buffer":3,"ieee754":4}],4:[function(require,module,exports){
|
|
1937
|
+
/*! ieee754. BSD-3-Clause License. Feross Aboukhadijeh <https://feross.org/opensource> */
|
|
1939
1938
|
exports.read = function (buffer, offset, isLE, mLen, nBytes) {
|
|
1940
1939
|
var e, m
|
|
1941
1940
|
var eLen = (nBytes * 8) - mLen - 1
|
|
@@ -4067,7 +4066,7 @@ exports.cleanHeader = function(header, changesOrigin){
|
|
|
4067
4066
|
};
|
|
4068
4067
|
|
|
4069
4068
|
},{}],"platformClient":[function(require,module,exports){
|
|
4070
|
-
(function (global,Buffer){
|
|
4069
|
+
(function (global,Buffer){(function (){
|
|
4071
4070
|
'use strict';
|
|
4072
4071
|
|
|
4073
4072
|
function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
|
|
@@ -6053,7 +6052,7 @@ function isSlowBuffer (obj) {
|
|
|
6053
6052
|
|
|
6054
6053
|
/**
|
|
6055
6054
|
* @module purecloud-platform-client-v2/ApiClient
|
|
6056
|
-
* @version
|
|
6055
|
+
* @version 98.0.0
|
|
6057
6056
|
*/
|
|
6058
6057
|
class ApiClient {
|
|
6059
6058
|
/**
|
|
@@ -6809,7 +6808,7 @@ class ApiClient {
|
|
|
6809
6808
|
|
|
6810
6809
|
// set header parameters
|
|
6811
6810
|
request.set(this.defaultHeaders).set(this.normalizeParams(headerParams));
|
|
6812
|
-
//request.set({ 'purecloud-sdk': '
|
|
6811
|
+
//request.set({ 'purecloud-sdk': '98.0.0' });
|
|
6813
6812
|
|
|
6814
6813
|
// set request timeout
|
|
6815
6814
|
request.timeout(this.timeout);
|
|
@@ -6934,7 +6933,7 @@ class AlertingApi {
|
|
|
6934
6933
|
/**
|
|
6935
6934
|
* Alerting service.
|
|
6936
6935
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
6937
|
-
* @version
|
|
6936
|
+
* @version 98.0.0
|
|
6938
6937
|
*/
|
|
6939
6938
|
|
|
6940
6939
|
/**
|
|
@@ -7248,7 +7247,7 @@ class AnalyticsApi {
|
|
|
7248
7247
|
/**
|
|
7249
7248
|
* Analytics service.
|
|
7250
7249
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
7251
|
-
* @version
|
|
7250
|
+
* @version 98.0.0
|
|
7252
7251
|
*/
|
|
7253
7252
|
|
|
7254
7253
|
/**
|
|
@@ -8328,7 +8327,7 @@ class ArchitectApi {
|
|
|
8328
8327
|
/**
|
|
8329
8328
|
* Architect service.
|
|
8330
8329
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
8331
|
-
* @version
|
|
8330
|
+
* @version 98.0.0
|
|
8332
8331
|
*/
|
|
8333
8332
|
|
|
8334
8333
|
/**
|
|
@@ -11166,7 +11165,7 @@ class AuditApi {
|
|
|
11166
11165
|
/**
|
|
11167
11166
|
* Audit service.
|
|
11168
11167
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
11169
|
-
* @version
|
|
11168
|
+
* @version 98.0.0
|
|
11170
11169
|
*/
|
|
11171
11170
|
|
|
11172
11171
|
/**
|
|
@@ -11337,7 +11336,7 @@ class AuthorizationApi {
|
|
|
11337
11336
|
/**
|
|
11338
11337
|
* Authorization service.
|
|
11339
11338
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
11340
|
-
* @version
|
|
11339
|
+
* @version 98.0.0
|
|
11341
11340
|
*/
|
|
11342
11341
|
|
|
11343
11342
|
/**
|
|
@@ -11672,6 +11671,8 @@ class AuthorizationApi {
|
|
|
11672
11671
|
* @param {Object} opts Optional parameters
|
|
11673
11672
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
11674
11673
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
11674
|
+
* @param {Object} opts.queryType Query filter type
|
|
11675
|
+
* @param {String} opts.query Comma-separated list of permissions or domains to query
|
|
11675
11676
|
*/
|
|
11676
11677
|
getAuthorizationPermissions(opts) {
|
|
11677
11678
|
opts = opts || {};
|
|
@@ -11681,7 +11682,7 @@ class AuthorizationApi {
|
|
|
11681
11682
|
'/api/v2/authorization/permissions',
|
|
11682
11683
|
'GET',
|
|
11683
11684
|
{ },
|
|
11684
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
11685
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'queryType': opts['queryType'],'query': opts['query'] },
|
|
11685
11686
|
{ },
|
|
11686
11687
|
{ },
|
|
11687
11688
|
null,
|
|
@@ -12454,7 +12455,7 @@ class BillingApi {
|
|
|
12454
12455
|
/**
|
|
12455
12456
|
* Billing service.
|
|
12456
12457
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
12457
|
-
* @version
|
|
12458
|
+
* @version 98.0.0
|
|
12458
12459
|
*/
|
|
12459
12460
|
|
|
12460
12461
|
/**
|
|
@@ -12472,8 +12473,8 @@ class BillingApi {
|
|
|
12472
12473
|
/**
|
|
12473
12474
|
* Get a report of the billable license usages
|
|
12474
12475
|
* Report is of the billable usages (e.g. licenses and devices utilized) for a given period. If response's status is InProgress, wait a few seconds, then try the same request again.
|
|
12475
|
-
* @param {Date} startDate The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
12476
|
-
* @param {Date} endDate The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
12476
|
+
* @param {Date} startDate The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
12477
|
+
* @param {Date} endDate The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
12477
12478
|
*/
|
|
12478
12479
|
getBillingReportsBillableusage(startDate, endDate) {
|
|
12479
12480
|
// verify the required parameter 'startDate' is set
|
|
@@ -12534,7 +12535,7 @@ class CoachingApi {
|
|
|
12534
12535
|
/**
|
|
12535
12536
|
* Coaching service.
|
|
12536
12537
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
12537
|
-
* @version
|
|
12538
|
+
* @version 98.0.0
|
|
12538
12539
|
*/
|
|
12539
12540
|
|
|
12540
12541
|
/**
|
|
@@ -13054,7 +13055,7 @@ class ContentManagementApi {
|
|
|
13054
13055
|
/**
|
|
13055
13056
|
* ContentManagement service.
|
|
13056
13057
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
13057
|
-
* @version
|
|
13058
|
+
* @version 98.0.0
|
|
13058
13059
|
*/
|
|
13059
13060
|
|
|
13060
13061
|
/**
|
|
@@ -14194,7 +14195,7 @@ class ConversationsApi {
|
|
|
14194
14195
|
/**
|
|
14195
14196
|
* Conversations service.
|
|
14196
14197
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
14197
|
-
* @version
|
|
14198
|
+
* @version 98.0.0
|
|
14198
14199
|
*/
|
|
14199
14200
|
|
|
14200
14201
|
/**
|
|
@@ -17823,7 +17824,7 @@ class ConversationsApi {
|
|
|
17823
17824
|
|
|
17824
17825
|
/**
|
|
17825
17826
|
* Send message
|
|
17826
|
-
*
|
|
17827
|
+
* Send message on existing conversation/communication. Only one message body field can be accepted, per request. Example: 1 textBody, 1 mediaId, 1 stickerId, or 1 messageTemplate.
|
|
17827
17828
|
* @param {String} conversationId conversationId
|
|
17828
17829
|
* @param {String} communicationId communicationId
|
|
17829
17830
|
* @param {Object} body Message
|
|
@@ -18004,8 +18005,12 @@ class ConversationsApi {
|
|
|
18004
18005
|
* Create a Facebook Integration
|
|
18005
18006
|
*
|
|
18006
18007
|
* @param {Object} body FacebookIntegrationRequest
|
|
18008
|
+
* @param {Object} opts Optional parameters
|
|
18009
|
+
* @param {Boolean} opts.async Create a Facebook integration in an asynchronous manner. If the parameter value is true, this initiates the generation of a new Facebook integration. An integration ID is returned, it can be used to query the integration. Check the integration's createStatus for Completed or Error to detect the create is finished. (default to false)
|
|
18007
18010
|
*/
|
|
18008
|
-
postConversationsMessagingIntegrationsFacebook(body) {
|
|
18011
|
+
postConversationsMessagingIntegrationsFacebook(body, opts) {
|
|
18012
|
+
opts = opts || {};
|
|
18013
|
+
|
|
18009
18014
|
// verify the required parameter 'body' is set
|
|
18010
18015
|
if (body === undefined || body === null) {
|
|
18011
18016
|
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsFacebook';
|
|
@@ -18015,7 +18020,7 @@ class ConversationsApi {
|
|
|
18015
18020
|
'/api/v2/conversations/messaging/integrations/facebook',
|
|
18016
18021
|
'POST',
|
|
18017
18022
|
{ },
|
|
18018
|
-
{
|
|
18023
|
+
{ 'async': opts['async'] },
|
|
18019
18024
|
{ },
|
|
18020
18025
|
{ },
|
|
18021
18026
|
body,
|
|
@@ -18029,8 +18034,12 @@ class ConversationsApi {
|
|
|
18029
18034
|
* Create a LINE messenger Integration
|
|
18030
18035
|
*
|
|
18031
18036
|
* @param {Object} body LineIntegrationRequest
|
|
18037
|
+
* @param {Object} opts Optional parameters
|
|
18038
|
+
* @param {Boolean} opts.async Create a LINE integration in an asynchronous manner. If the parameter value is true, this initiates the generation of a new LINE integration. An integration ID is returned, it can be used to query the integration. Check the integration's createStatus for Completed or Error to detect the create is finished. (default to false)
|
|
18032
18039
|
*/
|
|
18033
|
-
postConversationsMessagingIntegrationsLine(body) {
|
|
18040
|
+
postConversationsMessagingIntegrationsLine(body, opts) {
|
|
18041
|
+
opts = opts || {};
|
|
18042
|
+
|
|
18034
18043
|
// verify the required parameter 'body' is set
|
|
18035
18044
|
if (body === undefined || body === null) {
|
|
18036
18045
|
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsLine';
|
|
@@ -18040,7 +18049,7 @@ class ConversationsApi {
|
|
|
18040
18049
|
'/api/v2/conversations/messaging/integrations/line',
|
|
18041
18050
|
'POST',
|
|
18042
18051
|
{ },
|
|
18043
|
-
{
|
|
18052
|
+
{ 'async': opts['async'] },
|
|
18044
18053
|
{ },
|
|
18045
18054
|
{ },
|
|
18046
18055
|
body,
|
|
@@ -18054,8 +18063,12 @@ class ConversationsApi {
|
|
|
18054
18063
|
* Create a Twitter Integration
|
|
18055
18064
|
*
|
|
18056
18065
|
* @param {Object} body TwitterIntegrationRequest
|
|
18066
|
+
* @param {Object} opts Optional parameters
|
|
18067
|
+
* @param {Boolean} opts.async Create a Twitter integration in an asynchronous manner. If the parameter value is true, this initiates the generation of a new Twitter integration. An integration ID is returned, it can be used to query the integration. Check the integration's createStatus for Completed or Error to detect the create is finished. (default to false)
|
|
18057
18068
|
*/
|
|
18058
|
-
postConversationsMessagingIntegrationsTwitter(body) {
|
|
18069
|
+
postConversationsMessagingIntegrationsTwitter(body, opts) {
|
|
18070
|
+
opts = opts || {};
|
|
18071
|
+
|
|
18059
18072
|
// verify the required parameter 'body' is set
|
|
18060
18073
|
if (body === undefined || body === null) {
|
|
18061
18074
|
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsTwitter';
|
|
@@ -18065,7 +18078,7 @@ class ConversationsApi {
|
|
|
18065
18078
|
'/api/v2/conversations/messaging/integrations/twitter',
|
|
18066
18079
|
'POST',
|
|
18067
18080
|
{ },
|
|
18068
|
-
{
|
|
18081
|
+
{ 'async': opts['async'] },
|
|
18069
18082
|
{ },
|
|
18070
18083
|
{ },
|
|
18071
18084
|
body,
|
|
@@ -18079,8 +18092,12 @@ class ConversationsApi {
|
|
|
18079
18092
|
* Create a WhatsApp Integration
|
|
18080
18093
|
* You must be approved by WhatsApp to use this feature. Your approved e164-formatted phone number and valid WhatsApp certificate for your number are required. Your WhatsApp certificate must have valid base64 encoding. Please paste carefully and do not add any leading or trailing spaces. Do not alter any characters. An integration must be activated within 7 days of certificate generation. If you cannot complete the addition and activation of the number within 7 days, please obtain a new certificate before creating the integration. Integrations created with an invalid number or certificate may immediately incur additional integration fees. Please carefully enter your number and certificate as described.
|
|
18081
18094
|
* @param {Object} body WhatsAppIntegrationRequest
|
|
18095
|
+
* @param {Object} opts Optional parameters
|
|
18096
|
+
* @param {Boolean} opts.async Create a WhatsApp integration in an asynchronous manner. If the parameter value is true, this initiates the generation of a new WhatsApp integration. An integration ID is returned, it can be used to query the integration. Check the integration's createStatus for Completed or Error to detect the create is finished. (default to false)
|
|
18082
18097
|
*/
|
|
18083
|
-
postConversationsMessagingIntegrationsWhatsapp(body) {
|
|
18098
|
+
postConversationsMessagingIntegrationsWhatsapp(body, opts) {
|
|
18099
|
+
opts = opts || {};
|
|
18100
|
+
|
|
18084
18101
|
// verify the required parameter 'body' is set
|
|
18085
18102
|
if (body === undefined || body === null) {
|
|
18086
18103
|
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsWhatsapp';
|
|
@@ -18090,7 +18107,7 @@ class ConversationsApi {
|
|
|
18090
18107
|
'/api/v2/conversations/messaging/integrations/whatsapp',
|
|
18091
18108
|
'POST',
|
|
18092
18109
|
{ },
|
|
18093
|
-
{
|
|
18110
|
+
{ 'async': opts['async'] },
|
|
18094
18111
|
{ },
|
|
18095
18112
|
{ },
|
|
18096
18113
|
body,
|
|
@@ -18236,7 +18253,7 @@ class DataExtensionsApi {
|
|
|
18236
18253
|
/**
|
|
18237
18254
|
* DataExtensions service.
|
|
18238
18255
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
18239
|
-
* @version
|
|
18256
|
+
* @version 98.0.0
|
|
18240
18257
|
*/
|
|
18241
18258
|
|
|
18242
18259
|
/**
|
|
@@ -18322,7 +18339,7 @@ class ExternalContactsApi {
|
|
|
18322
18339
|
/**
|
|
18323
18340
|
* ExternalContacts service.
|
|
18324
18341
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
18325
|
-
* @version
|
|
18342
|
+
* @version 98.0.0
|
|
18326
18343
|
*/
|
|
18327
18344
|
|
|
18328
18345
|
/**
|
|
@@ -19665,7 +19682,7 @@ class FaxApi {
|
|
|
19665
19682
|
/**
|
|
19666
19683
|
* Fax service.
|
|
19667
19684
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
19668
|
-
* @version
|
|
19685
|
+
* @version 98.0.0
|
|
19669
19686
|
*/
|
|
19670
19687
|
|
|
19671
19688
|
/**
|
|
@@ -19836,7 +19853,7 @@ class FlowsApi {
|
|
|
19836
19853
|
/**
|
|
19837
19854
|
* Flows service.
|
|
19838
19855
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
19839
|
-
* @version
|
|
19856
|
+
* @version 98.0.0
|
|
19840
19857
|
*/
|
|
19841
19858
|
|
|
19842
19859
|
/**
|
|
@@ -19907,7 +19924,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
19907
19924
|
/**
|
|
19908
19925
|
* GeneralDataProtectionRegulation service.
|
|
19909
19926
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
19910
|
-
* @version
|
|
19927
|
+
* @version 98.0.0
|
|
19911
19928
|
*/
|
|
19912
19929
|
|
|
19913
19930
|
/**
|
|
@@ -20037,7 +20054,7 @@ class GeolocationApi {
|
|
|
20037
20054
|
/**
|
|
20038
20055
|
* Geolocation service.
|
|
20039
20056
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
20040
|
-
* @version
|
|
20057
|
+
* @version 98.0.0
|
|
20041
20058
|
*/
|
|
20042
20059
|
|
|
20043
20060
|
/**
|
|
@@ -20168,7 +20185,7 @@ class GreetingsApi {
|
|
|
20168
20185
|
/**
|
|
20169
20186
|
* Greetings service.
|
|
20170
20187
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
20171
|
-
* @version
|
|
20188
|
+
* @version 98.0.0
|
|
20172
20189
|
*/
|
|
20173
20190
|
|
|
20174
20191
|
/**
|
|
@@ -20623,7 +20640,7 @@ class GroupsApi {
|
|
|
20623
20640
|
/**
|
|
20624
20641
|
* Groups service.
|
|
20625
20642
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
20626
|
-
* @version
|
|
20643
|
+
* @version 98.0.0
|
|
20627
20644
|
*/
|
|
20628
20645
|
|
|
20629
20646
|
/**
|
|
@@ -21028,7 +21045,7 @@ class IdentityProviderApi {
|
|
|
21028
21045
|
/**
|
|
21029
21046
|
* IdentityProvider service.
|
|
21030
21047
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
21031
|
-
* @version
|
|
21048
|
+
* @version 98.0.0
|
|
21032
21049
|
*/
|
|
21033
21050
|
|
|
21034
21051
|
/**
|
|
@@ -21784,7 +21801,7 @@ class IntegrationsApi {
|
|
|
21784
21801
|
/**
|
|
21785
21802
|
* Integrations service.
|
|
21786
21803
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
21787
|
-
* @version
|
|
21804
|
+
* @version 98.0.0
|
|
21788
21805
|
*/
|
|
21789
21806
|
|
|
21790
21807
|
/**
|
|
@@ -23276,7 +23293,7 @@ class JourneyApi {
|
|
|
23276
23293
|
/**
|
|
23277
23294
|
* Journey service.
|
|
23278
23295
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
23279
|
-
* @version
|
|
23296
|
+
* @version 98.0.0
|
|
23280
23297
|
*/
|
|
23281
23298
|
|
|
23282
23299
|
/**
|
|
@@ -23401,7 +23418,7 @@ class KnowledgeApi {
|
|
|
23401
23418
|
/**
|
|
23402
23419
|
* Knowledge service.
|
|
23403
23420
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
23404
|
-
* @version
|
|
23421
|
+
* @version 98.0.0
|
|
23405
23422
|
*/
|
|
23406
23423
|
|
|
23407
23424
|
/**
|
|
@@ -23654,6 +23671,7 @@ class KnowledgeApi {
|
|
|
23654
23671
|
* @param {String} opts.limit Number of entities to return. Maximum of 200.
|
|
23655
23672
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23656
23673
|
* @param {String} opts.categories Filter by categories ids, comma separated values expected.
|
|
23674
|
+
* @param {String} opts.title Filter by document title.
|
|
23657
23675
|
*/
|
|
23658
23676
|
getKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, opts) {
|
|
23659
23677
|
opts = opts || {};
|
|
@@ -23671,7 +23689,7 @@ class KnowledgeApi {
|
|
|
23671
23689
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents',
|
|
23672
23690
|
'GET',
|
|
23673
23691
|
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
23674
|
-
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'categories': opts['categories'] },
|
|
23692
|
+
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'categories': opts['categories'],'title': opts['title'] },
|
|
23675
23693
|
{ },
|
|
23676
23694
|
{ },
|
|
23677
23695
|
null,
|
|
@@ -23717,7 +23735,7 @@ class KnowledgeApi {
|
|
|
23717
23735
|
}
|
|
23718
23736
|
|
|
23719
23737
|
/**
|
|
23720
|
-
* Get
|
|
23738
|
+
* Get all trainings information for a knowledgebase
|
|
23721
23739
|
*
|
|
23722
23740
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23723
23741
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
@@ -23726,6 +23744,7 @@ class KnowledgeApi {
|
|
|
23726
23744
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23727
23745
|
* @param {String} opts.limit Number of entities to return. Maximum of 200.
|
|
23728
23746
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23747
|
+
* @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
|
|
23729
23748
|
*/
|
|
23730
23749
|
getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode, opts) {
|
|
23731
23750
|
opts = opts || {};
|
|
@@ -23743,7 +23762,7 @@ class KnowledgeApi {
|
|
|
23743
23762
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings',
|
|
23744
23763
|
'GET',
|
|
23745
23764
|
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
23746
|
-
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'] },
|
|
23765
|
+
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'knowledgeDocumentsState': opts['knowledgeDocumentsState'] },
|
|
23747
23766
|
{ },
|
|
23748
23767
|
{ },
|
|
23749
23768
|
null,
|
|
@@ -24121,7 +24140,7 @@ class LanguageUnderstandingApi {
|
|
|
24121
24140
|
/**
|
|
24122
24141
|
* LanguageUnderstanding service.
|
|
24123
24142
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
24124
|
-
* @version
|
|
24143
|
+
* @version 98.0.0
|
|
24125
24144
|
*/
|
|
24126
24145
|
|
|
24127
24146
|
/**
|
|
@@ -24687,7 +24706,7 @@ class LanguagesApi {
|
|
|
24687
24706
|
/**
|
|
24688
24707
|
* Languages service.
|
|
24689
24708
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
24690
|
-
* @version
|
|
24709
|
+
* @version 98.0.0
|
|
24691
24710
|
*/
|
|
24692
24711
|
|
|
24693
24712
|
/**
|
|
@@ -24955,7 +24974,7 @@ class LicenseApi {
|
|
|
24955
24974
|
/**
|
|
24956
24975
|
* License service.
|
|
24957
24976
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
24958
|
-
* @version
|
|
24977
|
+
* @version 98.0.0
|
|
24959
24978
|
*/
|
|
24960
24979
|
|
|
24961
24980
|
/**
|
|
@@ -25193,7 +25212,7 @@ class LocationsApi {
|
|
|
25193
25212
|
/**
|
|
25194
25213
|
* Locations service.
|
|
25195
25214
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
25196
|
-
* @version
|
|
25215
|
+
* @version 98.0.0
|
|
25197
25216
|
*/
|
|
25198
25217
|
|
|
25199
25218
|
/**
|
|
@@ -25429,7 +25448,7 @@ class MobileDevicesApi {
|
|
|
25429
25448
|
/**
|
|
25430
25449
|
* MobileDevices service.
|
|
25431
25450
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
25432
|
-
* @version
|
|
25451
|
+
* @version 98.0.0
|
|
25433
25452
|
*/
|
|
25434
25453
|
|
|
25435
25454
|
/**
|
|
@@ -25580,7 +25599,7 @@ class NotificationsApi {
|
|
|
25580
25599
|
/**
|
|
25581
25600
|
* Notifications service.
|
|
25582
25601
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
25583
|
-
* @version
|
|
25602
|
+
* @version 98.0.0
|
|
25584
25603
|
*/
|
|
25585
25604
|
|
|
25586
25605
|
/**
|
|
@@ -25779,7 +25798,7 @@ class OAuthApi {
|
|
|
25779
25798
|
/**
|
|
25780
25799
|
* OAuth service.
|
|
25781
25800
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
25782
|
-
* @version
|
|
25801
|
+
* @version 98.0.0
|
|
25783
25802
|
*/
|
|
25784
25803
|
|
|
25785
25804
|
/**
|
|
@@ -26137,7 +26156,7 @@ class ObjectsApi {
|
|
|
26137
26156
|
/**
|
|
26138
26157
|
* Objects service.
|
|
26139
26158
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
26140
|
-
* @version
|
|
26159
|
+
* @version 98.0.0
|
|
26141
26160
|
*/
|
|
26142
26161
|
|
|
26143
26162
|
/**
|
|
@@ -26378,7 +26397,7 @@ class OrganizationApi {
|
|
|
26378
26397
|
/**
|
|
26379
26398
|
* Organization service.
|
|
26380
26399
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
26381
|
-
* @version
|
|
26400
|
+
* @version 98.0.0
|
|
26382
26401
|
*/
|
|
26383
26402
|
|
|
26384
26403
|
/**
|
|
@@ -26633,7 +26652,7 @@ class OrganizationAuthorizationApi {
|
|
|
26633
26652
|
/**
|
|
26634
26653
|
* OrganizationAuthorization service.
|
|
26635
26654
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
26636
|
-
* @version
|
|
26655
|
+
* @version 98.0.0
|
|
26637
26656
|
*/
|
|
26638
26657
|
|
|
26639
26658
|
/**
|
|
@@ -27343,7 +27362,7 @@ class OutboundApi {
|
|
|
27343
27362
|
/**
|
|
27344
27363
|
* Outbound service.
|
|
27345
27364
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
27346
|
-
* @version
|
|
27365
|
+
* @version 98.0.0
|
|
27347
27366
|
*/
|
|
27348
27367
|
|
|
27349
27368
|
/**
|
|
@@ -30317,7 +30336,7 @@ class PresenceApi {
|
|
|
30317
30336
|
/**
|
|
30318
30337
|
* Presence service.
|
|
30319
30338
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
30320
|
-
* @version
|
|
30339
|
+
* @version 98.0.0
|
|
30321
30340
|
*/
|
|
30322
30341
|
|
|
30323
30342
|
/**
|
|
@@ -30664,7 +30683,7 @@ class QualityApi {
|
|
|
30664
30683
|
/**
|
|
30665
30684
|
* Quality service.
|
|
30666
30685
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
30667
|
-
* @version
|
|
30686
|
+
* @version 98.0.0
|
|
30668
30687
|
*/
|
|
30669
30688
|
|
|
30670
30689
|
/**
|
|
@@ -30878,8 +30897,8 @@ class QualityApi {
|
|
|
30878
30897
|
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
30879
30898
|
* @param {String} opts.nextPage next page token
|
|
30880
30899
|
* @param {String} opts.previousPage Previous page token
|
|
30881
|
-
* @param {Date} opts.startTime Start time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
30882
|
-
* @param {Date} opts.endTime End time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
30900
|
+
* @param {Date} opts.startTime Start time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
30901
|
+
* @param {Date} opts.endTime End time of agent activity. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
30883
30902
|
* @param {Array.<String>} opts.agentUserId user id of agent requested
|
|
30884
30903
|
* @param {String} opts.evaluatorUserId user id of the evaluator
|
|
30885
30904
|
* @param {String} opts.name name
|
|
@@ -30945,8 +30964,8 @@ class QualityApi {
|
|
|
30945
30964
|
* @param {String} opts.nextPage next page token
|
|
30946
30965
|
* @param {String} opts.previousPage Previous page token
|
|
30947
30966
|
* @param {String} opts.conversationId conversation id
|
|
30948
|
-
* @param {Date} opts.startTime Beginning of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
30949
|
-
* @param {Date} opts.endTime end of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
30967
|
+
* @param {Date} opts.startTime Beginning of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
30968
|
+
* @param {Date} opts.endTime end of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
30950
30969
|
*/
|
|
30951
30970
|
getQualityCalibrations(calibratorId, opts) {
|
|
30952
30971
|
opts = opts || {};
|
|
@@ -31116,8 +31135,8 @@ class QualityApi {
|
|
|
31116
31135
|
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
31117
31136
|
* @param {String} opts.nextPage next page token
|
|
31118
31137
|
* @param {String} opts.previousPage Previous page token
|
|
31119
|
-
* @param {Date} opts.startTime The start time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
31120
|
-
* @param {Date} opts.endTime The end time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
31138
|
+
* @param {Date} opts.startTime The start time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
31139
|
+
* @param {Date} opts.endTime The end time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
31121
31140
|
* @param {String} opts.name Evaluator name
|
|
31122
31141
|
* @param {Array.<String>} opts.permission permission strings
|
|
31123
31142
|
* @param {String} opts.group group id
|
|
@@ -31258,6 +31277,7 @@ class QualityApi {
|
|
|
31258
31277
|
* @param {Object} opts Optional parameters
|
|
31259
31278
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
31260
31279
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
31280
|
+
* @param {String} opts.sortOrder Sort order (default to asc)
|
|
31261
31281
|
*/
|
|
31262
31282
|
getQualityFormsEvaluationVersions(formId, opts) {
|
|
31263
31283
|
opts = opts || {};
|
|
@@ -31271,7 +31291,7 @@ class QualityApi {
|
|
|
31271
31291
|
'/api/v2/quality/forms/evaluations/{formId}/versions',
|
|
31272
31292
|
'GET',
|
|
31273
31293
|
{ 'formId': formId },
|
|
31274
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
31294
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'] },
|
|
31275
31295
|
{ },
|
|
31276
31296
|
{ },
|
|
31277
31297
|
null,
|
|
@@ -32361,7 +32381,7 @@ class RecordingApi {
|
|
|
32361
32381
|
/**
|
|
32362
32382
|
* Recording service.
|
|
32363
32383
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
32364
|
-
* @version
|
|
32384
|
+
* @version 98.0.0
|
|
32365
32385
|
*/
|
|
32366
32386
|
|
|
32367
32387
|
/**
|
|
@@ -33607,7 +33627,7 @@ class ResponseManagementApi {
|
|
|
33607
33627
|
/**
|
|
33608
33628
|
* ResponseManagement service.
|
|
33609
33629
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
33610
|
-
* @version
|
|
33630
|
+
* @version 98.0.0
|
|
33611
33631
|
*/
|
|
33612
33632
|
|
|
33613
33633
|
/**
|
|
@@ -33932,7 +33952,7 @@ class RoutingApi {
|
|
|
33932
33952
|
/**
|
|
33933
33953
|
* Routing service.
|
|
33934
33954
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
33935
|
-
* @version
|
|
33955
|
+
* @version 98.0.0
|
|
33936
33956
|
*/
|
|
33937
33957
|
|
|
33938
33958
|
/**
|
|
@@ -36230,7 +36250,7 @@ class SCIMApi {
|
|
|
36230
36250
|
/**
|
|
36231
36251
|
* SCIM service.
|
|
36232
36252
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
36233
|
-
* @version
|
|
36253
|
+
* @version 98.0.0
|
|
36234
36254
|
*/
|
|
36235
36255
|
|
|
36236
36256
|
/**
|
|
@@ -36366,8 +36386,8 @@ class SCIMApi {
|
|
|
36366
36386
|
*
|
|
36367
36387
|
* @param {String} groupId The ID of a group. Returned with GET /api/v2/scim/groups.
|
|
36368
36388
|
* @param {Object} opts Optional parameters
|
|
36369
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
36370
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
36389
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
36390
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
36371
36391
|
* @param {String} opts.ifNoneMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
36372
36392
|
*/
|
|
36373
36393
|
getScimGroup(groupId, opts) {
|
|
@@ -36397,9 +36417,9 @@ class SCIMApi {
|
|
|
36397
36417
|
*
|
|
36398
36418
|
* @param {Object} opts Optional parameters
|
|
36399
36419
|
* @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
|
|
36400
|
-
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
36401
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
36402
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
36420
|
+
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\". (default to 25)
|
|
36421
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
36422
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
36403
36423
|
* @param {String} opts.filter Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\".
|
|
36404
36424
|
*/
|
|
36405
36425
|
getScimGroups(opts) {
|
|
@@ -36543,9 +36563,9 @@ class SCIMApi {
|
|
|
36543
36563
|
*
|
|
36544
36564
|
* @param {String} userId The ID of a user. Returned with GET /api/v2/scim/users.
|
|
36545
36565
|
* @param {Object} opts Optional parameters
|
|
36546
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
36547
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
36548
|
-
* @param {String} opts.ifNoneMatch
|
|
36566
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
36567
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
36568
|
+
* @param {String} opts.ifNoneMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
36549
36569
|
*/
|
|
36550
36570
|
getScimUser(userId, opts) {
|
|
36551
36571
|
opts = opts || {};
|
|
@@ -36574,9 +36594,9 @@ class SCIMApi {
|
|
|
36574
36594
|
* To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
|
|
36575
36595
|
* @param {Object} opts Optional parameters
|
|
36576
36596
|
* @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
|
|
36577
|
-
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
36578
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
36579
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
36597
|
+
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\". (default to 25)
|
|
36598
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
36599
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
36580
36600
|
* @param {String} opts.filter Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\", \"employeeNumber eq 9876543210\".
|
|
36581
36601
|
*/
|
|
36582
36602
|
getScimUsers(opts) {
|
|
@@ -36602,9 +36622,9 @@ class SCIMApi {
|
|
|
36602
36622
|
*
|
|
36603
36623
|
* @param {String} groupId The ID of a group. Returned with GET /api/v2/scim/v2/groups.
|
|
36604
36624
|
* @param {Object} opts Optional parameters
|
|
36605
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
36606
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
36607
|
-
* @param {String} opts.ifNoneMatch
|
|
36625
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
36626
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
36627
|
+
* @param {String} opts.ifNoneMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
36608
36628
|
*/
|
|
36609
36629
|
getScimV2Group(groupId, opts) {
|
|
36610
36630
|
opts = opts || {};
|
|
@@ -36634,9 +36654,9 @@ class SCIMApi {
|
|
|
36634
36654
|
* @param {String} filter Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\".
|
|
36635
36655
|
* @param {Object} opts Optional parameters
|
|
36636
36656
|
* @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
|
|
36637
|
-
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
36638
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
36639
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
36657
|
+
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\". (default to 25)
|
|
36658
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
36659
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
36640
36660
|
*/
|
|
36641
36661
|
getScimV2Groups(filter, opts) {
|
|
36642
36662
|
opts = opts || {};
|
|
@@ -36783,8 +36803,8 @@ class SCIMApi {
|
|
|
36783
36803
|
*
|
|
36784
36804
|
* @param {String} userId The ID of a user. Returned with GET /api/v2/scim/v2/users.
|
|
36785
36805
|
* @param {Object} opts Optional parameters
|
|
36786
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
36787
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
36806
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
36807
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
36788
36808
|
* @param {String} opts.ifNoneMatch The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.
|
|
36789
36809
|
*/
|
|
36790
36810
|
getScimV2User(userId, opts) {
|
|
@@ -36814,9 +36834,9 @@ class SCIMApi {
|
|
|
36814
36834
|
* To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
|
|
36815
36835
|
* @param {Object} opts Optional parameters
|
|
36816
36836
|
* @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
|
|
36817
|
-
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
36818
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
36819
|
-
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
36837
|
+
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\". (default to 25)
|
|
36838
|
+
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes.
|
|
36839
|
+
* @param {Array.<String>} opts.excludedAttributes Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes.
|
|
36820
36840
|
* @param {String} opts.filter Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\", \"employeeNumber eq 9876543210\".
|
|
36821
36841
|
*/
|
|
36822
36842
|
getScimV2Users(opts) {
|
|
@@ -36974,8 +36994,8 @@ class SCIMApi {
|
|
|
36974
36994
|
}
|
|
36975
36995
|
|
|
36976
36996
|
/**
|
|
36977
|
-
*
|
|
36978
|
-
* Creates a Genesys Cloud group with group visibility set to \"public\" and rules visibility set to \"true\". Auto-creates an \"externalId\". \"externalId\" is used to determine if DELETE /api/v2/scim/groups/{groupId} or DELETE /api/v2/scim/v2/groups/{groupId}
|
|
36997
|
+
* Create a group
|
|
36998
|
+
* Creates a Genesys Cloud group with group visibility set to \"public\" and rules visibility set to \"true\". Auto-creates an \"externalId\". \"externalId\" is used to determine if DELETE /api/v2/scim/groups/{groupId} or DELETE /api/v2/scim/v2/groups/{groupId} is allowed.
|
|
36979
36999
|
* @param {Object} body The information used to create a group.
|
|
36980
37000
|
*/
|
|
36981
37001
|
postScimGroups(body) {
|
|
@@ -37026,7 +37046,7 @@ class SCIMApi {
|
|
|
37026
37046
|
/**
|
|
37027
37047
|
* Create a group
|
|
37028
37048
|
* Creates an \"official\" Genesys Cloud group with group visibility set to \"public\" and rules visibility set to \"true\". Auto-creates an \"externalId\". \"externalId\" is used to determine if DELETE /api/v2/scim/groups/{groupId} or DELETE /api/v2/scim/v2/groups/{groupId} should be allowed.
|
|
37029
|
-
* @param {Object} body
|
|
37049
|
+
* @param {Object} body The information used to create a group.
|
|
37030
37050
|
*/
|
|
37031
37051
|
postScimV2Groups(body) {
|
|
37032
37052
|
// verify the required parameter 'body' is set
|
|
@@ -37215,7 +37235,7 @@ class ScriptsApi {
|
|
|
37215
37235
|
/**
|
|
37216
37236
|
* Scripts service.
|
|
37217
37237
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
37218
|
-
* @version
|
|
37238
|
+
* @version 98.0.0
|
|
37219
37239
|
*/
|
|
37220
37240
|
|
|
37221
37241
|
/**
|
|
@@ -37568,7 +37588,7 @@ class SearchApi {
|
|
|
37568
37588
|
/**
|
|
37569
37589
|
* Search service.
|
|
37570
37590
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
37571
|
-
* @version
|
|
37591
|
+
* @version 98.0.0
|
|
37572
37592
|
*/
|
|
37573
37593
|
|
|
37574
37594
|
/**
|
|
@@ -38078,7 +38098,7 @@ class SpeechTextAnalyticsApi {
|
|
|
38078
38098
|
/**
|
|
38079
38099
|
* SpeechTextAnalytics service.
|
|
38080
38100
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
38081
|
-
* @version
|
|
38101
|
+
* @version 98.0.0
|
|
38082
38102
|
*/
|
|
38083
38103
|
|
|
38084
38104
|
/**
|
|
@@ -38154,7 +38174,7 @@ class StationsApi {
|
|
|
38154
38174
|
/**
|
|
38155
38175
|
* Stations service.
|
|
38156
38176
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
38157
|
-
* @version
|
|
38177
|
+
* @version 98.0.0
|
|
38158
38178
|
*/
|
|
38159
38179
|
|
|
38160
38180
|
/**
|
|
@@ -38301,7 +38321,7 @@ class SuggestApi {
|
|
|
38301
38321
|
/**
|
|
38302
38322
|
* Suggest service.
|
|
38303
38323
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
38304
|
-
* @version
|
|
38324
|
+
* @version 98.0.0
|
|
38305
38325
|
*/
|
|
38306
38326
|
|
|
38307
38327
|
/**
|
|
@@ -38440,7 +38460,7 @@ class TelephonyApi {
|
|
|
38440
38460
|
/**
|
|
38441
38461
|
* Telephony service.
|
|
38442
38462
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
38443
|
-
* @version
|
|
38463
|
+
* @version 98.0.0
|
|
38444
38464
|
*/
|
|
38445
38465
|
|
|
38446
38466
|
/**
|
|
@@ -38458,8 +38478,8 @@ class TelephonyApi {
|
|
|
38458
38478
|
/**
|
|
38459
38479
|
* Fetch SIP metadata
|
|
38460
38480
|
* Fetch SIP metadata that matches a given parameter. If exactMatch is passed as a parameter only sip records that have exactly that value will be returned. For example, some records contain conversationId but not all relevant records for that call may contain the conversationId so only a partial view of the call will be reflected
|
|
38461
|
-
* @param {Date} dateStart Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
38462
|
-
* @param {Date} dateEnd End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
38481
|
+
* @param {Date} dateStart Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
38482
|
+
* @param {Date} dateEnd End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
38463
38483
|
* @param {Object} opts Optional parameters
|
|
38464
38484
|
* @param {String} opts.callId unique identification of the placed call
|
|
38465
38485
|
* @param {String} opts.toUser User to who the call was placed
|
|
@@ -38548,7 +38568,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
38548
38568
|
/**
|
|
38549
38569
|
* TelephonyProvidersEdge service.
|
|
38550
38570
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
38551
|
-
* @version
|
|
38571
|
+
* @version 98.0.0
|
|
38552
38572
|
*/
|
|
38553
38573
|
|
|
38554
38574
|
/**
|
|
@@ -42125,7 +42145,7 @@ class TextbotsApi {
|
|
|
42125
42145
|
/**
|
|
42126
42146
|
* Textbots service.
|
|
42127
42147
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
42128
|
-
* @version
|
|
42148
|
+
* @version 98.0.0
|
|
42129
42149
|
*/
|
|
42130
42150
|
|
|
42131
42151
|
/**
|
|
@@ -42171,7 +42191,7 @@ class TokensApi {
|
|
|
42171
42191
|
/**
|
|
42172
42192
|
* Tokens service.
|
|
42173
42193
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
42174
|
-
* @version
|
|
42194
|
+
* @version 98.0.0
|
|
42175
42195
|
*/
|
|
42176
42196
|
|
|
42177
42197
|
/**
|
|
@@ -42257,7 +42277,7 @@ class UploadsApi {
|
|
|
42257
42277
|
/**
|
|
42258
42278
|
* Uploads service.
|
|
42259
42279
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
42260
|
-
* @version
|
|
42280
|
+
* @version 98.0.0
|
|
42261
42281
|
*/
|
|
42262
42282
|
|
|
42263
42283
|
/**
|
|
@@ -42303,7 +42323,7 @@ class UsageApi {
|
|
|
42303
42323
|
/**
|
|
42304
42324
|
* Usage service.
|
|
42305
42325
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
42306
|
-
* @version
|
|
42326
|
+
* @version 98.0.0
|
|
42307
42327
|
*/
|
|
42308
42328
|
|
|
42309
42329
|
/**
|
|
@@ -42370,154 +42390,11 @@ class UsageApi {
|
|
|
42370
42390
|
|
|
42371
42391
|
}
|
|
42372
42392
|
|
|
42373
|
-
class UserDevelopmentApi {
|
|
42374
|
-
/**
|
|
42375
|
-
* UserDevelopment service.
|
|
42376
|
-
* @module purecloud-platform-client-v2/api/UserDevelopmentApi
|
|
42377
|
-
* @version 95.0.0
|
|
42378
|
-
*/
|
|
42379
|
-
|
|
42380
|
-
/**
|
|
42381
|
-
* Constructs a new UserDevelopmentApi.
|
|
42382
|
-
* @alias module:purecloud-platform-client-v2/api/UserDevelopmentApi
|
|
42383
|
-
* @class
|
|
42384
|
-
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
42385
|
-
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
42386
|
-
*/
|
|
42387
|
-
constructor(apiClient) {
|
|
42388
|
-
this.apiClient = apiClient || ApiClient.instance;
|
|
42389
|
-
}
|
|
42390
|
-
|
|
42391
|
-
|
|
42392
|
-
/**
|
|
42393
|
-
* Get list of Development Activities
|
|
42394
|
-
* Either moduleId or userId is required. Results are filtered based on the applicable permissions.
|
|
42395
|
-
* @param {Object} opts Optional parameters
|
|
42396
|
-
* @param {Array.<String>} opts.userId Specifies the list of user IDs to be queried, up to 100 user IDs. It searches for any relationship for the userId.
|
|
42397
|
-
* @param {String} opts.moduleId Specifies the ID of the learning module.
|
|
42398
|
-
* @param {String} opts.interval Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
42399
|
-
* @param {String} opts.completionInterval Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
42400
|
-
* @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
|
|
42401
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
42402
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
42403
|
-
* @param {Object} opts.sortOrder Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (default to Desc)
|
|
42404
|
-
* @param {Array.<String>} opts.types Specifies the activity types.
|
|
42405
|
-
* @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
|
|
42406
|
-
* @param {Array.<String>} opts.relationship Specifies how the current user relation should be interpreted, and filters the activities returned to only those that have the specified relationship. If not specified, all relationships are returned.
|
|
42407
|
-
*/
|
|
42408
|
-
getUsersDevelopmentActivities(opts) {
|
|
42409
|
-
opts = opts || {};
|
|
42410
|
-
|
|
42411
|
-
|
|
42412
|
-
return this.apiClient.callApi(
|
|
42413
|
-
'/api/v2/users/development/activities',
|
|
42414
|
-
'GET',
|
|
42415
|
-
{ },
|
|
42416
|
-
{ 'userId': this.apiClient.buildCollectionParam(opts['userId'], 'multi'),'moduleId': opts['moduleId'],'interval': opts['interval'],'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'relationship': this.apiClient.buildCollectionParam(opts['relationship'], 'multi') },
|
|
42417
|
-
{ },
|
|
42418
|
-
{ },
|
|
42419
|
-
null,
|
|
42420
|
-
['PureCloud OAuth'],
|
|
42421
|
-
['application/json'],
|
|
42422
|
-
['application/json']
|
|
42423
|
-
);
|
|
42424
|
-
}
|
|
42425
|
-
|
|
42426
|
-
/**
|
|
42427
|
-
* Get list of Development Activities for current user
|
|
42428
|
-
* Results are filtered based on the applicable permissions.
|
|
42429
|
-
* @param {Object} opts Optional parameters
|
|
42430
|
-
* @param {String} opts.moduleId Specifies the ID of the learning module.
|
|
42431
|
-
* @param {String} opts.interval Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
42432
|
-
* @param {String} opts.completionInterval Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
42433
|
-
* @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
|
|
42434
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
42435
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
42436
|
-
* @param {Object} opts.sortOrder Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (default to Desc)
|
|
42437
|
-
* @param {Array.<String>} opts.types Specifies the activity types.
|
|
42438
|
-
* @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
|
|
42439
|
-
* @param {Array.<String>} opts.relationship Specifies how the current user relation should be interpreted, and filters the activities returned to only those that have the specified relationship. If not specified, all relationships are returned.
|
|
42440
|
-
*/
|
|
42441
|
-
getUsersDevelopmentActivitiesMe(opts) {
|
|
42442
|
-
opts = opts || {};
|
|
42443
|
-
|
|
42444
|
-
|
|
42445
|
-
return this.apiClient.callApi(
|
|
42446
|
-
'/api/v2/users/development/activities/me',
|
|
42447
|
-
'GET',
|
|
42448
|
-
{ },
|
|
42449
|
-
{ 'moduleId': opts['moduleId'],'interval': opts['interval'],'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'relationship': this.apiClient.buildCollectionParam(opts['relationship'], 'multi') },
|
|
42450
|
-
{ },
|
|
42451
|
-
{ },
|
|
42452
|
-
null,
|
|
42453
|
-
['PureCloud OAuth'],
|
|
42454
|
-
['application/json'],
|
|
42455
|
-
['application/json']
|
|
42456
|
-
);
|
|
42457
|
-
}
|
|
42458
|
-
|
|
42459
|
-
/**
|
|
42460
|
-
* Get a Development Activity
|
|
42461
|
-
*
|
|
42462
|
-
* @param {String} activityId Specifies the activity ID, maps to either assignment or appointment ID
|
|
42463
|
-
* @param {Object} type Specifies the activity type.
|
|
42464
|
-
*/
|
|
42465
|
-
getUsersDevelopmentActivity(activityId, type) {
|
|
42466
|
-
// verify the required parameter 'activityId' is set
|
|
42467
|
-
if (activityId === undefined || activityId === null) {
|
|
42468
|
-
throw 'Missing the required parameter "activityId" when calling getUsersDevelopmentActivity';
|
|
42469
|
-
}
|
|
42470
|
-
// verify the required parameter 'type' is set
|
|
42471
|
-
if (type === undefined || type === null) {
|
|
42472
|
-
throw 'Missing the required parameter "type" when calling getUsersDevelopmentActivity';
|
|
42473
|
-
}
|
|
42474
|
-
|
|
42475
|
-
return this.apiClient.callApi(
|
|
42476
|
-
'/api/v2/users/development/activities/{activityId}',
|
|
42477
|
-
'GET',
|
|
42478
|
-
{ 'activityId': activityId },
|
|
42479
|
-
{ 'type': type },
|
|
42480
|
-
{ },
|
|
42481
|
-
{ },
|
|
42482
|
-
null,
|
|
42483
|
-
['PureCloud OAuth'],
|
|
42484
|
-
['application/json'],
|
|
42485
|
-
['application/json']
|
|
42486
|
-
);
|
|
42487
|
-
}
|
|
42488
|
-
|
|
42489
|
-
/**
|
|
42490
|
-
* Retrieve aggregated development activity data
|
|
42491
|
-
* Results are filtered based on the applicable permissions.
|
|
42492
|
-
* @param {Object} body Aggregate Request
|
|
42493
|
-
*/
|
|
42494
|
-
postUsersDevelopmentActivitiesAggregatesQuery(body) {
|
|
42495
|
-
// verify the required parameter 'body' is set
|
|
42496
|
-
if (body === undefined || body === null) {
|
|
42497
|
-
throw 'Missing the required parameter "body" when calling postUsersDevelopmentActivitiesAggregatesQuery';
|
|
42498
|
-
}
|
|
42499
|
-
|
|
42500
|
-
return this.apiClient.callApi(
|
|
42501
|
-
'/api/v2/users/development/activities/aggregates/query',
|
|
42502
|
-
'POST',
|
|
42503
|
-
{ },
|
|
42504
|
-
{ },
|
|
42505
|
-
{ },
|
|
42506
|
-
{ },
|
|
42507
|
-
body,
|
|
42508
|
-
['PureCloud OAuth'],
|
|
42509
|
-
['application/json'],
|
|
42510
|
-
['application/json']
|
|
42511
|
-
);
|
|
42512
|
-
}
|
|
42513
|
-
|
|
42514
|
-
}
|
|
42515
|
-
|
|
42516
42393
|
class UserRecordingsApi {
|
|
42517
42394
|
/**
|
|
42518
42395
|
* UserRecordings service.
|
|
42519
42396
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
42520
|
-
* @version
|
|
42397
|
+
* @version 98.0.0
|
|
42521
42398
|
*/
|
|
42522
42399
|
|
|
42523
42400
|
/**
|
|
@@ -42701,7 +42578,7 @@ class UsersApi {
|
|
|
42701
42578
|
/**
|
|
42702
42579
|
* Users service.
|
|
42703
42580
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
42704
|
-
* @version
|
|
42581
|
+
* @version 98.0.0
|
|
42705
42582
|
*/
|
|
42706
42583
|
|
|
42707
42584
|
/**
|
|
@@ -43745,6 +43622,103 @@ class UsersApi {
|
|
|
43745
43622
|
);
|
|
43746
43623
|
}
|
|
43747
43624
|
|
|
43625
|
+
/**
|
|
43626
|
+
* Get list of Development Activities
|
|
43627
|
+
* Either moduleId or userId is required. Results are filtered based on the applicable permissions.
|
|
43628
|
+
* @param {Object} opts Optional parameters
|
|
43629
|
+
* @param {Array.<String>} opts.userId Specifies the list of user IDs to be queried, up to 100 user IDs. It searches for any relationship for the userId.
|
|
43630
|
+
* @param {String} opts.moduleId Specifies the ID of the learning module.
|
|
43631
|
+
* @param {String} opts.interval Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
43632
|
+
* @param {String} opts.completionInterval Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
43633
|
+
* @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
|
|
43634
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
43635
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
43636
|
+
* @param {Object} opts.sortOrder Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (default to Desc)
|
|
43637
|
+
* @param {Array.<String>} opts.types Specifies the activity types.
|
|
43638
|
+
* @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
|
|
43639
|
+
* @param {Array.<String>} opts.relationship Specifies how the current user relation should be interpreted, and filters the activities returned to only those that have the specified relationship. If not specified, all relationships are returned.
|
|
43640
|
+
*/
|
|
43641
|
+
getUsersDevelopmentActivities(opts) {
|
|
43642
|
+
opts = opts || {};
|
|
43643
|
+
|
|
43644
|
+
|
|
43645
|
+
return this.apiClient.callApi(
|
|
43646
|
+
'/api/v2/users/development/activities',
|
|
43647
|
+
'GET',
|
|
43648
|
+
{ },
|
|
43649
|
+
{ 'userId': this.apiClient.buildCollectionParam(opts['userId'], 'multi'),'moduleId': opts['moduleId'],'interval': opts['interval'],'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'relationship': this.apiClient.buildCollectionParam(opts['relationship'], 'multi') },
|
|
43650
|
+
{ },
|
|
43651
|
+
{ },
|
|
43652
|
+
null,
|
|
43653
|
+
['PureCloud OAuth'],
|
|
43654
|
+
['application/json'],
|
|
43655
|
+
['application/json']
|
|
43656
|
+
);
|
|
43657
|
+
}
|
|
43658
|
+
|
|
43659
|
+
/**
|
|
43660
|
+
* Get list of Development Activities for current user
|
|
43661
|
+
* Results are filtered based on the applicable permissions.
|
|
43662
|
+
* @param {Object} opts Optional parameters
|
|
43663
|
+
* @param {String} opts.moduleId Specifies the ID of the learning module.
|
|
43664
|
+
* @param {String} opts.interval Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
43665
|
+
* @param {String} opts.completionInterval Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
43666
|
+
* @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
|
|
43667
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
43668
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
43669
|
+
* @param {Object} opts.sortOrder Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (default to Desc)
|
|
43670
|
+
* @param {Array.<String>} opts.types Specifies the activity types.
|
|
43671
|
+
* @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
|
|
43672
|
+
* @param {Array.<String>} opts.relationship Specifies how the current user relation should be interpreted, and filters the activities returned to only those that have the specified relationship. If not specified, all relationships are returned.
|
|
43673
|
+
*/
|
|
43674
|
+
getUsersDevelopmentActivitiesMe(opts) {
|
|
43675
|
+
opts = opts || {};
|
|
43676
|
+
|
|
43677
|
+
|
|
43678
|
+
return this.apiClient.callApi(
|
|
43679
|
+
'/api/v2/users/development/activities/me',
|
|
43680
|
+
'GET',
|
|
43681
|
+
{ },
|
|
43682
|
+
{ 'moduleId': opts['moduleId'],'interval': opts['interval'],'completionInterval': opts['completionInterval'],'overdue': opts['overdue'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'relationship': this.apiClient.buildCollectionParam(opts['relationship'], 'multi') },
|
|
43683
|
+
{ },
|
|
43684
|
+
{ },
|
|
43685
|
+
null,
|
|
43686
|
+
['PureCloud OAuth'],
|
|
43687
|
+
['application/json'],
|
|
43688
|
+
['application/json']
|
|
43689
|
+
);
|
|
43690
|
+
}
|
|
43691
|
+
|
|
43692
|
+
/**
|
|
43693
|
+
* Get a Development Activity
|
|
43694
|
+
*
|
|
43695
|
+
* @param {String} activityId Specifies the activity ID, maps to either assignment or appointment ID
|
|
43696
|
+
* @param {Object} type Specifies the activity type.
|
|
43697
|
+
*/
|
|
43698
|
+
getUsersDevelopmentActivity(activityId, type) {
|
|
43699
|
+
// verify the required parameter 'activityId' is set
|
|
43700
|
+
if (activityId === undefined || activityId === null) {
|
|
43701
|
+
throw 'Missing the required parameter "activityId" when calling getUsersDevelopmentActivity';
|
|
43702
|
+
}
|
|
43703
|
+
// verify the required parameter 'type' is set
|
|
43704
|
+
if (type === undefined || type === null) {
|
|
43705
|
+
throw 'Missing the required parameter "type" when calling getUsersDevelopmentActivity';
|
|
43706
|
+
}
|
|
43707
|
+
|
|
43708
|
+
return this.apiClient.callApi(
|
|
43709
|
+
'/api/v2/users/development/activities/{activityId}',
|
|
43710
|
+
'GET',
|
|
43711
|
+
{ 'activityId': activityId },
|
|
43712
|
+
{ 'type': type },
|
|
43713
|
+
{ },
|
|
43714
|
+
{ },
|
|
43715
|
+
null,
|
|
43716
|
+
['PureCloud OAuth'],
|
|
43717
|
+
['application/json'],
|
|
43718
|
+
['application/json']
|
|
43719
|
+
);
|
|
43720
|
+
}
|
|
43721
|
+
|
|
43748
43722
|
/**
|
|
43749
43723
|
* Get current user details.
|
|
43750
43724
|
* This request is not valid when using the Client Credentials OAuth grant.
|
|
@@ -44431,6 +44405,31 @@ class UsersApi {
|
|
|
44431
44405
|
);
|
|
44432
44406
|
}
|
|
44433
44407
|
|
|
44408
|
+
/**
|
|
44409
|
+
* Retrieve aggregated development activity data
|
|
44410
|
+
* Results are filtered based on the applicable permissions.
|
|
44411
|
+
* @param {Object} body Aggregate Request
|
|
44412
|
+
*/
|
|
44413
|
+
postUsersDevelopmentActivitiesAggregatesQuery(body) {
|
|
44414
|
+
// verify the required parameter 'body' is set
|
|
44415
|
+
if (body === undefined || body === null) {
|
|
44416
|
+
throw 'Missing the required parameter "body" when calling postUsersDevelopmentActivitiesAggregatesQuery';
|
|
44417
|
+
}
|
|
44418
|
+
|
|
44419
|
+
return this.apiClient.callApi(
|
|
44420
|
+
'/api/v2/users/development/activities/aggregates/query',
|
|
44421
|
+
'POST',
|
|
44422
|
+
{ },
|
|
44423
|
+
{ },
|
|
44424
|
+
{ },
|
|
44425
|
+
{ },
|
|
44426
|
+
body,
|
|
44427
|
+
['PureCloud OAuth'],
|
|
44428
|
+
['application/json'],
|
|
44429
|
+
['application/json']
|
|
44430
|
+
);
|
|
44431
|
+
}
|
|
44432
|
+
|
|
44434
44433
|
/**
|
|
44435
44434
|
* Change your password
|
|
44436
44435
|
*
|
|
@@ -44792,7 +44791,7 @@ class UtilitiesApi {
|
|
|
44792
44791
|
/**
|
|
44793
44792
|
* Utilities service.
|
|
44794
44793
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
44795
|
-
* @version
|
|
44794
|
+
* @version 98.0.0
|
|
44796
44795
|
*/
|
|
44797
44796
|
|
|
44798
44797
|
/**
|
|
@@ -44903,7 +44902,7 @@ class VoicemailApi {
|
|
|
44903
44902
|
/**
|
|
44904
44903
|
* Voicemail service.
|
|
44905
44904
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
44906
|
-
* @version
|
|
44905
|
+
* @version 98.0.0
|
|
44907
44906
|
*/
|
|
44908
44907
|
|
|
44909
44908
|
/**
|
|
@@ -45540,7 +45539,7 @@ class WebChatApi {
|
|
|
45540
45539
|
/**
|
|
45541
45540
|
* WebChat service.
|
|
45542
45541
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
45543
|
-
* @version
|
|
45542
|
+
* @version 98.0.0
|
|
45544
45543
|
*/
|
|
45545
45544
|
|
|
45546
45545
|
/**
|
|
@@ -46084,7 +46083,7 @@ class WidgetsApi {
|
|
|
46084
46083
|
/**
|
|
46085
46084
|
* Widgets service.
|
|
46086
46085
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
46087
|
-
* @version
|
|
46086
|
+
* @version 98.0.0
|
|
46088
46087
|
*/
|
|
46089
46088
|
|
|
46090
46089
|
/**
|
|
@@ -46230,7 +46229,7 @@ class WorkforceManagementApi {
|
|
|
46230
46229
|
/**
|
|
46231
46230
|
* WorkforceManagement service.
|
|
46232
46231
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
46233
|
-
* @version
|
|
46232
|
+
* @version 98.0.0
|
|
46234
46233
|
*/
|
|
46235
46234
|
|
|
46236
46235
|
/**
|
|
@@ -46486,155 +46485,25 @@ class WorkforceManagementApi {
|
|
|
46486
46485
|
}
|
|
46487
46486
|
|
|
46488
46487
|
/**
|
|
46489
|
-
*
|
|
46490
|
-
*
|
|
46491
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
46492
|
-
* @param {String} acId The ID of the activity code to delete
|
|
46493
|
-
*/
|
|
46494
|
-
deleteWorkforcemanagementManagementunitActivitycode(muId, acId) {
|
|
46495
|
-
// verify the required parameter 'muId' is set
|
|
46496
|
-
if (muId === undefined || muId === null) {
|
|
46497
|
-
throw 'Missing the required parameter "muId" when calling deleteWorkforcemanagementManagementunitActivitycode';
|
|
46498
|
-
}
|
|
46499
|
-
// verify the required parameter 'acId' is set
|
|
46500
|
-
if (acId === undefined || acId === null) {
|
|
46501
|
-
throw 'Missing the required parameter "acId" when calling deleteWorkforcemanagementManagementunitActivitycode';
|
|
46502
|
-
}
|
|
46503
|
-
|
|
46504
|
-
return this.apiClient.callApi(
|
|
46505
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}',
|
|
46506
|
-
'DELETE',
|
|
46507
|
-
{ 'muId': muId,'acId': acId },
|
|
46508
|
-
{ },
|
|
46509
|
-
{ },
|
|
46510
|
-
{ },
|
|
46511
|
-
null,
|
|
46512
|
-
['PureCloud OAuth'],
|
|
46513
|
-
['application/json'],
|
|
46514
|
-
['application/json']
|
|
46515
|
-
);
|
|
46516
|
-
}
|
|
46517
|
-
|
|
46518
|
-
/**
|
|
46519
|
-
* Gone. Scheduling has moved under business units
|
|
46520
|
-
*
|
|
46521
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
|
|
46522
|
-
* @param {String} runId The ID of the schedule run
|
|
46523
|
-
*/
|
|
46524
|
-
deleteWorkforcemanagementManagementunitSchedulingRun(managementUnitId, runId) {
|
|
46525
|
-
// verify the required parameter 'managementUnitId' is set
|
|
46526
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
46527
|
-
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitSchedulingRun';
|
|
46528
|
-
}
|
|
46529
|
-
// verify the required parameter 'runId' is set
|
|
46530
|
-
if (runId === undefined || runId === null) {
|
|
46531
|
-
throw 'Missing the required parameter "runId" when calling deleteWorkforcemanagementManagementunitSchedulingRun';
|
|
46532
|
-
}
|
|
46533
|
-
|
|
46534
|
-
return this.apiClient.callApi(
|
|
46535
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}',
|
|
46536
|
-
'DELETE',
|
|
46537
|
-
{ 'managementUnitId': managementUnitId,'runId': runId },
|
|
46538
|
-
{ },
|
|
46539
|
-
{ },
|
|
46540
|
-
{ },
|
|
46541
|
-
null,
|
|
46542
|
-
['PureCloud OAuth'],
|
|
46543
|
-
['application/json'],
|
|
46544
|
-
['application/json']
|
|
46545
|
-
);
|
|
46546
|
-
}
|
|
46547
|
-
|
|
46548
|
-
/**
|
|
46549
|
-
* Gone. Replaced with service goal templates and planning groups under business units
|
|
46550
|
-
*
|
|
46551
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
46552
|
-
* @param {String} serviceGoalGroupId Gone. The ID of the service goal group to delete
|
|
46553
|
-
*/
|
|
46554
|
-
deleteWorkforcemanagementManagementunitServicegoalgroup(managementUnitId, serviceGoalGroupId) {
|
|
46555
|
-
// verify the required parameter 'managementUnitId' is set
|
|
46556
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
46557
|
-
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitServicegoalgroup';
|
|
46558
|
-
}
|
|
46559
|
-
// verify the required parameter 'serviceGoalGroupId' is set
|
|
46560
|
-
if (serviceGoalGroupId === undefined || serviceGoalGroupId === null) {
|
|
46561
|
-
throw 'Missing the required parameter "serviceGoalGroupId" when calling deleteWorkforcemanagementManagementunitServicegoalgroup';
|
|
46562
|
-
}
|
|
46563
|
-
|
|
46564
|
-
return this.apiClient.callApi(
|
|
46565
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}',
|
|
46566
|
-
'DELETE',
|
|
46567
|
-
{ 'managementUnitId': managementUnitId,'serviceGoalGroupId': serviceGoalGroupId },
|
|
46568
|
-
{ },
|
|
46569
|
-
{ },
|
|
46570
|
-
{ },
|
|
46571
|
-
null,
|
|
46572
|
-
['PureCloud OAuth'],
|
|
46573
|
-
['application/json'],
|
|
46574
|
-
['application/json']
|
|
46575
|
-
);
|
|
46576
|
-
}
|
|
46577
|
-
|
|
46578
|
-
/**
|
|
46579
|
-
* Gone. Scheduling has moved under business units
|
|
46488
|
+
* Delete a work plan
|
|
46580
46489
|
*
|
|
46581
46490
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
46582
|
-
* @param {String}
|
|
46583
|
-
* @param {String} scheduleId Gone/deprecated. The ID of the schedule to delete
|
|
46584
|
-
*/
|
|
46585
|
-
deleteWorkforcemanagementManagementunitWeekSchedule(managementUnitId, weekId, scheduleId) {
|
|
46586
|
-
// verify the required parameter 'managementUnitId' is set
|
|
46587
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
46588
|
-
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWeekSchedule';
|
|
46589
|
-
}
|
|
46590
|
-
// verify the required parameter 'weekId' is set
|
|
46591
|
-
if (weekId === undefined || weekId === null) {
|
|
46592
|
-
throw 'Missing the required parameter "weekId" when calling deleteWorkforcemanagementManagementunitWeekSchedule';
|
|
46593
|
-
}
|
|
46594
|
-
// verify the required parameter 'scheduleId' is set
|
|
46595
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
46596
|
-
throw 'Missing the required parameter "scheduleId" when calling deleteWorkforcemanagementManagementunitWeekSchedule';
|
|
46597
|
-
}
|
|
46598
|
-
|
|
46599
|
-
return this.apiClient.callApi(
|
|
46600
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}',
|
|
46601
|
-
'DELETE',
|
|
46602
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
46603
|
-
{ },
|
|
46604
|
-
{ },
|
|
46605
|
-
{ },
|
|
46606
|
-
null,
|
|
46607
|
-
['PureCloud OAuth'],
|
|
46608
|
-
['application/json'],
|
|
46609
|
-
['application/json']
|
|
46610
|
-
);
|
|
46611
|
-
}
|
|
46612
|
-
|
|
46613
|
-
/**
|
|
46614
|
-
* Gone. Use equivalent business unit resource instead
|
|
46615
|
-
*
|
|
46616
|
-
* @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
|
|
46617
|
-
* @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
|
|
46618
|
-
* @param {String} forecastId (Gone/Deprecated): The ID of the forecast
|
|
46491
|
+
* @param {String} workPlanId The ID of the work plan to delete
|
|
46619
46492
|
*/
|
|
46620
|
-
|
|
46493
|
+
deleteWorkforcemanagementManagementunitWorkplan(managementUnitId, workPlanId) {
|
|
46621
46494
|
// verify the required parameter 'managementUnitId' is set
|
|
46622
46495
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
46623
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
46624
|
-
}
|
|
46625
|
-
// verify the required parameter 'weekDateId' is set
|
|
46626
|
-
if (weekDateId === undefined || weekDateId === null) {
|
|
46627
|
-
throw 'Missing the required parameter "weekDateId" when calling deleteWorkforcemanagementManagementunitWeekShorttermforecast';
|
|
46496
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWorkplan';
|
|
46628
46497
|
}
|
|
46629
|
-
// verify the required parameter '
|
|
46630
|
-
if (
|
|
46631
|
-
throw 'Missing the required parameter "
|
|
46498
|
+
// verify the required parameter 'workPlanId' is set
|
|
46499
|
+
if (workPlanId === undefined || workPlanId === null) {
|
|
46500
|
+
throw 'Missing the required parameter "workPlanId" when calling deleteWorkforcemanagementManagementunitWorkplan';
|
|
46632
46501
|
}
|
|
46633
46502
|
|
|
46634
46503
|
return this.apiClient.callApi(
|
|
46635
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
46504
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}',
|
|
46636
46505
|
'DELETE',
|
|
46637
|
-
{ 'managementUnitId': managementUnitId,'
|
|
46506
|
+
{ 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
|
|
46638
46507
|
{ },
|
|
46639
46508
|
{ },
|
|
46640
46509
|
{ },
|
|
@@ -46646,25 +46515,25 @@ class WorkforceManagementApi {
|
|
|
46646
46515
|
}
|
|
46647
46516
|
|
|
46648
46517
|
/**
|
|
46649
|
-
* Delete a work plan
|
|
46518
|
+
* Delete a work plan rotation
|
|
46650
46519
|
*
|
|
46651
46520
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
46652
|
-
* @param {String}
|
|
46521
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to be deleted
|
|
46653
46522
|
*/
|
|
46654
|
-
|
|
46523
|
+
deleteWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId) {
|
|
46655
46524
|
// verify the required parameter 'managementUnitId' is set
|
|
46656
46525
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
46657
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
46526
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWorkplanrotation';
|
|
46658
46527
|
}
|
|
46659
|
-
// verify the required parameter '
|
|
46660
|
-
if (
|
|
46661
|
-
throw 'Missing the required parameter "
|
|
46528
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
46529
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
46530
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling deleteWorkforcemanagementManagementunitWorkplanrotation';
|
|
46662
46531
|
}
|
|
46663
46532
|
|
|
46664
46533
|
return this.apiClient.callApi(
|
|
46665
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
46534
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
|
|
46666
46535
|
'DELETE',
|
|
46667
|
-
{ 'managementUnitId': managementUnitId,'
|
|
46536
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
46668
46537
|
{ },
|
|
46669
46538
|
{ },
|
|
46670
46539
|
{ },
|
|
@@ -47479,36 +47348,6 @@ class WorkforceManagementApi {
|
|
|
47479
47348
|
);
|
|
47480
47349
|
}
|
|
47481
47350
|
|
|
47482
|
-
/**
|
|
47483
|
-
* Get an activity code
|
|
47484
|
-
*
|
|
47485
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
47486
|
-
* @param {String} acId The ID of the activity code to fetch
|
|
47487
|
-
*/
|
|
47488
|
-
getWorkforcemanagementManagementunitActivitycode(muId, acId) {
|
|
47489
|
-
// verify the required parameter 'muId' is set
|
|
47490
|
-
if (muId === undefined || muId === null) {
|
|
47491
|
-
throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitActivitycode';
|
|
47492
|
-
}
|
|
47493
|
-
// verify the required parameter 'acId' is set
|
|
47494
|
-
if (acId === undefined || acId === null) {
|
|
47495
|
-
throw 'Missing the required parameter "acId" when calling getWorkforcemanagementManagementunitActivitycode';
|
|
47496
|
-
}
|
|
47497
|
-
|
|
47498
|
-
return this.apiClient.callApi(
|
|
47499
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}',
|
|
47500
|
-
'GET',
|
|
47501
|
-
{ 'muId': muId,'acId': acId },
|
|
47502
|
-
{ },
|
|
47503
|
-
{ },
|
|
47504
|
-
{ },
|
|
47505
|
-
null,
|
|
47506
|
-
['PureCloud OAuth'],
|
|
47507
|
-
['application/json'],
|
|
47508
|
-
['application/json']
|
|
47509
|
-
);
|
|
47510
|
-
}
|
|
47511
|
-
|
|
47512
47351
|
/**
|
|
47513
47352
|
* Get activity codes
|
|
47514
47353
|
*
|
|
@@ -47627,196 +47466,6 @@ class WorkforceManagementApi {
|
|
|
47627
47466
|
);
|
|
47628
47467
|
}
|
|
47629
47468
|
|
|
47630
|
-
/**
|
|
47631
|
-
* Gone. Moved under business units
|
|
47632
|
-
*
|
|
47633
|
-
* @param {String} muId The management unit ID of the management unit
|
|
47634
|
-
*/
|
|
47635
|
-
getWorkforcemanagementManagementunitIntradayQueues(muId) {
|
|
47636
|
-
// verify the required parameter 'muId' is set
|
|
47637
|
-
if (muId === undefined || muId === null) {
|
|
47638
|
-
throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitIntradayQueues';
|
|
47639
|
-
}
|
|
47640
|
-
|
|
47641
|
-
return this.apiClient.callApi(
|
|
47642
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/intraday/queues',
|
|
47643
|
-
'GET',
|
|
47644
|
-
{ 'muId': muId },
|
|
47645
|
-
{ },
|
|
47646
|
-
{ },
|
|
47647
|
-
{ },
|
|
47648
|
-
null,
|
|
47649
|
-
['PureCloud OAuth'],
|
|
47650
|
-
['application/json'],
|
|
47651
|
-
['application/json']
|
|
47652
|
-
);
|
|
47653
|
-
}
|
|
47654
|
-
|
|
47655
|
-
/**
|
|
47656
|
-
* Gone. Scheduling has moved under business units
|
|
47657
|
-
*
|
|
47658
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
|
|
47659
|
-
* @param {String} runId The ID of the schedule run
|
|
47660
|
-
*/
|
|
47661
|
-
getWorkforcemanagementManagementunitSchedulingRun(managementUnitId, runId) {
|
|
47662
|
-
// verify the required parameter 'managementUnitId' is set
|
|
47663
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
47664
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitSchedulingRun';
|
|
47665
|
-
}
|
|
47666
|
-
// verify the required parameter 'runId' is set
|
|
47667
|
-
if (runId === undefined || runId === null) {
|
|
47668
|
-
throw 'Missing the required parameter "runId" when calling getWorkforcemanagementManagementunitSchedulingRun';
|
|
47669
|
-
}
|
|
47670
|
-
|
|
47671
|
-
return this.apiClient.callApi(
|
|
47672
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}',
|
|
47673
|
-
'GET',
|
|
47674
|
-
{ 'managementUnitId': managementUnitId,'runId': runId },
|
|
47675
|
-
{ },
|
|
47676
|
-
{ },
|
|
47677
|
-
{ },
|
|
47678
|
-
null,
|
|
47679
|
-
['PureCloud OAuth'],
|
|
47680
|
-
['application/json'],
|
|
47681
|
-
['application/json']
|
|
47682
|
-
);
|
|
47683
|
-
}
|
|
47684
|
-
|
|
47685
|
-
/**
|
|
47686
|
-
* Gone. Scheduling has moved under business units
|
|
47687
|
-
*
|
|
47688
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
|
|
47689
|
-
* @param {String} runId The ID of the schedule run
|
|
47690
|
-
*/
|
|
47691
|
-
getWorkforcemanagementManagementunitSchedulingRunResult(managementUnitId, runId) {
|
|
47692
|
-
// verify the required parameter 'managementUnitId' is set
|
|
47693
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
47694
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitSchedulingRunResult';
|
|
47695
|
-
}
|
|
47696
|
-
// verify the required parameter 'runId' is set
|
|
47697
|
-
if (runId === undefined || runId === null) {
|
|
47698
|
-
throw 'Missing the required parameter "runId" when calling getWorkforcemanagementManagementunitSchedulingRunResult';
|
|
47699
|
-
}
|
|
47700
|
-
|
|
47701
|
-
return this.apiClient.callApi(
|
|
47702
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}/result',
|
|
47703
|
-
'GET',
|
|
47704
|
-
{ 'managementUnitId': managementUnitId,'runId': runId },
|
|
47705
|
-
{ },
|
|
47706
|
-
{ },
|
|
47707
|
-
{ },
|
|
47708
|
-
null,
|
|
47709
|
-
['PureCloud OAuth'],
|
|
47710
|
-
['application/json'],
|
|
47711
|
-
['application/json']
|
|
47712
|
-
);
|
|
47713
|
-
}
|
|
47714
|
-
|
|
47715
|
-
/**
|
|
47716
|
-
* Gone. Scheduling has moved under business units
|
|
47717
|
-
*
|
|
47718
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
|
|
47719
|
-
*/
|
|
47720
|
-
getWorkforcemanagementManagementunitSchedulingRuns(managementUnitId) {
|
|
47721
|
-
// verify the required parameter 'managementUnitId' is set
|
|
47722
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
47723
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitSchedulingRuns';
|
|
47724
|
-
}
|
|
47725
|
-
|
|
47726
|
-
return this.apiClient.callApi(
|
|
47727
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs',
|
|
47728
|
-
'GET',
|
|
47729
|
-
{ 'managementUnitId': managementUnitId },
|
|
47730
|
-
{ },
|
|
47731
|
-
{ },
|
|
47732
|
-
{ },
|
|
47733
|
-
null,
|
|
47734
|
-
['PureCloud OAuth'],
|
|
47735
|
-
['application/json'],
|
|
47736
|
-
['application/json']
|
|
47737
|
-
);
|
|
47738
|
-
}
|
|
47739
|
-
|
|
47740
|
-
/**
|
|
47741
|
-
* Gone. Replaced with service goal templates and planning groups under business units
|
|
47742
|
-
*
|
|
47743
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
47744
|
-
* @param {String} serviceGoalGroupId Gone. The ID of the service goal group to fetch
|
|
47745
|
-
*/
|
|
47746
|
-
getWorkforcemanagementManagementunitServicegoalgroup(managementUnitId, serviceGoalGroupId) {
|
|
47747
|
-
// verify the required parameter 'managementUnitId' is set
|
|
47748
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
47749
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitServicegoalgroup';
|
|
47750
|
-
}
|
|
47751
|
-
// verify the required parameter 'serviceGoalGroupId' is set
|
|
47752
|
-
if (serviceGoalGroupId === undefined || serviceGoalGroupId === null) {
|
|
47753
|
-
throw 'Missing the required parameter "serviceGoalGroupId" when calling getWorkforcemanagementManagementunitServicegoalgroup';
|
|
47754
|
-
}
|
|
47755
|
-
|
|
47756
|
-
return this.apiClient.callApi(
|
|
47757
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}',
|
|
47758
|
-
'GET',
|
|
47759
|
-
{ 'managementUnitId': managementUnitId,'serviceGoalGroupId': serviceGoalGroupId },
|
|
47760
|
-
{ },
|
|
47761
|
-
{ },
|
|
47762
|
-
{ },
|
|
47763
|
-
null,
|
|
47764
|
-
['PureCloud OAuth'],
|
|
47765
|
-
['application/json'],
|
|
47766
|
-
['application/json']
|
|
47767
|
-
);
|
|
47768
|
-
}
|
|
47769
|
-
|
|
47770
|
-
/**
|
|
47771
|
-
* Gone. Replaced with service goal templates and planning groups under business units
|
|
47772
|
-
*
|
|
47773
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
47774
|
-
*/
|
|
47775
|
-
getWorkforcemanagementManagementunitServicegoalgroups(managementUnitId) {
|
|
47776
|
-
// verify the required parameter 'managementUnitId' is set
|
|
47777
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
47778
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitServicegoalgroups';
|
|
47779
|
-
}
|
|
47780
|
-
|
|
47781
|
-
return this.apiClient.callApi(
|
|
47782
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups',
|
|
47783
|
-
'GET',
|
|
47784
|
-
{ 'managementUnitId': managementUnitId },
|
|
47785
|
-
{ },
|
|
47786
|
-
{ },
|
|
47787
|
-
{ },
|
|
47788
|
-
null,
|
|
47789
|
-
['PureCloud OAuth'],
|
|
47790
|
-
['application/json'],
|
|
47791
|
-
['application/json']
|
|
47792
|
-
);
|
|
47793
|
-
}
|
|
47794
|
-
|
|
47795
|
-
/**
|
|
47796
|
-
* Gone. Get management unit settings via expand parameters on the GET management unit
|
|
47797
|
-
*
|
|
47798
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
47799
|
-
*/
|
|
47800
|
-
getWorkforcemanagementManagementunitSettings(muId) {
|
|
47801
|
-
// verify the required parameter 'muId' is set
|
|
47802
|
-
if (muId === undefined || muId === null) {
|
|
47803
|
-
throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitSettings';
|
|
47804
|
-
}
|
|
47805
|
-
|
|
47806
|
-
return this.apiClient.callApi(
|
|
47807
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/settings',
|
|
47808
|
-
'GET',
|
|
47809
|
-
{ 'muId': muId },
|
|
47810
|
-
{ },
|
|
47811
|
-
{ },
|
|
47812
|
-
{ },
|
|
47813
|
-
null,
|
|
47814
|
-
['PureCloud OAuth'],
|
|
47815
|
-
['application/json'],
|
|
47816
|
-
['application/json']
|
|
47817
|
-
);
|
|
47818
|
-
}
|
|
47819
|
-
|
|
47820
47469
|
/**
|
|
47821
47470
|
* Gets a summary of all shift trades in the matched state
|
|
47822
47471
|
*
|
|
@@ -48001,41 +47650,6 @@ class WorkforceManagementApi {
|
|
|
48001
47650
|
);
|
|
48002
47651
|
}
|
|
48003
47652
|
|
|
48004
|
-
/**
|
|
48005
|
-
* Gone. Scheduling has moved under business units
|
|
48006
|
-
*
|
|
48007
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
48008
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
48009
|
-
* @param {String} scheduleId Gone/deprecated. The ID of the schedule to fetch generation results
|
|
48010
|
-
*/
|
|
48011
|
-
getWorkforcemanagementManagementunitWeekScheduleGenerationresults(managementUnitId, weekId, scheduleId) {
|
|
48012
|
-
// verify the required parameter 'managementUnitId' is set
|
|
48013
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
48014
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekScheduleGenerationresults';
|
|
48015
|
-
}
|
|
48016
|
-
// verify the required parameter 'weekId' is set
|
|
48017
|
-
if (weekId === undefined || weekId === null) {
|
|
48018
|
-
throw 'Missing the required parameter "weekId" when calling getWorkforcemanagementManagementunitWeekScheduleGenerationresults';
|
|
48019
|
-
}
|
|
48020
|
-
// verify the required parameter 'scheduleId' is set
|
|
48021
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
48022
|
-
throw 'Missing the required parameter "scheduleId" when calling getWorkforcemanagementManagementunitWeekScheduleGenerationresults';
|
|
48023
|
-
}
|
|
48024
|
-
|
|
48025
|
-
return this.apiClient.callApi(
|
|
48026
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/generationresults',
|
|
48027
|
-
'GET',
|
|
48028
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
48029
|
-
{ },
|
|
48030
|
-
{ },
|
|
48031
|
-
{ },
|
|
48032
|
-
null,
|
|
48033
|
-
['PureCloud OAuth'],
|
|
48034
|
-
['application/json'],
|
|
48035
|
-
['application/json']
|
|
48036
|
-
);
|
|
48037
|
-
}
|
|
48038
|
-
|
|
48039
47653
|
/**
|
|
48040
47654
|
* Deprecated. Use the equivalent business unit resource instead. Get the list of schedules in a week in management unit
|
|
48041
47655
|
*
|
|
@@ -48106,71 +47720,6 @@ class WorkforceManagementApi {
|
|
|
48106
47720
|
);
|
|
48107
47721
|
}
|
|
48108
47722
|
|
|
48109
|
-
/**
|
|
48110
|
-
* Gone. Use equivalent business unit resource instead
|
|
48111
|
-
*
|
|
48112
|
-
* @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
|
|
48113
|
-
* @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
|
|
48114
|
-
* @param {String} forecastId (Gone/Deprecated): The ID of the forecast
|
|
48115
|
-
*/
|
|
48116
|
-
getWorkforcemanagementManagementunitWeekShorttermforecastFinal(managementUnitId, weekDateId, forecastId) {
|
|
48117
|
-
// verify the required parameter 'managementUnitId' is set
|
|
48118
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
48119
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekShorttermforecastFinal';
|
|
48120
|
-
}
|
|
48121
|
-
// verify the required parameter 'weekDateId' is set
|
|
48122
|
-
if (weekDateId === undefined || weekDateId === null) {
|
|
48123
|
-
throw 'Missing the required parameter "weekDateId" when calling getWorkforcemanagementManagementunitWeekShorttermforecastFinal';
|
|
48124
|
-
}
|
|
48125
|
-
// verify the required parameter 'forecastId' is set
|
|
48126
|
-
if (forecastId === undefined || forecastId === null) {
|
|
48127
|
-
throw 'Missing the required parameter "forecastId" when calling getWorkforcemanagementManagementunitWeekShorttermforecastFinal';
|
|
48128
|
-
}
|
|
48129
|
-
|
|
48130
|
-
return this.apiClient.callApi(
|
|
48131
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/final',
|
|
48132
|
-
'GET',
|
|
48133
|
-
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
|
|
48134
|
-
{ },
|
|
48135
|
-
{ },
|
|
48136
|
-
{ },
|
|
48137
|
-
null,
|
|
48138
|
-
['PureCloud OAuth'],
|
|
48139
|
-
['application/json'],
|
|
48140
|
-
['application/json']
|
|
48141
|
-
);
|
|
48142
|
-
}
|
|
48143
|
-
|
|
48144
|
-
/**
|
|
48145
|
-
* Gone. Use equivalent business unit resource instead
|
|
48146
|
-
*
|
|
48147
|
-
* @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
|
|
48148
|
-
* @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
|
|
48149
|
-
*/
|
|
48150
|
-
getWorkforcemanagementManagementunitWeekShorttermforecasts(managementUnitId, weekDateId) {
|
|
48151
|
-
// verify the required parameter 'managementUnitId' is set
|
|
48152
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
48153
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekShorttermforecasts';
|
|
48154
|
-
}
|
|
48155
|
-
// verify the required parameter 'weekDateId' is set
|
|
48156
|
-
if (weekDateId === undefined || weekDateId === null) {
|
|
48157
|
-
throw 'Missing the required parameter "weekDateId" when calling getWorkforcemanagementManagementunitWeekShorttermforecasts';
|
|
48158
|
-
}
|
|
48159
|
-
|
|
48160
|
-
return this.apiClient.callApi(
|
|
48161
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts',
|
|
48162
|
-
'GET',
|
|
48163
|
-
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
|
|
48164
|
-
{ },
|
|
48165
|
-
{ },
|
|
48166
|
-
{ },
|
|
48167
|
-
null,
|
|
48168
|
-
['PureCloud OAuth'],
|
|
48169
|
-
['application/json'],
|
|
48170
|
-
['application/json']
|
|
48171
|
-
);
|
|
48172
|
-
}
|
|
48173
|
-
|
|
48174
47723
|
/**
|
|
48175
47724
|
* Get a work plan
|
|
48176
47725
|
*
|
|
@@ -48201,6 +47750,65 @@ class WorkforceManagementApi {
|
|
|
48201
47750
|
);
|
|
48202
47751
|
}
|
|
48203
47752
|
|
|
47753
|
+
/**
|
|
47754
|
+
* Get a work plan rotation
|
|
47755
|
+
*
|
|
47756
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
47757
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to fetch
|
|
47758
|
+
*/
|
|
47759
|
+
getWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId) {
|
|
47760
|
+
// verify the required parameter 'managementUnitId' is set
|
|
47761
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
47762
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplanrotation';
|
|
47763
|
+
}
|
|
47764
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
47765
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
47766
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling getWorkforcemanagementManagementunitWorkplanrotation';
|
|
47767
|
+
}
|
|
47768
|
+
|
|
47769
|
+
return this.apiClient.callApi(
|
|
47770
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
|
|
47771
|
+
'GET',
|
|
47772
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
47773
|
+
{ },
|
|
47774
|
+
{ },
|
|
47775
|
+
{ },
|
|
47776
|
+
null,
|
|
47777
|
+
['PureCloud OAuth'],
|
|
47778
|
+
['application/json'],
|
|
47779
|
+
['application/json']
|
|
47780
|
+
);
|
|
47781
|
+
}
|
|
47782
|
+
|
|
47783
|
+
/**
|
|
47784
|
+
* Get work plan rotations
|
|
47785
|
+
*
|
|
47786
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
47787
|
+
* @param {Object} opts Optional parameters
|
|
47788
|
+
* @param {Array.<String>} opts.expand
|
|
47789
|
+
*/
|
|
47790
|
+
getWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, opts) {
|
|
47791
|
+
opts = opts || {};
|
|
47792
|
+
|
|
47793
|
+
// verify the required parameter 'managementUnitId' is set
|
|
47794
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
47795
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplanrotations';
|
|
47796
|
+
}
|
|
47797
|
+
|
|
47798
|
+
return this.apiClient.callApi(
|
|
47799
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
|
|
47800
|
+
'GET',
|
|
47801
|
+
{ 'managementUnitId': managementUnitId },
|
|
47802
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
47803
|
+
{ },
|
|
47804
|
+
{ },
|
|
47805
|
+
null,
|
|
47806
|
+
['PureCloud OAuth'],
|
|
47807
|
+
['application/json'],
|
|
47808
|
+
['application/json']
|
|
47809
|
+
);
|
|
47810
|
+
}
|
|
47811
|
+
|
|
48204
47812
|
/**
|
|
48205
47813
|
* Get work plans
|
|
48206
47814
|
*
|
|
@@ -48590,129 +48198,6 @@ class WorkforceManagementApi {
|
|
|
48590
48198
|
);
|
|
48591
48199
|
}
|
|
48592
48200
|
|
|
48593
|
-
/**
|
|
48594
|
-
* Deprecated/Gone: Use the new business unit activity code resources
|
|
48595
|
-
*
|
|
48596
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
48597
|
-
* @param {String} acId The ID of the activity code to update
|
|
48598
|
-
* @param {Object} opts Optional parameters
|
|
48599
|
-
* @param {Object} opts.body body
|
|
48600
|
-
*/
|
|
48601
|
-
patchWorkforcemanagementManagementunitActivitycode(muId, acId, opts) {
|
|
48602
|
-
opts = opts || {};
|
|
48603
|
-
|
|
48604
|
-
// verify the required parameter 'muId' is set
|
|
48605
|
-
if (muId === undefined || muId === null) {
|
|
48606
|
-
throw 'Missing the required parameter "muId" when calling patchWorkforcemanagementManagementunitActivitycode';
|
|
48607
|
-
}
|
|
48608
|
-
// verify the required parameter 'acId' is set
|
|
48609
|
-
if (acId === undefined || acId === null) {
|
|
48610
|
-
throw 'Missing the required parameter "acId" when calling patchWorkforcemanagementManagementunitActivitycode';
|
|
48611
|
-
}
|
|
48612
|
-
|
|
48613
|
-
return this.apiClient.callApi(
|
|
48614
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}',
|
|
48615
|
-
'PATCH',
|
|
48616
|
-
{ 'muId': muId,'acId': acId },
|
|
48617
|
-
{ },
|
|
48618
|
-
{ },
|
|
48619
|
-
{ },
|
|
48620
|
-
opts['body'],
|
|
48621
|
-
['PureCloud OAuth'],
|
|
48622
|
-
['application/json'],
|
|
48623
|
-
['application/json']
|
|
48624
|
-
);
|
|
48625
|
-
}
|
|
48626
|
-
|
|
48627
|
-
/**
|
|
48628
|
-
* Gone. Scheduling has moved under business units
|
|
48629
|
-
*
|
|
48630
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
|
|
48631
|
-
* @param {String} runId The ID of the schedule run
|
|
48632
|
-
* @param {Object} opts Optional parameters
|
|
48633
|
-
* @param {Object} opts.body body
|
|
48634
|
-
*/
|
|
48635
|
-
patchWorkforcemanagementManagementunitSchedulingRun(managementUnitId, runId, opts) {
|
|
48636
|
-
opts = opts || {};
|
|
48637
|
-
|
|
48638
|
-
// verify the required parameter 'managementUnitId' is set
|
|
48639
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
48640
|
-
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitSchedulingRun';
|
|
48641
|
-
}
|
|
48642
|
-
// verify the required parameter 'runId' is set
|
|
48643
|
-
if (runId === undefined || runId === null) {
|
|
48644
|
-
throw 'Missing the required parameter "runId" when calling patchWorkforcemanagementManagementunitSchedulingRun';
|
|
48645
|
-
}
|
|
48646
|
-
|
|
48647
|
-
return this.apiClient.callApi(
|
|
48648
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}',
|
|
48649
|
-
'PATCH',
|
|
48650
|
-
{ 'managementUnitId': managementUnitId,'runId': runId },
|
|
48651
|
-
{ },
|
|
48652
|
-
{ },
|
|
48653
|
-
{ },
|
|
48654
|
-
opts['body'],
|
|
48655
|
-
['PureCloud OAuth'],
|
|
48656
|
-
['application/json'],
|
|
48657
|
-
['application/json']
|
|
48658
|
-
);
|
|
48659
|
-
}
|
|
48660
|
-
|
|
48661
|
-
/**
|
|
48662
|
-
* Gone. Replaced with service goal templates and planning groups under business units
|
|
48663
|
-
*
|
|
48664
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
48665
|
-
* @param {String} serviceGoalGroupId Gone. The ID of the service goal group to update
|
|
48666
|
-
*/
|
|
48667
|
-
patchWorkforcemanagementManagementunitServicegoalgroup(managementUnitId, serviceGoalGroupId) {
|
|
48668
|
-
// verify the required parameter 'managementUnitId' is set
|
|
48669
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
48670
|
-
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitServicegoalgroup';
|
|
48671
|
-
}
|
|
48672
|
-
// verify the required parameter 'serviceGoalGroupId' is set
|
|
48673
|
-
if (serviceGoalGroupId === undefined || serviceGoalGroupId === null) {
|
|
48674
|
-
throw 'Missing the required parameter "serviceGoalGroupId" when calling patchWorkforcemanagementManagementunitServicegoalgroup';
|
|
48675
|
-
}
|
|
48676
|
-
|
|
48677
|
-
return this.apiClient.callApi(
|
|
48678
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}',
|
|
48679
|
-
'PATCH',
|
|
48680
|
-
{ 'managementUnitId': managementUnitId,'serviceGoalGroupId': serviceGoalGroupId },
|
|
48681
|
-
{ },
|
|
48682
|
-
{ },
|
|
48683
|
-
{ },
|
|
48684
|
-
null,
|
|
48685
|
-
['PureCloud OAuth'],
|
|
48686
|
-
['application/json'],
|
|
48687
|
-
['application/json']
|
|
48688
|
-
);
|
|
48689
|
-
}
|
|
48690
|
-
|
|
48691
|
-
/**
|
|
48692
|
-
* Gone. Update settings by PATCHing the management unit
|
|
48693
|
-
*
|
|
48694
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
48695
|
-
*/
|
|
48696
|
-
patchWorkforcemanagementManagementunitSettings(muId) {
|
|
48697
|
-
// verify the required parameter 'muId' is set
|
|
48698
|
-
if (muId === undefined || muId === null) {
|
|
48699
|
-
throw 'Missing the required parameter "muId" when calling patchWorkforcemanagementManagementunitSettings';
|
|
48700
|
-
}
|
|
48701
|
-
|
|
48702
|
-
return this.apiClient.callApi(
|
|
48703
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/settings',
|
|
48704
|
-
'PATCH',
|
|
48705
|
-
{ 'muId': muId },
|
|
48706
|
-
{ },
|
|
48707
|
-
{ },
|
|
48708
|
-
{ },
|
|
48709
|
-
null,
|
|
48710
|
-
['PureCloud OAuth'],
|
|
48711
|
-
['application/json'],
|
|
48712
|
-
['application/json']
|
|
48713
|
-
);
|
|
48714
|
-
}
|
|
48715
|
-
|
|
48716
48201
|
/**
|
|
48717
48202
|
* Update a time off request
|
|
48718
48203
|
*
|
|
@@ -48752,41 +48237,6 @@ class WorkforceManagementApi {
|
|
|
48752
48237
|
);
|
|
48753
48238
|
}
|
|
48754
48239
|
|
|
48755
|
-
/**
|
|
48756
|
-
* Gone. Scheduling has moved under business units
|
|
48757
|
-
*
|
|
48758
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
48759
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
48760
|
-
* @param {String} scheduleId Gone/deprecated. The ID of the schedule to update. Use partial uploads of user schedules if activity count in schedule is greater than 17500
|
|
48761
|
-
*/
|
|
48762
|
-
patchWorkforcemanagementManagementunitWeekSchedule(managementUnitId, weekId, scheduleId) {
|
|
48763
|
-
// verify the required parameter 'managementUnitId' is set
|
|
48764
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
48765
|
-
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWeekSchedule';
|
|
48766
|
-
}
|
|
48767
|
-
// verify the required parameter 'weekId' is set
|
|
48768
|
-
if (weekId === undefined || weekId === null) {
|
|
48769
|
-
throw 'Missing the required parameter "weekId" when calling patchWorkforcemanagementManagementunitWeekSchedule';
|
|
48770
|
-
}
|
|
48771
|
-
// verify the required parameter 'scheduleId' is set
|
|
48772
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
48773
|
-
throw 'Missing the required parameter "scheduleId" when calling patchWorkforcemanagementManagementunitWeekSchedule';
|
|
48774
|
-
}
|
|
48775
|
-
|
|
48776
|
-
return this.apiClient.callApi(
|
|
48777
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}',
|
|
48778
|
-
'PATCH',
|
|
48779
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
48780
|
-
{ },
|
|
48781
|
-
{ },
|
|
48782
|
-
{ },
|
|
48783
|
-
null,
|
|
48784
|
-
['PureCloud OAuth'],
|
|
48785
|
-
['application/json'],
|
|
48786
|
-
['application/json']
|
|
48787
|
-
);
|
|
48788
|
-
}
|
|
48789
|
-
|
|
48790
48240
|
/**
|
|
48791
48241
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
48792
48242
|
*
|
|
@@ -48834,6 +48284,7 @@ class WorkforceManagementApi {
|
|
|
48834
48284
|
* @param {String} workPlanId The ID of the work plan to update
|
|
48835
48285
|
* @param {Object} opts Optional parameters
|
|
48836
48286
|
* @param {Object} opts.body body
|
|
48287
|
+
* @param {Object} opts.validationMode Allows to update work plan even if validation result is invalid
|
|
48837
48288
|
*/
|
|
48838
48289
|
patchWorkforcemanagementManagementunitWorkplan(managementUnitId, workPlanId, opts) {
|
|
48839
48290
|
opts = opts || {};
|
|
@@ -48851,6 +48302,40 @@ class WorkforceManagementApi {
|
|
|
48851
48302
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}',
|
|
48852
48303
|
'PATCH',
|
|
48853
48304
|
{ 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
|
|
48305
|
+
{ 'validationMode': opts['validationMode'] },
|
|
48306
|
+
{ },
|
|
48307
|
+
{ },
|
|
48308
|
+
opts['body'],
|
|
48309
|
+
['PureCloud OAuth'],
|
|
48310
|
+
['application/json'],
|
|
48311
|
+
['application/json']
|
|
48312
|
+
);
|
|
48313
|
+
}
|
|
48314
|
+
|
|
48315
|
+
/**
|
|
48316
|
+
* Update a work plan rotation
|
|
48317
|
+
*
|
|
48318
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
48319
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to update
|
|
48320
|
+
* @param {Object} opts Optional parameters
|
|
48321
|
+
* @param {Object} opts.body body
|
|
48322
|
+
*/
|
|
48323
|
+
patchWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId, opts) {
|
|
48324
|
+
opts = opts || {};
|
|
48325
|
+
|
|
48326
|
+
// verify the required parameter 'managementUnitId' is set
|
|
48327
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
48328
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
|
|
48329
|
+
}
|
|
48330
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
48331
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
48332
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
|
|
48333
|
+
}
|
|
48334
|
+
|
|
48335
|
+
return this.apiClient.callApi(
|
|
48336
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
|
|
48337
|
+
'PATCH',
|
|
48338
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
48854
48339
|
{ },
|
|
48855
48340
|
{ },
|
|
48856
48341
|
{ },
|
|
@@ -49388,31 +48873,6 @@ class WorkforceManagementApi {
|
|
|
49388
48873
|
);
|
|
49389
48874
|
}
|
|
49390
48875
|
|
|
49391
|
-
/**
|
|
49392
|
-
* Deprecated/Gone: Use the new business unit activity code resources
|
|
49393
|
-
*
|
|
49394
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
49395
|
-
*/
|
|
49396
|
-
postWorkforcemanagementManagementunitActivitycodes(muId) {
|
|
49397
|
-
// verify the required parameter 'muId' is set
|
|
49398
|
-
if (muId === undefined || muId === null) {
|
|
49399
|
-
throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitActivitycodes';
|
|
49400
|
-
}
|
|
49401
|
-
|
|
49402
|
-
return this.apiClient.callApi(
|
|
49403
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/activitycodes',
|
|
49404
|
-
'POST',
|
|
49405
|
-
{ 'muId': muId },
|
|
49406
|
-
{ },
|
|
49407
|
-
{ },
|
|
49408
|
-
{ },
|
|
49409
|
-
null,
|
|
49410
|
-
['PureCloud OAuth'],
|
|
49411
|
-
['application/json'],
|
|
49412
|
-
['application/json']
|
|
49413
|
-
);
|
|
49414
|
-
}
|
|
49415
|
-
|
|
49416
48876
|
/**
|
|
49417
48877
|
* Query published schedules for given given time range for set of users
|
|
49418
48878
|
*
|
|
@@ -49473,31 +48933,6 @@ class WorkforceManagementApi {
|
|
|
49473
48933
|
);
|
|
49474
48934
|
}
|
|
49475
48935
|
|
|
49476
|
-
/**
|
|
49477
|
-
* Gone. Moved under business units
|
|
49478
|
-
*
|
|
49479
|
-
* @param {String} muId The management unit ID of the management unit
|
|
49480
|
-
*/
|
|
49481
|
-
postWorkforcemanagementManagementunitIntraday(muId) {
|
|
49482
|
-
// verify the required parameter 'muId' is set
|
|
49483
|
-
if (muId === undefined || muId === null) {
|
|
49484
|
-
throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitIntraday';
|
|
49485
|
-
}
|
|
49486
|
-
|
|
49487
|
-
return this.apiClient.callApi(
|
|
49488
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/intraday',
|
|
49489
|
-
'POST',
|
|
49490
|
-
{ 'muId': muId },
|
|
49491
|
-
{ },
|
|
49492
|
-
{ },
|
|
49493
|
-
{ },
|
|
49494
|
-
null,
|
|
49495
|
-
['PureCloud OAuth'],
|
|
49496
|
-
['application/json'],
|
|
49497
|
-
['application/json']
|
|
49498
|
-
);
|
|
49499
|
-
}
|
|
49500
|
-
|
|
49501
48936
|
/**
|
|
49502
48937
|
* Move the requested management unit to a new business unit
|
|
49503
48938
|
* Returns status 200 if the management unit is already in the requested business unit
|
|
@@ -49556,31 +48991,6 @@ class WorkforceManagementApi {
|
|
|
49556
48991
|
);
|
|
49557
48992
|
}
|
|
49558
48993
|
|
|
49559
|
-
/**
|
|
49560
|
-
* Gone. Replaced with service goal templates and planning groups under business units
|
|
49561
|
-
*
|
|
49562
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
49563
|
-
*/
|
|
49564
|
-
postWorkforcemanagementManagementunitServicegoalgroups(managementUnitId) {
|
|
49565
|
-
// verify the required parameter 'managementUnitId' is set
|
|
49566
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49567
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitServicegoalgroups';
|
|
49568
|
-
}
|
|
49569
|
-
|
|
49570
|
-
return this.apiClient.callApi(
|
|
49571
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups',
|
|
49572
|
-
'POST',
|
|
49573
|
-
{ 'managementUnitId': managementUnitId },
|
|
49574
|
-
{ },
|
|
49575
|
-
{ },
|
|
49576
|
-
{ },
|
|
49577
|
-
null,
|
|
49578
|
-
['PureCloud OAuth'],
|
|
49579
|
-
['application/json'],
|
|
49580
|
-
['application/json']
|
|
49581
|
-
);
|
|
49582
|
-
}
|
|
49583
|
-
|
|
49584
48994
|
/**
|
|
49585
48995
|
* Create a new time off request
|
|
49586
48996
|
*
|
|
@@ -49610,35 +49020,6 @@ class WorkforceManagementApi {
|
|
|
49610
49020
|
);
|
|
49611
49021
|
}
|
|
49612
49022
|
|
|
49613
|
-
/**
|
|
49614
|
-
* Gone. All data is now returned in the query route
|
|
49615
|
-
*
|
|
49616
|
-
* @param {String} muId The muId of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
49617
|
-
* @param {Object} opts Optional parameters
|
|
49618
|
-
* @param {Object} opts.body body
|
|
49619
|
-
*/
|
|
49620
|
-
postWorkforcemanagementManagementunitTimeoffrequestsFetchdetails(muId, opts) {
|
|
49621
|
-
opts = opts || {};
|
|
49622
|
-
|
|
49623
|
-
// verify the required parameter 'muId' is set
|
|
49624
|
-
if (muId === undefined || muId === null) {
|
|
49625
|
-
throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitTimeoffrequestsFetchdetails';
|
|
49626
|
-
}
|
|
49627
|
-
|
|
49628
|
-
return this.apiClient.callApi(
|
|
49629
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests/fetchdetails',
|
|
49630
|
-
'POST',
|
|
49631
|
-
{ 'muId': muId },
|
|
49632
|
-
{ },
|
|
49633
|
-
{ },
|
|
49634
|
-
{ },
|
|
49635
|
-
opts['body'],
|
|
49636
|
-
['PureCloud OAuth'],
|
|
49637
|
-
['application/json'],
|
|
49638
|
-
['application/json']
|
|
49639
|
-
);
|
|
49640
|
-
}
|
|
49641
|
-
|
|
49642
49023
|
/**
|
|
49643
49024
|
* Gets the lookup ids to fetch the specified set of requests
|
|
49644
49025
|
*
|
|
@@ -49668,166 +49049,6 @@ class WorkforceManagementApi {
|
|
|
49668
49049
|
);
|
|
49669
49050
|
}
|
|
49670
49051
|
|
|
49671
|
-
/**
|
|
49672
|
-
* Gone. Scheduling has moved under business units
|
|
49673
|
-
*
|
|
49674
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
49675
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
49676
|
-
* @param {String} scheduleId Gone/deprecated. The ID of the schedule to copy from
|
|
49677
|
-
*/
|
|
49678
|
-
postWorkforcemanagementManagementunitWeekScheduleCopy(managementUnitId, weekId, scheduleId) {
|
|
49679
|
-
// verify the required parameter 'managementUnitId' is set
|
|
49680
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49681
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekScheduleCopy';
|
|
49682
|
-
}
|
|
49683
|
-
// verify the required parameter 'weekId' is set
|
|
49684
|
-
if (weekId === undefined || weekId === null) {
|
|
49685
|
-
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekScheduleCopy';
|
|
49686
|
-
}
|
|
49687
|
-
// verify the required parameter 'scheduleId' is set
|
|
49688
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
49689
|
-
throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementManagementunitWeekScheduleCopy';
|
|
49690
|
-
}
|
|
49691
|
-
|
|
49692
|
-
return this.apiClient.callApi(
|
|
49693
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy',
|
|
49694
|
-
'POST',
|
|
49695
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
49696
|
-
{ },
|
|
49697
|
-
{ },
|
|
49698
|
-
{ },
|
|
49699
|
-
null,
|
|
49700
|
-
['PureCloud OAuth'],
|
|
49701
|
-
['application/json'],
|
|
49702
|
-
['application/json']
|
|
49703
|
-
);
|
|
49704
|
-
}
|
|
49705
|
-
|
|
49706
|
-
/**
|
|
49707
|
-
* Gone. Scheduling has moved under business units
|
|
49708
|
-
*
|
|
49709
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
49710
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
49711
|
-
* @param {String} scheduleId Gone/deprecated. The ID of the schedule to re-optimize
|
|
49712
|
-
*/
|
|
49713
|
-
postWorkforcemanagementManagementunitWeekScheduleReschedule(managementUnitId, weekId, scheduleId) {
|
|
49714
|
-
// verify the required parameter 'managementUnitId' is set
|
|
49715
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49716
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekScheduleReschedule';
|
|
49717
|
-
}
|
|
49718
|
-
// verify the required parameter 'weekId' is set
|
|
49719
|
-
if (weekId === undefined || weekId === null) {
|
|
49720
|
-
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekScheduleReschedule';
|
|
49721
|
-
}
|
|
49722
|
-
// verify the required parameter 'scheduleId' is set
|
|
49723
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
49724
|
-
throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementManagementunitWeekScheduleReschedule';
|
|
49725
|
-
}
|
|
49726
|
-
|
|
49727
|
-
return this.apiClient.callApi(
|
|
49728
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/reschedule',
|
|
49729
|
-
'POST',
|
|
49730
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
49731
|
-
{ },
|
|
49732
|
-
{ },
|
|
49733
|
-
{ },
|
|
49734
|
-
null,
|
|
49735
|
-
['PureCloud OAuth'],
|
|
49736
|
-
['application/json'],
|
|
49737
|
-
['application/json']
|
|
49738
|
-
);
|
|
49739
|
-
}
|
|
49740
|
-
|
|
49741
|
-
/**
|
|
49742
|
-
* Gone. Scheduling has moved under business units
|
|
49743
|
-
*
|
|
49744
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
49745
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
49746
|
-
*/
|
|
49747
|
-
postWorkforcemanagementManagementunitWeekSchedules(managementUnitId, weekId) {
|
|
49748
|
-
// verify the required parameter 'managementUnitId' is set
|
|
49749
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49750
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekSchedules';
|
|
49751
|
-
}
|
|
49752
|
-
// verify the required parameter 'weekId' is set
|
|
49753
|
-
if (weekId === undefined || weekId === null) {
|
|
49754
|
-
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekSchedules';
|
|
49755
|
-
}
|
|
49756
|
-
|
|
49757
|
-
return this.apiClient.callApi(
|
|
49758
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules',
|
|
49759
|
-
'POST',
|
|
49760
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId },
|
|
49761
|
-
{ },
|
|
49762
|
-
{ },
|
|
49763
|
-
{ },
|
|
49764
|
-
null,
|
|
49765
|
-
['PureCloud OAuth'],
|
|
49766
|
-
['application/json'],
|
|
49767
|
-
['application/json']
|
|
49768
|
-
);
|
|
49769
|
-
}
|
|
49770
|
-
|
|
49771
|
-
/**
|
|
49772
|
-
* Gone. Scheduling has moved under business units
|
|
49773
|
-
*
|
|
49774
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
49775
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
49776
|
-
*/
|
|
49777
|
-
postWorkforcemanagementManagementunitWeekSchedulesGenerate(managementUnitId, weekId) {
|
|
49778
|
-
// verify the required parameter 'managementUnitId' is set
|
|
49779
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49780
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekSchedulesGenerate';
|
|
49781
|
-
}
|
|
49782
|
-
// verify the required parameter 'weekId' is set
|
|
49783
|
-
if (weekId === undefined || weekId === null) {
|
|
49784
|
-
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekSchedulesGenerate';
|
|
49785
|
-
}
|
|
49786
|
-
|
|
49787
|
-
return this.apiClient.callApi(
|
|
49788
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/generate',
|
|
49789
|
-
'POST',
|
|
49790
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId },
|
|
49791
|
-
{ },
|
|
49792
|
-
{ },
|
|
49793
|
-
{ },
|
|
49794
|
-
null,
|
|
49795
|
-
['PureCloud OAuth'],
|
|
49796
|
-
['application/json'],
|
|
49797
|
-
['application/json']
|
|
49798
|
-
);
|
|
49799
|
-
}
|
|
49800
|
-
|
|
49801
|
-
/**
|
|
49802
|
-
* Gone. Scheduling has moved under business units
|
|
49803
|
-
*
|
|
49804
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
49805
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
49806
|
-
*/
|
|
49807
|
-
postWorkforcemanagementManagementunitWeekSchedulesPartialupload(managementUnitId, weekId) {
|
|
49808
|
-
// verify the required parameter 'managementUnitId' is set
|
|
49809
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49810
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekSchedulesPartialupload';
|
|
49811
|
-
}
|
|
49812
|
-
// verify the required parameter 'weekId' is set
|
|
49813
|
-
if (weekId === undefined || weekId === null) {
|
|
49814
|
-
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekSchedulesPartialupload';
|
|
49815
|
-
}
|
|
49816
|
-
|
|
49817
|
-
return this.apiClient.callApi(
|
|
49818
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/partialupload',
|
|
49819
|
-
'POST',
|
|
49820
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId },
|
|
49821
|
-
{ },
|
|
49822
|
-
{ },
|
|
49823
|
-
{ },
|
|
49824
|
-
null,
|
|
49825
|
-
['PureCloud OAuth'],
|
|
49826
|
-
['application/json'],
|
|
49827
|
-
['application/json']
|
|
49828
|
-
);
|
|
49829
|
-
}
|
|
49830
|
-
|
|
49831
49052
|
/**
|
|
49832
49053
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
49833
49054
|
*
|
|
@@ -49978,94 +49199,33 @@ class WorkforceManagementApi {
|
|
|
49978
49199
|
}
|
|
49979
49200
|
|
|
49980
49201
|
/**
|
|
49981
|
-
*
|
|
49982
|
-
*
|
|
49983
|
-
* @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
|
|
49984
|
-
* @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
|
|
49985
|
-
* @param {String} forecastId (Gone/Deprecated): The ID of the forecast
|
|
49986
|
-
*/
|
|
49987
|
-
postWorkforcemanagementManagementunitWeekShorttermforecastCopy(managementUnitId, weekDateId, forecastId) {
|
|
49988
|
-
// verify the required parameter 'managementUnitId' is set
|
|
49989
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49990
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastCopy';
|
|
49991
|
-
}
|
|
49992
|
-
// verify the required parameter 'weekDateId' is set
|
|
49993
|
-
if (weekDateId === undefined || weekDateId === null) {
|
|
49994
|
-
throw 'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastCopy';
|
|
49995
|
-
}
|
|
49996
|
-
// verify the required parameter 'forecastId' is set
|
|
49997
|
-
if (forecastId === undefined || forecastId === null) {
|
|
49998
|
-
throw 'Missing the required parameter "forecastId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastCopy';
|
|
49999
|
-
}
|
|
50000
|
-
|
|
50001
|
-
return this.apiClient.callApi(
|
|
50002
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/copy',
|
|
50003
|
-
'POST',
|
|
50004
|
-
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
|
|
50005
|
-
{ },
|
|
50006
|
-
{ },
|
|
50007
|
-
{ },
|
|
50008
|
-
null,
|
|
50009
|
-
['PureCloud OAuth'],
|
|
50010
|
-
['application/json'],
|
|
50011
|
-
['application/json']
|
|
50012
|
-
);
|
|
50013
|
-
}
|
|
50014
|
-
|
|
50015
|
-
/**
|
|
50016
|
-
* Gone. Use equivalent business unit resource instead
|
|
50017
|
-
*
|
|
50018
|
-
* @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
|
|
50019
|
-
* @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
|
|
50020
|
-
*/
|
|
50021
|
-
postWorkforcemanagementManagementunitWeekShorttermforecasts(managementUnitId, weekDateId) {
|
|
50022
|
-
// verify the required parameter 'managementUnitId' is set
|
|
50023
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
50024
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShorttermforecasts';
|
|
50025
|
-
}
|
|
50026
|
-
// verify the required parameter 'weekDateId' is set
|
|
50027
|
-
if (weekDateId === undefined || weekDateId === null) {
|
|
50028
|
-
throw 'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShorttermforecasts';
|
|
50029
|
-
}
|
|
50030
|
-
|
|
50031
|
-
return this.apiClient.callApi(
|
|
50032
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts',
|
|
50033
|
-
'POST',
|
|
50034
|
-
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
|
|
50035
|
-
{ },
|
|
50036
|
-
{ },
|
|
50037
|
-
{ },
|
|
50038
|
-
null,
|
|
50039
|
-
['PureCloud OAuth'],
|
|
50040
|
-
['application/json'],
|
|
50041
|
-
['application/json']
|
|
50042
|
-
);
|
|
50043
|
-
}
|
|
50044
|
-
|
|
50045
|
-
/**
|
|
50046
|
-
* Gone. Use equivalent business unit resource instead
|
|
49202
|
+
* Create a copy of work plan
|
|
50047
49203
|
*
|
|
50048
|
-
* @param {String} managementUnitId
|
|
50049
|
-
* @param {String}
|
|
49204
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
49205
|
+
* @param {String} workPlanId The ID of the work plan to create a copy
|
|
49206
|
+
* @param {Object} opts Optional parameters
|
|
49207
|
+
* @param {Object} opts.body body
|
|
50050
49208
|
*/
|
|
50051
|
-
|
|
49209
|
+
postWorkforcemanagementManagementunitWorkplanCopy(managementUnitId, workPlanId, opts) {
|
|
49210
|
+
opts = opts || {};
|
|
49211
|
+
|
|
50052
49212
|
// verify the required parameter 'managementUnitId' is set
|
|
50053
49213
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
50054
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
49214
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
|
|
50055
49215
|
}
|
|
50056
|
-
// verify the required parameter '
|
|
50057
|
-
if (
|
|
50058
|
-
throw 'Missing the required parameter "
|
|
49216
|
+
// verify the required parameter 'workPlanId' is set
|
|
49217
|
+
if (workPlanId === undefined || workPlanId === null) {
|
|
49218
|
+
throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
|
|
50059
49219
|
}
|
|
50060
49220
|
|
|
50061
49221
|
return this.apiClient.callApi(
|
|
50062
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
49222
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy',
|
|
50063
49223
|
'POST',
|
|
50064
|
-
{ 'managementUnitId': managementUnitId,'
|
|
49224
|
+
{ 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
|
|
50065
49225
|
{ },
|
|
50066
49226
|
{ },
|
|
50067
49227
|
{ },
|
|
50068
|
-
|
|
49228
|
+
opts['body'],
|
|
50069
49229
|
['PureCloud OAuth'],
|
|
50070
49230
|
['application/json'],
|
|
50071
49231
|
['application/json']
|
|
@@ -50073,29 +49233,34 @@ class WorkforceManagementApi {
|
|
|
50073
49233
|
}
|
|
50074
49234
|
|
|
50075
49235
|
/**
|
|
50076
|
-
*
|
|
49236
|
+
* Validate Work Plan
|
|
50077
49237
|
*
|
|
50078
|
-
* @param {String} managementUnitId
|
|
50079
|
-
* @param {String}
|
|
49238
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
49239
|
+
* @param {String} workPlanId The ID of the work plan to validate. For new work plan, use the word 'new' for the ID.
|
|
49240
|
+
* @param {Object} opts Optional parameters
|
|
49241
|
+
* @param {Object} opts.body body
|
|
49242
|
+
* @param {Array.<String>} opts.expand
|
|
50080
49243
|
*/
|
|
50081
|
-
|
|
49244
|
+
postWorkforcemanagementManagementunitWorkplanValidate(managementUnitId, workPlanId, opts) {
|
|
49245
|
+
opts = opts || {};
|
|
49246
|
+
|
|
50082
49247
|
// verify the required parameter 'managementUnitId' is set
|
|
50083
49248
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
50084
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
49249
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
|
|
50085
49250
|
}
|
|
50086
|
-
// verify the required parameter '
|
|
50087
|
-
if (
|
|
50088
|
-
throw 'Missing the required parameter "
|
|
49251
|
+
// verify the required parameter 'workPlanId' is set
|
|
49252
|
+
if (workPlanId === undefined || workPlanId === null) {
|
|
49253
|
+
throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
|
|
50089
49254
|
}
|
|
50090
49255
|
|
|
50091
49256
|
return this.apiClient.callApi(
|
|
50092
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
49257
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate',
|
|
50093
49258
|
'POST',
|
|
50094
|
-
{ 'managementUnitId': managementUnitId,'
|
|
50095
|
-
{
|
|
49259
|
+
{ 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
|
|
49260
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
50096
49261
|
{ },
|
|
50097
49262
|
{ },
|
|
50098
|
-
|
|
49263
|
+
opts['body'],
|
|
50099
49264
|
['PureCloud OAuth'],
|
|
50100
49265
|
['application/json'],
|
|
50101
49266
|
['application/json']
|
|
@@ -50103,29 +49268,29 @@ class WorkforceManagementApi {
|
|
|
50103
49268
|
}
|
|
50104
49269
|
|
|
50105
49270
|
/**
|
|
50106
|
-
* Create a copy of work plan
|
|
49271
|
+
* Create a copy of work plan rotation
|
|
50107
49272
|
*
|
|
50108
49273
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50109
|
-
* @param {String}
|
|
49274
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to create a copy
|
|
50110
49275
|
* @param {Object} opts Optional parameters
|
|
50111
49276
|
* @param {Object} opts.body body
|
|
50112
49277
|
*/
|
|
50113
|
-
|
|
49278
|
+
postWorkforcemanagementManagementunitWorkplanrotationCopy(managementUnitId, workPlanRotationId, opts) {
|
|
50114
49279
|
opts = opts || {};
|
|
50115
49280
|
|
|
50116
49281
|
// verify the required parameter 'managementUnitId' is set
|
|
50117
49282
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
50118
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
49283
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
|
|
50119
49284
|
}
|
|
50120
|
-
// verify the required parameter '
|
|
50121
|
-
if (
|
|
50122
|
-
throw 'Missing the required parameter "
|
|
49285
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
49286
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
49287
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
|
|
50123
49288
|
}
|
|
50124
49289
|
|
|
50125
49290
|
return this.apiClient.callApi(
|
|
50126
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
49291
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy',
|
|
50127
49292
|
'POST',
|
|
50128
|
-
{ 'managementUnitId': managementUnitId,'
|
|
49293
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
50129
49294
|
{ },
|
|
50130
49295
|
{ },
|
|
50131
49296
|
{ },
|
|
@@ -50137,31 +49302,25 @@ class WorkforceManagementApi {
|
|
|
50137
49302
|
}
|
|
50138
49303
|
|
|
50139
49304
|
/**
|
|
50140
|
-
*
|
|
49305
|
+
* Create a new work plan rotation
|
|
50141
49306
|
*
|
|
50142
49307
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50143
|
-
* @param {String} workPlanId The ID of the work plan to validate. For new work plan, use the word 'new' for the ID.
|
|
50144
49308
|
* @param {Object} opts Optional parameters
|
|
50145
49309
|
* @param {Object} opts.body body
|
|
50146
|
-
* @param {Array.<String>} opts.expand
|
|
50147
49310
|
*/
|
|
50148
|
-
|
|
49311
|
+
postWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, opts) {
|
|
50149
49312
|
opts = opts || {};
|
|
50150
49313
|
|
|
50151
49314
|
// verify the required parameter 'managementUnitId' is set
|
|
50152
49315
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
50153
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
50154
|
-
}
|
|
50155
|
-
// verify the required parameter 'workPlanId' is set
|
|
50156
|
-
if (workPlanId === undefined || workPlanId === null) {
|
|
50157
|
-
throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
|
|
49316
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotations';
|
|
50158
49317
|
}
|
|
50159
49318
|
|
|
50160
49319
|
return this.apiClient.callApi(
|
|
50161
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
49320
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
|
|
50162
49321
|
'POST',
|
|
50163
|
-
{ 'managementUnitId': managementUnitId
|
|
50164
|
-
{
|
|
49322
|
+
{ 'managementUnitId': managementUnitId },
|
|
49323
|
+
{ },
|
|
50165
49324
|
{ },
|
|
50166
49325
|
{ },
|
|
50167
49326
|
opts['body'],
|
|
@@ -50177,6 +49336,7 @@ class WorkforceManagementApi {
|
|
|
50177
49336
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50178
49337
|
* @param {Object} opts Optional parameters
|
|
50179
49338
|
* @param {Object} opts.body body
|
|
49339
|
+
* @param {Object} opts.validationMode Allows to create work plan even if the validation result is invalid
|
|
50180
49340
|
*/
|
|
50181
49341
|
postWorkforcemanagementManagementunitWorkplans(managementUnitId, opts) {
|
|
50182
49342
|
opts = opts || {};
|
|
@@ -50190,7 +49350,7 @@ class WorkforceManagementApi {
|
|
|
50190
49350
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans',
|
|
50191
49351
|
'POST',
|
|
50192
49352
|
{ 'managementUnitId': managementUnitId },
|
|
50193
|
-
{
|
|
49353
|
+
{ 'validationMode': opts['validationMode'] },
|
|
50194
49354
|
{ },
|
|
50195
49355
|
{ },
|
|
50196
49356
|
opts['body'],
|
|
@@ -50327,7 +49487,7 @@ class WorkforceManagementApi {
|
|
|
50327
49487
|
* </pre>
|
|
50328
49488
|
* </p>
|
|
50329
49489
|
* @module purecloud-platform-client-v2/index
|
|
50330
|
-
* @version
|
|
49490
|
+
* @version 98.0.0
|
|
50331
49491
|
*/
|
|
50332
49492
|
class platformClient {
|
|
50333
49493
|
constructor() {
|
|
@@ -50586,11 +49746,6 @@ class platformClient {
|
|
|
50586
49746
|
* @property {module:purecloud-platform-client-v2/api/UsageApi}
|
|
50587
49747
|
*/
|
|
50588
49748
|
this.UsageApi = UsageApi;
|
|
50589
|
-
/**
|
|
50590
|
-
* The UserDevelopmentApi service constructor.
|
|
50591
|
-
* @property {module:purecloud-platform-client-v2/api/UserDevelopmentApi}
|
|
50592
|
-
*/
|
|
50593
|
-
this.UserDevelopmentApi = UserDevelopmentApi;
|
|
50594
49749
|
/**
|
|
50595
49750
|
* The UserRecordingsApi service constructor.
|
|
50596
49751
|
* @property {module:purecloud-platform-client-v2/api/UserRecordingsApi}
|
|
@@ -50641,5 +49796,5 @@ var index = new platformClient();
|
|
|
50641
49796
|
|
|
50642
49797
|
module.exports = index;
|
|
50643
49798
|
|
|
50644
|
-
}).call(this,typeof global !== "undefined" ? global : typeof self !== "undefined" ? self : typeof window !== "undefined" ? window : {},require("buffer").Buffer)
|
|
49799
|
+
}).call(this)}).call(this,typeof global !== "undefined" ? global : typeof self !== "undefined" ? self : typeof window !== "undefined" ? window : {},require("buffer").Buffer)
|
|
50645
49800
|
},{"buffer":3,"fs":1,"superagent":7}]},{},[]);
|