purecloud-platform-client-v2 94.0.0 → 97.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 +547 -1265
- package/dist/web-amd/purecloud-platform-client-v2.js +547 -1265
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +547 -1265
- package/dist/web-cjs/purecloud-platform-client-v2.js +552 -1269
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +513 -289
- 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 +131 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +4 -3
- 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 +7 -7
- 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 +306 -1147
- package/src/purecloud-platform-client-v2/index.js +1 -7
- package/src/purecloud-platform-client-v2/api/UserDevelopmentApi.js +0 -148
|
@@ -155,7 +155,7 @@ function fromByteArray (uint8) {
|
|
|
155
155
|
}
|
|
156
156
|
|
|
157
157
|
},{}],3:[function(require,module,exports){
|
|
158
|
-
(function (Buffer){
|
|
158
|
+
(function (Buffer){(function (){
|
|
159
159
|
/*!
|
|
160
160
|
* The buffer module from node.js, for the browser.
|
|
161
161
|
*
|
|
@@ -1934,8 +1934,9 @@ function numberIsNaN (obj) {
|
|
|
1934
1934
|
return obj !== obj // eslint-disable-line no-self-compare
|
|
1935
1935
|
}
|
|
1936
1936
|
|
|
1937
|
-
}).call(this,require("buffer").Buffer)
|
|
1937
|
+
}).call(this)}).call(this,require("buffer").Buffer)
|
|
1938
1938
|
},{"base64-js":2,"buffer":3,"ieee754":4}],4:[function(require,module,exports){
|
|
1939
|
+
/*! ieee754. BSD-3-Clause License. Feross Aboukhadijeh <https://feross.org/opensource> */
|
|
1939
1940
|
exports.read = function (buffer, offset, isLE, mLen, nBytes) {
|
|
1940
1941
|
var e, m
|
|
1941
1942
|
var eLen = (nBytes * 8) - mLen - 1
|
|
@@ -4067,7 +4068,7 @@ exports.cleanHeader = function(header, changesOrigin){
|
|
|
4067
4068
|
};
|
|
4068
4069
|
|
|
4069
4070
|
},{}],"platformClient":[function(require,module,exports){
|
|
4070
|
-
(function (global,Buffer){
|
|
4071
|
+
(function (global,Buffer){(function (){
|
|
4071
4072
|
'use strict';
|
|
4072
4073
|
|
|
4073
4074
|
function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
|
|
@@ -6053,7 +6054,7 @@ function isSlowBuffer (obj) {
|
|
|
6053
6054
|
|
|
6054
6055
|
/**
|
|
6055
6056
|
* @module purecloud-platform-client-v2/ApiClient
|
|
6056
|
-
* @version
|
|
6057
|
+
* @version 97.0.0
|
|
6057
6058
|
*/
|
|
6058
6059
|
class ApiClient {
|
|
6059
6060
|
/**
|
|
@@ -6809,7 +6810,7 @@ class ApiClient {
|
|
|
6809
6810
|
|
|
6810
6811
|
// set header parameters
|
|
6811
6812
|
request.set(this.defaultHeaders).set(this.normalizeParams(headerParams));
|
|
6812
|
-
//request.set({ 'purecloud-sdk': '
|
|
6813
|
+
//request.set({ 'purecloud-sdk': '97.0.0' });
|
|
6813
6814
|
|
|
6814
6815
|
// set request timeout
|
|
6815
6816
|
request.timeout(this.timeout);
|
|
@@ -6934,7 +6935,7 @@ class AlertingApi {
|
|
|
6934
6935
|
/**
|
|
6935
6936
|
* Alerting service.
|
|
6936
6937
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
6937
|
-
* @version
|
|
6938
|
+
* @version 97.0.0
|
|
6938
6939
|
*/
|
|
6939
6940
|
|
|
6940
6941
|
/**
|
|
@@ -7248,7 +7249,7 @@ class AnalyticsApi {
|
|
|
7248
7249
|
/**
|
|
7249
7250
|
* Analytics service.
|
|
7250
7251
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
7251
|
-
* @version
|
|
7252
|
+
* @version 97.0.0
|
|
7252
7253
|
*/
|
|
7253
7254
|
|
|
7254
7255
|
/**
|
|
@@ -8328,7 +8329,7 @@ class ArchitectApi {
|
|
|
8328
8329
|
/**
|
|
8329
8330
|
* Architect service.
|
|
8330
8331
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
8331
|
-
* @version
|
|
8332
|
+
* @version 97.0.0
|
|
8332
8333
|
*/
|
|
8333
8334
|
|
|
8334
8335
|
/**
|
|
@@ -11166,7 +11167,7 @@ class AuditApi {
|
|
|
11166
11167
|
/**
|
|
11167
11168
|
* Audit service.
|
|
11168
11169
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
11169
|
-
* @version
|
|
11170
|
+
* @version 97.0.0
|
|
11170
11171
|
*/
|
|
11171
11172
|
|
|
11172
11173
|
/**
|
|
@@ -11337,7 +11338,7 @@ class AuthorizationApi {
|
|
|
11337
11338
|
/**
|
|
11338
11339
|
* Authorization service.
|
|
11339
11340
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
11340
|
-
* @version
|
|
11341
|
+
* @version 97.0.0
|
|
11341
11342
|
*/
|
|
11342
11343
|
|
|
11343
11344
|
/**
|
|
@@ -11672,6 +11673,8 @@ class AuthorizationApi {
|
|
|
11672
11673
|
* @param {Object} opts Optional parameters
|
|
11673
11674
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
11674
11675
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
11676
|
+
* @param {Object} opts.queryType Query filter type
|
|
11677
|
+
* @param {String} opts.query Comma-separated list of permissions or domains to query
|
|
11675
11678
|
*/
|
|
11676
11679
|
getAuthorizationPermissions(opts) {
|
|
11677
11680
|
opts = opts || {};
|
|
@@ -11681,7 +11684,7 @@ class AuthorizationApi {
|
|
|
11681
11684
|
'/api/v2/authorization/permissions',
|
|
11682
11685
|
'GET',
|
|
11683
11686
|
{ },
|
|
11684
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
11687
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'queryType': opts['queryType'],'query': opts['query'] },
|
|
11685
11688
|
{ },
|
|
11686
11689
|
{ },
|
|
11687
11690
|
null,
|
|
@@ -12454,7 +12457,7 @@ class BillingApi {
|
|
|
12454
12457
|
/**
|
|
12455
12458
|
* Billing service.
|
|
12456
12459
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
12457
|
-
* @version
|
|
12460
|
+
* @version 97.0.0
|
|
12458
12461
|
*/
|
|
12459
12462
|
|
|
12460
12463
|
/**
|
|
@@ -12472,8 +12475,8 @@ class BillingApi {
|
|
|
12472
12475
|
/**
|
|
12473
12476
|
* Get a report of the billable license usages
|
|
12474
12477
|
* 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.
|
|
12478
|
+
* @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
|
|
12479
|
+
* @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
12480
|
*/
|
|
12478
12481
|
getBillingReportsBillableusage(startDate, endDate) {
|
|
12479
12482
|
// verify the required parameter 'startDate' is set
|
|
@@ -12534,7 +12537,7 @@ class CoachingApi {
|
|
|
12534
12537
|
/**
|
|
12535
12538
|
* Coaching service.
|
|
12536
12539
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
12537
|
-
* @version
|
|
12540
|
+
* @version 97.0.0
|
|
12538
12541
|
*/
|
|
12539
12542
|
|
|
12540
12543
|
/**
|
|
@@ -13054,7 +13057,7 @@ class ContentManagementApi {
|
|
|
13054
13057
|
/**
|
|
13055
13058
|
* ContentManagement service.
|
|
13056
13059
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
13057
|
-
* @version
|
|
13060
|
+
* @version 97.0.0
|
|
13058
13061
|
*/
|
|
13059
13062
|
|
|
13060
13063
|
/**
|
|
@@ -14194,7 +14197,7 @@ class ConversationsApi {
|
|
|
14194
14197
|
/**
|
|
14195
14198
|
* Conversations service.
|
|
14196
14199
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
14197
|
-
* @version
|
|
14200
|
+
* @version 97.0.0
|
|
14198
14201
|
*/
|
|
14199
14202
|
|
|
14200
14203
|
/**
|
|
@@ -17823,7 +17826,7 @@ class ConversationsApi {
|
|
|
17823
17826
|
|
|
17824
17827
|
/**
|
|
17825
17828
|
* Send message
|
|
17826
|
-
*
|
|
17829
|
+
* 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
17830
|
* @param {String} conversationId conversationId
|
|
17828
17831
|
* @param {String} communicationId communicationId
|
|
17829
17832
|
* @param {Object} body Message
|
|
@@ -18004,8 +18007,12 @@ class ConversationsApi {
|
|
|
18004
18007
|
* Create a Facebook Integration
|
|
18005
18008
|
*
|
|
18006
18009
|
* @param {Object} body FacebookIntegrationRequest
|
|
18010
|
+
* @param {Object} opts Optional parameters
|
|
18011
|
+
* @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
18012
|
*/
|
|
18008
|
-
postConversationsMessagingIntegrationsFacebook(body) {
|
|
18013
|
+
postConversationsMessagingIntegrationsFacebook(body, opts) {
|
|
18014
|
+
opts = opts || {};
|
|
18015
|
+
|
|
18009
18016
|
// verify the required parameter 'body' is set
|
|
18010
18017
|
if (body === undefined || body === null) {
|
|
18011
18018
|
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsFacebook';
|
|
@@ -18015,7 +18022,7 @@ class ConversationsApi {
|
|
|
18015
18022
|
'/api/v2/conversations/messaging/integrations/facebook',
|
|
18016
18023
|
'POST',
|
|
18017
18024
|
{ },
|
|
18018
|
-
{
|
|
18025
|
+
{ 'async': opts['async'] },
|
|
18019
18026
|
{ },
|
|
18020
18027
|
{ },
|
|
18021
18028
|
body,
|
|
@@ -18029,8 +18036,12 @@ class ConversationsApi {
|
|
|
18029
18036
|
* Create a LINE messenger Integration
|
|
18030
18037
|
*
|
|
18031
18038
|
* @param {Object} body LineIntegrationRequest
|
|
18039
|
+
* @param {Object} opts Optional parameters
|
|
18040
|
+
* @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
18041
|
*/
|
|
18033
|
-
postConversationsMessagingIntegrationsLine(body) {
|
|
18042
|
+
postConversationsMessagingIntegrationsLine(body, opts) {
|
|
18043
|
+
opts = opts || {};
|
|
18044
|
+
|
|
18034
18045
|
// verify the required parameter 'body' is set
|
|
18035
18046
|
if (body === undefined || body === null) {
|
|
18036
18047
|
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsLine';
|
|
@@ -18040,7 +18051,7 @@ class ConversationsApi {
|
|
|
18040
18051
|
'/api/v2/conversations/messaging/integrations/line',
|
|
18041
18052
|
'POST',
|
|
18042
18053
|
{ },
|
|
18043
|
-
{
|
|
18054
|
+
{ 'async': opts['async'] },
|
|
18044
18055
|
{ },
|
|
18045
18056
|
{ },
|
|
18046
18057
|
body,
|
|
@@ -18054,8 +18065,12 @@ class ConversationsApi {
|
|
|
18054
18065
|
* Create a Twitter Integration
|
|
18055
18066
|
*
|
|
18056
18067
|
* @param {Object} body TwitterIntegrationRequest
|
|
18068
|
+
* @param {Object} opts Optional parameters
|
|
18069
|
+
* @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
18070
|
*/
|
|
18058
|
-
postConversationsMessagingIntegrationsTwitter(body) {
|
|
18071
|
+
postConversationsMessagingIntegrationsTwitter(body, opts) {
|
|
18072
|
+
opts = opts || {};
|
|
18073
|
+
|
|
18059
18074
|
// verify the required parameter 'body' is set
|
|
18060
18075
|
if (body === undefined || body === null) {
|
|
18061
18076
|
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsTwitter';
|
|
@@ -18065,7 +18080,7 @@ class ConversationsApi {
|
|
|
18065
18080
|
'/api/v2/conversations/messaging/integrations/twitter',
|
|
18066
18081
|
'POST',
|
|
18067
18082
|
{ },
|
|
18068
|
-
{
|
|
18083
|
+
{ 'async': opts['async'] },
|
|
18069
18084
|
{ },
|
|
18070
18085
|
{ },
|
|
18071
18086
|
body,
|
|
@@ -18079,8 +18094,12 @@ class ConversationsApi {
|
|
|
18079
18094
|
* Create a WhatsApp Integration
|
|
18080
18095
|
* 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
18096
|
* @param {Object} body WhatsAppIntegrationRequest
|
|
18097
|
+
* @param {Object} opts Optional parameters
|
|
18098
|
+
* @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
18099
|
*/
|
|
18083
|
-
postConversationsMessagingIntegrationsWhatsapp(body) {
|
|
18100
|
+
postConversationsMessagingIntegrationsWhatsapp(body, opts) {
|
|
18101
|
+
opts = opts || {};
|
|
18102
|
+
|
|
18084
18103
|
// verify the required parameter 'body' is set
|
|
18085
18104
|
if (body === undefined || body === null) {
|
|
18086
18105
|
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsWhatsapp';
|
|
@@ -18090,7 +18109,7 @@ class ConversationsApi {
|
|
|
18090
18109
|
'/api/v2/conversations/messaging/integrations/whatsapp',
|
|
18091
18110
|
'POST',
|
|
18092
18111
|
{ },
|
|
18093
|
-
{
|
|
18112
|
+
{ 'async': opts['async'] },
|
|
18094
18113
|
{ },
|
|
18095
18114
|
{ },
|
|
18096
18115
|
body,
|
|
@@ -18236,7 +18255,7 @@ class DataExtensionsApi {
|
|
|
18236
18255
|
/**
|
|
18237
18256
|
* DataExtensions service.
|
|
18238
18257
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
18239
|
-
* @version
|
|
18258
|
+
* @version 97.0.0
|
|
18240
18259
|
*/
|
|
18241
18260
|
|
|
18242
18261
|
/**
|
|
@@ -18322,7 +18341,7 @@ class ExternalContactsApi {
|
|
|
18322
18341
|
/**
|
|
18323
18342
|
* ExternalContacts service.
|
|
18324
18343
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
18325
|
-
* @version
|
|
18344
|
+
* @version 97.0.0
|
|
18326
18345
|
*/
|
|
18327
18346
|
|
|
18328
18347
|
/**
|
|
@@ -19665,7 +19684,7 @@ class FaxApi {
|
|
|
19665
19684
|
/**
|
|
19666
19685
|
* Fax service.
|
|
19667
19686
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
19668
|
-
* @version
|
|
19687
|
+
* @version 97.0.0
|
|
19669
19688
|
*/
|
|
19670
19689
|
|
|
19671
19690
|
/**
|
|
@@ -19836,7 +19855,7 @@ class FlowsApi {
|
|
|
19836
19855
|
/**
|
|
19837
19856
|
* Flows service.
|
|
19838
19857
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
19839
|
-
* @version
|
|
19858
|
+
* @version 97.0.0
|
|
19840
19859
|
*/
|
|
19841
19860
|
|
|
19842
19861
|
/**
|
|
@@ -19907,7 +19926,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
19907
19926
|
/**
|
|
19908
19927
|
* GeneralDataProtectionRegulation service.
|
|
19909
19928
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
19910
|
-
* @version
|
|
19929
|
+
* @version 97.0.0
|
|
19911
19930
|
*/
|
|
19912
19931
|
|
|
19913
19932
|
/**
|
|
@@ -20037,7 +20056,7 @@ class GeolocationApi {
|
|
|
20037
20056
|
/**
|
|
20038
20057
|
* Geolocation service.
|
|
20039
20058
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
20040
|
-
* @version
|
|
20059
|
+
* @version 97.0.0
|
|
20041
20060
|
*/
|
|
20042
20061
|
|
|
20043
20062
|
/**
|
|
@@ -20168,7 +20187,7 @@ class GreetingsApi {
|
|
|
20168
20187
|
/**
|
|
20169
20188
|
* Greetings service.
|
|
20170
20189
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
20171
|
-
* @version
|
|
20190
|
+
* @version 97.0.0
|
|
20172
20191
|
*/
|
|
20173
20192
|
|
|
20174
20193
|
/**
|
|
@@ -20623,7 +20642,7 @@ class GroupsApi {
|
|
|
20623
20642
|
/**
|
|
20624
20643
|
* Groups service.
|
|
20625
20644
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
20626
|
-
* @version
|
|
20645
|
+
* @version 97.0.0
|
|
20627
20646
|
*/
|
|
20628
20647
|
|
|
20629
20648
|
/**
|
|
@@ -21028,7 +21047,7 @@ class IdentityProviderApi {
|
|
|
21028
21047
|
/**
|
|
21029
21048
|
* IdentityProvider service.
|
|
21030
21049
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
21031
|
-
* @version
|
|
21050
|
+
* @version 97.0.0
|
|
21032
21051
|
*/
|
|
21033
21052
|
|
|
21034
21053
|
/**
|
|
@@ -21784,7 +21803,7 @@ class IntegrationsApi {
|
|
|
21784
21803
|
/**
|
|
21785
21804
|
* Integrations service.
|
|
21786
21805
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
21787
|
-
* @version
|
|
21806
|
+
* @version 97.0.0
|
|
21788
21807
|
*/
|
|
21789
21808
|
|
|
21790
21809
|
/**
|
|
@@ -23276,7 +23295,7 @@ class JourneyApi {
|
|
|
23276
23295
|
/**
|
|
23277
23296
|
* Journey service.
|
|
23278
23297
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
23279
|
-
* @version
|
|
23298
|
+
* @version 97.0.0
|
|
23280
23299
|
*/
|
|
23281
23300
|
|
|
23282
23301
|
/**
|
|
@@ -23341,6 +23360,107 @@ class JourneyApi {
|
|
|
23341
23360
|
);
|
|
23342
23361
|
}
|
|
23343
23362
|
|
|
23363
|
+
/**
|
|
23364
|
+
* Retrieve segment assignments by customer ID.
|
|
23365
|
+
*
|
|
23366
|
+
* @param {String} customerIdType Type of ID used to identify customer (e.g. email, cookie, and phone).
|
|
23367
|
+
* @param {String} customerId Primary identifier of the customer to query for segment assignments.
|
|
23368
|
+
* @param {Object} opts Optional parameters
|
|
23369
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23370
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23371
|
+
* @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
|
|
23372
|
+
* @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
|
|
23373
|
+
*/
|
|
23374
|
+
getJourneyCustomerCustomerIdSegments(customerIdType, customerId, opts) {
|
|
23375
|
+
opts = opts || {};
|
|
23376
|
+
|
|
23377
|
+
// verify the required parameter 'customerIdType' is set
|
|
23378
|
+
if (customerIdType === undefined || customerIdType === null) {
|
|
23379
|
+
throw 'Missing the required parameter "customerIdType" when calling getJourneyCustomerCustomerIdSegments';
|
|
23380
|
+
}
|
|
23381
|
+
// verify the required parameter 'customerId' is set
|
|
23382
|
+
if (customerId === undefined || customerId === null) {
|
|
23383
|
+
throw 'Missing the required parameter "customerId" when calling getJourneyCustomerCustomerIdSegments';
|
|
23384
|
+
}
|
|
23385
|
+
|
|
23386
|
+
return this.apiClient.callApi(
|
|
23387
|
+
'/api/v2/journey/customers/{customerIdType}/{customerId}/segments',
|
|
23388
|
+
'GET',
|
|
23389
|
+
{ 'customerIdType': customerIdType,'customerId': customerId },
|
|
23390
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'segmentScope': opts['segmentScope'],'assignmentState': opts['assignmentState'] },
|
|
23391
|
+
{ },
|
|
23392
|
+
{ },
|
|
23393
|
+
null,
|
|
23394
|
+
['PureCloud OAuth'],
|
|
23395
|
+
['application/json'],
|
|
23396
|
+
['application/json']
|
|
23397
|
+
);
|
|
23398
|
+
}
|
|
23399
|
+
|
|
23400
|
+
/**
|
|
23401
|
+
* Retrieve segment assignments by external contact ID.
|
|
23402
|
+
*
|
|
23403
|
+
* @param {String} externalContactId ID of the external contact to query for segment assignments.
|
|
23404
|
+
* @param {Object} opts Optional parameters
|
|
23405
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23406
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23407
|
+
* @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
|
|
23408
|
+
* @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
|
|
23409
|
+
*/
|
|
23410
|
+
getJourneyExternalcontactSegments(externalContactId, opts) {
|
|
23411
|
+
opts = opts || {};
|
|
23412
|
+
|
|
23413
|
+
// verify the required parameter 'externalContactId' is set
|
|
23414
|
+
if (externalContactId === undefined || externalContactId === null) {
|
|
23415
|
+
throw 'Missing the required parameter "externalContactId" when calling getJourneyExternalcontactSegments';
|
|
23416
|
+
}
|
|
23417
|
+
|
|
23418
|
+
return this.apiClient.callApi(
|
|
23419
|
+
'/api/v2/journey/externalcontacts/{externalContactId}/segments',
|
|
23420
|
+
'GET',
|
|
23421
|
+
{ 'externalContactId': externalContactId },
|
|
23422
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'segmentScope': opts['segmentScope'],'assignmentState': opts['assignmentState'] },
|
|
23423
|
+
{ },
|
|
23424
|
+
{ },
|
|
23425
|
+
null,
|
|
23426
|
+
['PureCloud OAuth'],
|
|
23427
|
+
['application/json'],
|
|
23428
|
+
['application/json']
|
|
23429
|
+
);
|
|
23430
|
+
}
|
|
23431
|
+
|
|
23432
|
+
/**
|
|
23433
|
+
* Retrieve segment assignments by session ID.
|
|
23434
|
+
*
|
|
23435
|
+
* @param {String} sessionId ID of the session to query for segment assignments.
|
|
23436
|
+
* @param {Object} opts Optional parameters
|
|
23437
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23438
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23439
|
+
* @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
|
|
23440
|
+
* @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
|
|
23441
|
+
*/
|
|
23442
|
+
getJourneySessionSegments(sessionId, opts) {
|
|
23443
|
+
opts = opts || {};
|
|
23444
|
+
|
|
23445
|
+
// verify the required parameter 'sessionId' is set
|
|
23446
|
+
if (sessionId === undefined || sessionId === null) {
|
|
23447
|
+
throw 'Missing the required parameter "sessionId" when calling getJourneySessionSegments';
|
|
23448
|
+
}
|
|
23449
|
+
|
|
23450
|
+
return this.apiClient.callApi(
|
|
23451
|
+
'/api/v2/journey/sessions/{sessionId}/segments',
|
|
23452
|
+
'GET',
|
|
23453
|
+
{ 'sessionId': sessionId },
|
|
23454
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'segmentScope': opts['segmentScope'],'assignmentState': opts['assignmentState'] },
|
|
23455
|
+
{ },
|
|
23456
|
+
{ },
|
|
23457
|
+
null,
|
|
23458
|
+
['PureCloud OAuth'],
|
|
23459
|
+
['application/json'],
|
|
23460
|
+
['application/json']
|
|
23461
|
+
);
|
|
23462
|
+
}
|
|
23463
|
+
|
|
23344
23464
|
/**
|
|
23345
23465
|
* Update a single action target.
|
|
23346
23466
|
*
|
|
@@ -23395,13 +23515,42 @@ class JourneyApi {
|
|
|
23395
23515
|
);
|
|
23396
23516
|
}
|
|
23397
23517
|
|
|
23518
|
+
/**
|
|
23519
|
+
* Assign/Unassign a segment to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment.
|
|
23520
|
+
*
|
|
23521
|
+
* @param {String} externalContactId ID of the external contact to query for segment assignments.
|
|
23522
|
+
* @param {Object} opts Optional parameters
|
|
23523
|
+
* @param {Array.<Object>} opts.body
|
|
23524
|
+
*/
|
|
23525
|
+
postJourneyExternalcontactSegments(externalContactId, opts) {
|
|
23526
|
+
opts = opts || {};
|
|
23527
|
+
|
|
23528
|
+
// verify the required parameter 'externalContactId' is set
|
|
23529
|
+
if (externalContactId === undefined || externalContactId === null) {
|
|
23530
|
+
throw 'Missing the required parameter "externalContactId" when calling postJourneyExternalcontactSegments';
|
|
23531
|
+
}
|
|
23532
|
+
|
|
23533
|
+
return this.apiClient.callApi(
|
|
23534
|
+
'/api/v2/journey/externalcontacts/{externalContactId}/segments',
|
|
23535
|
+
'POST',
|
|
23536
|
+
{ 'externalContactId': externalContactId },
|
|
23537
|
+
{ },
|
|
23538
|
+
{ },
|
|
23539
|
+
{ },
|
|
23540
|
+
opts['body'],
|
|
23541
|
+
['PureCloud OAuth'],
|
|
23542
|
+
['application/json'],
|
|
23543
|
+
['application/json']
|
|
23544
|
+
);
|
|
23545
|
+
}
|
|
23546
|
+
|
|
23398
23547
|
}
|
|
23399
23548
|
|
|
23400
23549
|
class KnowledgeApi {
|
|
23401
23550
|
/**
|
|
23402
23551
|
* Knowledge service.
|
|
23403
23552
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
23404
|
-
* @version
|
|
23553
|
+
* @version 97.0.0
|
|
23405
23554
|
*/
|
|
23406
23555
|
|
|
23407
23556
|
/**
|
|
@@ -23717,7 +23866,7 @@ class KnowledgeApi {
|
|
|
23717
23866
|
}
|
|
23718
23867
|
|
|
23719
23868
|
/**
|
|
23720
|
-
* Get
|
|
23869
|
+
* Get all trainings information for a knowledgebase
|
|
23721
23870
|
*
|
|
23722
23871
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
23723
23872
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
@@ -23726,6 +23875,7 @@ class KnowledgeApi {
|
|
|
23726
23875
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23727
23876
|
* @param {String} opts.limit Number of entities to return. Maximum of 200.
|
|
23728
23877
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23878
|
+
* @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
|
|
23729
23879
|
*/
|
|
23730
23880
|
getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode, opts) {
|
|
23731
23881
|
opts = opts || {};
|
|
@@ -23743,7 +23893,7 @@ class KnowledgeApi {
|
|
|
23743
23893
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings',
|
|
23744
23894
|
'GET',
|
|
23745
23895
|
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
23746
|
-
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'] },
|
|
23896
|
+
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'knowledgeDocumentsState': opts['knowledgeDocumentsState'] },
|
|
23747
23897
|
{ },
|
|
23748
23898
|
{ },
|
|
23749
23899
|
null,
|
|
@@ -24121,7 +24271,7 @@ class LanguageUnderstandingApi {
|
|
|
24121
24271
|
/**
|
|
24122
24272
|
* LanguageUnderstanding service.
|
|
24123
24273
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
24124
|
-
* @version
|
|
24274
|
+
* @version 97.0.0
|
|
24125
24275
|
*/
|
|
24126
24276
|
|
|
24127
24277
|
/**
|
|
@@ -24687,7 +24837,7 @@ class LanguagesApi {
|
|
|
24687
24837
|
/**
|
|
24688
24838
|
* Languages service.
|
|
24689
24839
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
24690
|
-
* @version
|
|
24840
|
+
* @version 97.0.0
|
|
24691
24841
|
*/
|
|
24692
24842
|
|
|
24693
24843
|
/**
|
|
@@ -24955,7 +25105,7 @@ class LicenseApi {
|
|
|
24955
25105
|
/**
|
|
24956
25106
|
* License service.
|
|
24957
25107
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
24958
|
-
* @version
|
|
25108
|
+
* @version 97.0.0
|
|
24959
25109
|
*/
|
|
24960
25110
|
|
|
24961
25111
|
/**
|
|
@@ -25193,7 +25343,7 @@ class LocationsApi {
|
|
|
25193
25343
|
/**
|
|
25194
25344
|
* Locations service.
|
|
25195
25345
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
25196
|
-
* @version
|
|
25346
|
+
* @version 97.0.0
|
|
25197
25347
|
*/
|
|
25198
25348
|
|
|
25199
25349
|
/**
|
|
@@ -25429,7 +25579,7 @@ class MobileDevicesApi {
|
|
|
25429
25579
|
/**
|
|
25430
25580
|
* MobileDevices service.
|
|
25431
25581
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
25432
|
-
* @version
|
|
25582
|
+
* @version 97.0.0
|
|
25433
25583
|
*/
|
|
25434
25584
|
|
|
25435
25585
|
/**
|
|
@@ -25580,7 +25730,7 @@ class NotificationsApi {
|
|
|
25580
25730
|
/**
|
|
25581
25731
|
* Notifications service.
|
|
25582
25732
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
25583
|
-
* @version
|
|
25733
|
+
* @version 97.0.0
|
|
25584
25734
|
*/
|
|
25585
25735
|
|
|
25586
25736
|
/**
|
|
@@ -25779,7 +25929,7 @@ class OAuthApi {
|
|
|
25779
25929
|
/**
|
|
25780
25930
|
* OAuth service.
|
|
25781
25931
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
25782
|
-
* @version
|
|
25932
|
+
* @version 97.0.0
|
|
25783
25933
|
*/
|
|
25784
25934
|
|
|
25785
25935
|
/**
|
|
@@ -26137,7 +26287,7 @@ class ObjectsApi {
|
|
|
26137
26287
|
/**
|
|
26138
26288
|
* Objects service.
|
|
26139
26289
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
26140
|
-
* @version
|
|
26290
|
+
* @version 97.0.0
|
|
26141
26291
|
*/
|
|
26142
26292
|
|
|
26143
26293
|
/**
|
|
@@ -26378,7 +26528,7 @@ class OrganizationApi {
|
|
|
26378
26528
|
/**
|
|
26379
26529
|
* Organization service.
|
|
26380
26530
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
26381
|
-
* @version
|
|
26531
|
+
* @version 97.0.0
|
|
26382
26532
|
*/
|
|
26383
26533
|
|
|
26384
26534
|
/**
|
|
@@ -26633,7 +26783,7 @@ class OrganizationAuthorizationApi {
|
|
|
26633
26783
|
/**
|
|
26634
26784
|
* OrganizationAuthorization service.
|
|
26635
26785
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
26636
|
-
* @version
|
|
26786
|
+
* @version 97.0.0
|
|
26637
26787
|
*/
|
|
26638
26788
|
|
|
26639
26789
|
/**
|
|
@@ -27343,7 +27493,7 @@ class OutboundApi {
|
|
|
27343
27493
|
/**
|
|
27344
27494
|
* Outbound service.
|
|
27345
27495
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
27346
|
-
* @version
|
|
27496
|
+
* @version 97.0.0
|
|
27347
27497
|
*/
|
|
27348
27498
|
|
|
27349
27499
|
/**
|
|
@@ -30317,7 +30467,7 @@ class PresenceApi {
|
|
|
30317
30467
|
/**
|
|
30318
30468
|
* Presence service.
|
|
30319
30469
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
30320
|
-
* @version
|
|
30470
|
+
* @version 97.0.0
|
|
30321
30471
|
*/
|
|
30322
30472
|
|
|
30323
30473
|
/**
|
|
@@ -30664,7 +30814,7 @@ class QualityApi {
|
|
|
30664
30814
|
/**
|
|
30665
30815
|
* Quality service.
|
|
30666
30816
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
30667
|
-
* @version
|
|
30817
|
+
* @version 97.0.0
|
|
30668
30818
|
*/
|
|
30669
30819
|
|
|
30670
30820
|
/**
|
|
@@ -30878,8 +31028,8 @@ class QualityApi {
|
|
|
30878
31028
|
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
30879
31029
|
* @param {String} opts.nextPage next page token
|
|
30880
31030
|
* @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.
|
|
31031
|
+
* @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
|
|
31032
|
+
* @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
31033
|
* @param {Array.<String>} opts.agentUserId user id of agent requested
|
|
30884
31034
|
* @param {String} opts.evaluatorUserId user id of the evaluator
|
|
30885
31035
|
* @param {String} opts.name name
|
|
@@ -30945,8 +31095,8 @@ class QualityApi {
|
|
|
30945
31095
|
* @param {String} opts.nextPage next page token
|
|
30946
31096
|
* @param {String} opts.previousPage Previous page token
|
|
30947
31097
|
* @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.
|
|
31098
|
+
* @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
|
|
31099
|
+
* @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
31100
|
*/
|
|
30951
31101
|
getQualityCalibrations(calibratorId, opts) {
|
|
30952
31102
|
opts = opts || {};
|
|
@@ -31116,8 +31266,8 @@ class QualityApi {
|
|
|
31116
31266
|
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
31117
31267
|
* @param {String} opts.nextPage next page token
|
|
31118
31268
|
* @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.
|
|
31269
|
+
* @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
|
|
31270
|
+
* @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
31271
|
* @param {String} opts.name Evaluator name
|
|
31122
31272
|
* @param {Array.<String>} opts.permission permission strings
|
|
31123
31273
|
* @param {String} opts.group group id
|
|
@@ -32361,7 +32511,7 @@ class RecordingApi {
|
|
|
32361
32511
|
/**
|
|
32362
32512
|
* Recording service.
|
|
32363
32513
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
32364
|
-
* @version
|
|
32514
|
+
* @version 97.0.0
|
|
32365
32515
|
*/
|
|
32366
32516
|
|
|
32367
32517
|
/**
|
|
@@ -33607,7 +33757,7 @@ class ResponseManagementApi {
|
|
|
33607
33757
|
/**
|
|
33608
33758
|
* ResponseManagement service.
|
|
33609
33759
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
33610
|
-
* @version
|
|
33760
|
+
* @version 97.0.0
|
|
33611
33761
|
*/
|
|
33612
33762
|
|
|
33613
33763
|
/**
|
|
@@ -33932,7 +34082,7 @@ class RoutingApi {
|
|
|
33932
34082
|
/**
|
|
33933
34083
|
* Routing service.
|
|
33934
34084
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
33935
|
-
* @version
|
|
34085
|
+
* @version 97.0.0
|
|
33936
34086
|
*/
|
|
33937
34087
|
|
|
33938
34088
|
/**
|
|
@@ -36230,7 +36380,7 @@ class SCIMApi {
|
|
|
36230
36380
|
/**
|
|
36231
36381
|
* SCIM service.
|
|
36232
36382
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
36233
|
-
* @version
|
|
36383
|
+
* @version 97.0.0
|
|
36234
36384
|
*/
|
|
36235
36385
|
|
|
36236
36386
|
/**
|
|
@@ -36366,8 +36516,8 @@ class SCIMApi {
|
|
|
36366
36516
|
*
|
|
36367
36517
|
* @param {String} groupId The ID of a group. Returned with GET /api/v2/scim/groups.
|
|
36368
36518
|
* @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.
|
|
36519
|
+
* @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.
|
|
36520
|
+
* @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
36521
|
* @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
36522
|
*/
|
|
36373
36523
|
getScimGroup(groupId, opts) {
|
|
@@ -36397,9 +36547,9 @@ class SCIMApi {
|
|
|
36397
36547
|
*
|
|
36398
36548
|
* @param {Object} opts Optional parameters
|
|
36399
36549
|
* @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.
|
|
36550
|
+
* @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)
|
|
36551
|
+
* @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.
|
|
36552
|
+
* @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
36553
|
* @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
36554
|
*/
|
|
36405
36555
|
getScimGroups(opts) {
|
|
@@ -36543,9 +36693,9 @@ class SCIMApi {
|
|
|
36543
36693
|
*
|
|
36544
36694
|
* @param {String} userId The ID of a user. Returned with GET /api/v2/scim/users.
|
|
36545
36695
|
* @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
|
|
36696
|
+
* @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.
|
|
36697
|
+
* @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.
|
|
36698
|
+
* @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
36699
|
*/
|
|
36550
36700
|
getScimUser(userId, opts) {
|
|
36551
36701
|
opts = opts || {};
|
|
@@ -36574,9 +36724,9 @@ class SCIMApi {
|
|
|
36574
36724
|
* 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
36725
|
* @param {Object} opts Optional parameters
|
|
36576
36726
|
* @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.
|
|
36727
|
+
* @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)
|
|
36728
|
+
* @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.
|
|
36729
|
+
* @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
36730
|
* @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
36731
|
*/
|
|
36582
36732
|
getScimUsers(opts) {
|
|
@@ -36602,9 +36752,9 @@ class SCIMApi {
|
|
|
36602
36752
|
*
|
|
36603
36753
|
* @param {String} groupId The ID of a group. Returned with GET /api/v2/scim/v2/groups.
|
|
36604
36754
|
* @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
|
|
36755
|
+
* @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.
|
|
36756
|
+
* @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.
|
|
36757
|
+
* @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
36758
|
*/
|
|
36609
36759
|
getScimV2Group(groupId, opts) {
|
|
36610
36760
|
opts = opts || {};
|
|
@@ -36634,9 +36784,9 @@ class SCIMApi {
|
|
|
36634
36784
|
* @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
36785
|
* @param {Object} opts Optional parameters
|
|
36636
36786
|
* @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.
|
|
36787
|
+
* @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)
|
|
36788
|
+
* @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.
|
|
36789
|
+
* @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
36790
|
*/
|
|
36641
36791
|
getScimV2Groups(filter, opts) {
|
|
36642
36792
|
opts = opts || {};
|
|
@@ -36783,8 +36933,8 @@ class SCIMApi {
|
|
|
36783
36933
|
*
|
|
36784
36934
|
* @param {String} userId The ID of a user. Returned with GET /api/v2/scim/v2/users.
|
|
36785
36935
|
* @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.
|
|
36936
|
+
* @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.
|
|
36937
|
+
* @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
36938
|
* @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
36939
|
*/
|
|
36790
36940
|
getScimV2User(userId, opts) {
|
|
@@ -36814,9 +36964,9 @@ class SCIMApi {
|
|
|
36814
36964
|
* 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
36965
|
* @param {Object} opts Optional parameters
|
|
36816
36966
|
* @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.
|
|
36967
|
+
* @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)
|
|
36968
|
+
* @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.
|
|
36969
|
+
* @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
36970
|
* @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
36971
|
*/
|
|
36822
36972
|
getScimV2Users(opts) {
|
|
@@ -36974,8 +37124,8 @@ class SCIMApi {
|
|
|
36974
37124
|
}
|
|
36975
37125
|
|
|
36976
37126
|
/**
|
|
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}
|
|
37127
|
+
* Create a group
|
|
37128
|
+
* 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
37129
|
* @param {Object} body The information used to create a group.
|
|
36980
37130
|
*/
|
|
36981
37131
|
postScimGroups(body) {
|
|
@@ -37026,7 +37176,7 @@ class SCIMApi {
|
|
|
37026
37176
|
/**
|
|
37027
37177
|
* Create a group
|
|
37028
37178
|
* 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
|
|
37179
|
+
* @param {Object} body The information used to create a group.
|
|
37030
37180
|
*/
|
|
37031
37181
|
postScimV2Groups(body) {
|
|
37032
37182
|
// verify the required parameter 'body' is set
|
|
@@ -37215,7 +37365,7 @@ class ScriptsApi {
|
|
|
37215
37365
|
/**
|
|
37216
37366
|
* Scripts service.
|
|
37217
37367
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
37218
|
-
* @version
|
|
37368
|
+
* @version 97.0.0
|
|
37219
37369
|
*/
|
|
37220
37370
|
|
|
37221
37371
|
/**
|
|
@@ -37568,7 +37718,7 @@ class SearchApi {
|
|
|
37568
37718
|
/**
|
|
37569
37719
|
* Search service.
|
|
37570
37720
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
37571
|
-
* @version
|
|
37721
|
+
* @version 97.0.0
|
|
37572
37722
|
*/
|
|
37573
37723
|
|
|
37574
37724
|
/**
|
|
@@ -38078,7 +38228,7 @@ class SpeechTextAnalyticsApi {
|
|
|
38078
38228
|
/**
|
|
38079
38229
|
* SpeechTextAnalytics service.
|
|
38080
38230
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
38081
|
-
* @version
|
|
38231
|
+
* @version 97.0.0
|
|
38082
38232
|
*/
|
|
38083
38233
|
|
|
38084
38234
|
/**
|
|
@@ -38154,7 +38304,7 @@ class StationsApi {
|
|
|
38154
38304
|
/**
|
|
38155
38305
|
* Stations service.
|
|
38156
38306
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
38157
|
-
* @version
|
|
38307
|
+
* @version 97.0.0
|
|
38158
38308
|
*/
|
|
38159
38309
|
|
|
38160
38310
|
/**
|
|
@@ -38301,7 +38451,7 @@ class SuggestApi {
|
|
|
38301
38451
|
/**
|
|
38302
38452
|
* Suggest service.
|
|
38303
38453
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
38304
|
-
* @version
|
|
38454
|
+
* @version 97.0.0
|
|
38305
38455
|
*/
|
|
38306
38456
|
|
|
38307
38457
|
/**
|
|
@@ -38440,7 +38590,7 @@ class TelephonyApi {
|
|
|
38440
38590
|
/**
|
|
38441
38591
|
* Telephony service.
|
|
38442
38592
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
38443
|
-
* @version
|
|
38593
|
+
* @version 97.0.0
|
|
38444
38594
|
*/
|
|
38445
38595
|
|
|
38446
38596
|
/**
|
|
@@ -38458,8 +38608,8 @@ class TelephonyApi {
|
|
|
38458
38608
|
/**
|
|
38459
38609
|
* Fetch SIP metadata
|
|
38460
38610
|
* 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.
|
|
38611
|
+
* @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
|
|
38612
|
+
* @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
38613
|
* @param {Object} opts Optional parameters
|
|
38464
38614
|
* @param {String} opts.callId unique identification of the placed call
|
|
38465
38615
|
* @param {String} opts.toUser User to who the call was placed
|
|
@@ -38548,7 +38698,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
38548
38698
|
/**
|
|
38549
38699
|
* TelephonyProvidersEdge service.
|
|
38550
38700
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
38551
|
-
* @version
|
|
38701
|
+
* @version 97.0.0
|
|
38552
38702
|
*/
|
|
38553
38703
|
|
|
38554
38704
|
/**
|
|
@@ -42125,7 +42275,7 @@ class TextbotsApi {
|
|
|
42125
42275
|
/**
|
|
42126
42276
|
* Textbots service.
|
|
42127
42277
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
42128
|
-
* @version
|
|
42278
|
+
* @version 97.0.0
|
|
42129
42279
|
*/
|
|
42130
42280
|
|
|
42131
42281
|
/**
|
|
@@ -42171,7 +42321,7 @@ class TokensApi {
|
|
|
42171
42321
|
/**
|
|
42172
42322
|
* Tokens service.
|
|
42173
42323
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
42174
|
-
* @version
|
|
42324
|
+
* @version 97.0.0
|
|
42175
42325
|
*/
|
|
42176
42326
|
|
|
42177
42327
|
/**
|
|
@@ -42257,7 +42407,7 @@ class UploadsApi {
|
|
|
42257
42407
|
/**
|
|
42258
42408
|
* Uploads service.
|
|
42259
42409
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
42260
|
-
* @version
|
|
42410
|
+
* @version 97.0.0
|
|
42261
42411
|
*/
|
|
42262
42412
|
|
|
42263
42413
|
/**
|
|
@@ -42303,7 +42453,7 @@ class UsageApi {
|
|
|
42303
42453
|
/**
|
|
42304
42454
|
* Usage service.
|
|
42305
42455
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
42306
|
-
* @version
|
|
42456
|
+
* @version 97.0.0
|
|
42307
42457
|
*/
|
|
42308
42458
|
|
|
42309
42459
|
/**
|
|
@@ -42370,154 +42520,11 @@ class UsageApi {
|
|
|
42370
42520
|
|
|
42371
42521
|
}
|
|
42372
42522
|
|
|
42373
|
-
class UserDevelopmentApi {
|
|
42374
|
-
/**
|
|
42375
|
-
* UserDevelopment service.
|
|
42376
|
-
* @module purecloud-platform-client-v2/api/UserDevelopmentApi
|
|
42377
|
-
* @version 94.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
42523
|
class UserRecordingsApi {
|
|
42517
42524
|
/**
|
|
42518
42525
|
* UserRecordings service.
|
|
42519
42526
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
42520
|
-
* @version
|
|
42527
|
+
* @version 97.0.0
|
|
42521
42528
|
*/
|
|
42522
42529
|
|
|
42523
42530
|
/**
|
|
@@ -42701,7 +42708,7 @@ class UsersApi {
|
|
|
42701
42708
|
/**
|
|
42702
42709
|
* Users service.
|
|
42703
42710
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
42704
|
-
* @version
|
|
42711
|
+
* @version 97.0.0
|
|
42705
42712
|
*/
|
|
42706
42713
|
|
|
42707
42714
|
/**
|
|
@@ -43745,6 +43752,103 @@ class UsersApi {
|
|
|
43745
43752
|
);
|
|
43746
43753
|
}
|
|
43747
43754
|
|
|
43755
|
+
/**
|
|
43756
|
+
* Get list of Development Activities
|
|
43757
|
+
* Either moduleId or userId is required. Results are filtered based on the applicable permissions.
|
|
43758
|
+
* @param {Object} opts Optional parameters
|
|
43759
|
+
* @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.
|
|
43760
|
+
* @param {String} opts.moduleId Specifies the ID of the learning module.
|
|
43761
|
+
* @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
|
|
43762
|
+
* @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
|
|
43763
|
+
* @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
|
|
43764
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
43765
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
43766
|
+
* @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)
|
|
43767
|
+
* @param {Array.<String>} opts.types Specifies the activity types.
|
|
43768
|
+
* @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
|
|
43769
|
+
* @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.
|
|
43770
|
+
*/
|
|
43771
|
+
getUsersDevelopmentActivities(opts) {
|
|
43772
|
+
opts = opts || {};
|
|
43773
|
+
|
|
43774
|
+
|
|
43775
|
+
return this.apiClient.callApi(
|
|
43776
|
+
'/api/v2/users/development/activities',
|
|
43777
|
+
'GET',
|
|
43778
|
+
{ },
|
|
43779
|
+
{ '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') },
|
|
43780
|
+
{ },
|
|
43781
|
+
{ },
|
|
43782
|
+
null,
|
|
43783
|
+
['PureCloud OAuth'],
|
|
43784
|
+
['application/json'],
|
|
43785
|
+
['application/json']
|
|
43786
|
+
);
|
|
43787
|
+
}
|
|
43788
|
+
|
|
43789
|
+
/**
|
|
43790
|
+
* Get list of Development Activities for current user
|
|
43791
|
+
* Results are filtered based on the applicable permissions.
|
|
43792
|
+
* @param {Object} opts Optional parameters
|
|
43793
|
+
* @param {String} opts.moduleId Specifies the ID of the learning module.
|
|
43794
|
+
* @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
|
|
43795
|
+
* @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
|
|
43796
|
+
* @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
|
|
43797
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
43798
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
43799
|
+
* @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)
|
|
43800
|
+
* @param {Array.<String>} opts.types Specifies the activity types.
|
|
43801
|
+
* @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
|
|
43802
|
+
* @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.
|
|
43803
|
+
*/
|
|
43804
|
+
getUsersDevelopmentActivitiesMe(opts) {
|
|
43805
|
+
opts = opts || {};
|
|
43806
|
+
|
|
43807
|
+
|
|
43808
|
+
return this.apiClient.callApi(
|
|
43809
|
+
'/api/v2/users/development/activities/me',
|
|
43810
|
+
'GET',
|
|
43811
|
+
{ },
|
|
43812
|
+
{ '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') },
|
|
43813
|
+
{ },
|
|
43814
|
+
{ },
|
|
43815
|
+
null,
|
|
43816
|
+
['PureCloud OAuth'],
|
|
43817
|
+
['application/json'],
|
|
43818
|
+
['application/json']
|
|
43819
|
+
);
|
|
43820
|
+
}
|
|
43821
|
+
|
|
43822
|
+
/**
|
|
43823
|
+
* Get a Development Activity
|
|
43824
|
+
*
|
|
43825
|
+
* @param {String} activityId Specifies the activity ID, maps to either assignment or appointment ID
|
|
43826
|
+
* @param {Object} type Specifies the activity type.
|
|
43827
|
+
*/
|
|
43828
|
+
getUsersDevelopmentActivity(activityId, type) {
|
|
43829
|
+
// verify the required parameter 'activityId' is set
|
|
43830
|
+
if (activityId === undefined || activityId === null) {
|
|
43831
|
+
throw 'Missing the required parameter "activityId" when calling getUsersDevelopmentActivity';
|
|
43832
|
+
}
|
|
43833
|
+
// verify the required parameter 'type' is set
|
|
43834
|
+
if (type === undefined || type === null) {
|
|
43835
|
+
throw 'Missing the required parameter "type" when calling getUsersDevelopmentActivity';
|
|
43836
|
+
}
|
|
43837
|
+
|
|
43838
|
+
return this.apiClient.callApi(
|
|
43839
|
+
'/api/v2/users/development/activities/{activityId}',
|
|
43840
|
+
'GET',
|
|
43841
|
+
{ 'activityId': activityId },
|
|
43842
|
+
{ 'type': type },
|
|
43843
|
+
{ },
|
|
43844
|
+
{ },
|
|
43845
|
+
null,
|
|
43846
|
+
['PureCloud OAuth'],
|
|
43847
|
+
['application/json'],
|
|
43848
|
+
['application/json']
|
|
43849
|
+
);
|
|
43850
|
+
}
|
|
43851
|
+
|
|
43748
43852
|
/**
|
|
43749
43853
|
* Get current user details.
|
|
43750
43854
|
* This request is not valid when using the Client Credentials OAuth grant.
|
|
@@ -44431,6 +44535,31 @@ class UsersApi {
|
|
|
44431
44535
|
);
|
|
44432
44536
|
}
|
|
44433
44537
|
|
|
44538
|
+
/**
|
|
44539
|
+
* Retrieve aggregated development activity data
|
|
44540
|
+
* Results are filtered based on the applicable permissions.
|
|
44541
|
+
* @param {Object} body Aggregate Request
|
|
44542
|
+
*/
|
|
44543
|
+
postUsersDevelopmentActivitiesAggregatesQuery(body) {
|
|
44544
|
+
// verify the required parameter 'body' is set
|
|
44545
|
+
if (body === undefined || body === null) {
|
|
44546
|
+
throw 'Missing the required parameter "body" when calling postUsersDevelopmentActivitiesAggregatesQuery';
|
|
44547
|
+
}
|
|
44548
|
+
|
|
44549
|
+
return this.apiClient.callApi(
|
|
44550
|
+
'/api/v2/users/development/activities/aggregates/query',
|
|
44551
|
+
'POST',
|
|
44552
|
+
{ },
|
|
44553
|
+
{ },
|
|
44554
|
+
{ },
|
|
44555
|
+
{ },
|
|
44556
|
+
body,
|
|
44557
|
+
['PureCloud OAuth'],
|
|
44558
|
+
['application/json'],
|
|
44559
|
+
['application/json']
|
|
44560
|
+
);
|
|
44561
|
+
}
|
|
44562
|
+
|
|
44434
44563
|
/**
|
|
44435
44564
|
* Change your password
|
|
44436
44565
|
*
|
|
@@ -44792,7 +44921,7 @@ class UtilitiesApi {
|
|
|
44792
44921
|
/**
|
|
44793
44922
|
* Utilities service.
|
|
44794
44923
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
44795
|
-
* @version
|
|
44924
|
+
* @version 97.0.0
|
|
44796
44925
|
*/
|
|
44797
44926
|
|
|
44798
44927
|
/**
|
|
@@ -44903,7 +45032,7 @@ class VoicemailApi {
|
|
|
44903
45032
|
/**
|
|
44904
45033
|
* Voicemail service.
|
|
44905
45034
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
44906
|
-
* @version
|
|
45035
|
+
* @version 97.0.0
|
|
44907
45036
|
*/
|
|
44908
45037
|
|
|
44909
45038
|
/**
|
|
@@ -45540,7 +45669,7 @@ class WebChatApi {
|
|
|
45540
45669
|
/**
|
|
45541
45670
|
* WebChat service.
|
|
45542
45671
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
45543
|
-
* @version
|
|
45672
|
+
* @version 97.0.0
|
|
45544
45673
|
*/
|
|
45545
45674
|
|
|
45546
45675
|
/**
|
|
@@ -46084,7 +46213,7 @@ class WidgetsApi {
|
|
|
46084
46213
|
/**
|
|
46085
46214
|
* Widgets service.
|
|
46086
46215
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
46087
|
-
* @version
|
|
46216
|
+
* @version 97.0.0
|
|
46088
46217
|
*/
|
|
46089
46218
|
|
|
46090
46219
|
/**
|
|
@@ -46230,7 +46359,7 @@ class WorkforceManagementApi {
|
|
|
46230
46359
|
/**
|
|
46231
46360
|
* WorkforceManagement service.
|
|
46232
46361
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
46233
|
-
* @version
|
|
46362
|
+
* @version 97.0.0
|
|
46234
46363
|
*/
|
|
46235
46364
|
|
|
46236
46365
|
/**
|
|
@@ -46485,166 +46614,6 @@ class WorkforceManagementApi {
|
|
|
46485
46614
|
);
|
|
46486
46615
|
}
|
|
46487
46616
|
|
|
46488
|
-
/**
|
|
46489
|
-
* Deprecated/Gone: Use the new business unit activity code resources
|
|
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
|
|
46580
|
-
*
|
|
46581
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
46582
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
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
|
|
46619
|
-
*/
|
|
46620
|
-
deleteWorkforcemanagementManagementunitWeekShorttermforecast(managementUnitId, weekDateId, forecastId) {
|
|
46621
|
-
// verify the required parameter 'managementUnitId' is set
|
|
46622
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
46623
|
-
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWeekShorttermforecast';
|
|
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';
|
|
46628
|
-
}
|
|
46629
|
-
// verify the required parameter 'forecastId' is set
|
|
46630
|
-
if (forecastId === undefined || forecastId === null) {
|
|
46631
|
-
throw 'Missing the required parameter "forecastId" when calling deleteWorkforcemanagementManagementunitWeekShorttermforecast';
|
|
46632
|
-
}
|
|
46633
|
-
|
|
46634
|
-
return this.apiClient.callApi(
|
|
46635
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}',
|
|
46636
|
-
'DELETE',
|
|
46637
|
-
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
|
|
46638
|
-
{ },
|
|
46639
|
-
{ },
|
|
46640
|
-
{ },
|
|
46641
|
-
null,
|
|
46642
|
-
['PureCloud OAuth'],
|
|
46643
|
-
['application/json'],
|
|
46644
|
-
['application/json']
|
|
46645
|
-
);
|
|
46646
|
-
}
|
|
46647
|
-
|
|
46648
46617
|
/**
|
|
46649
46618
|
* Delete a work plan
|
|
46650
46619
|
*
|
|
@@ -46675,6 +46644,36 @@ class WorkforceManagementApi {
|
|
|
46675
46644
|
);
|
|
46676
46645
|
}
|
|
46677
46646
|
|
|
46647
|
+
/**
|
|
46648
|
+
* Delete a work plan rotation
|
|
46649
|
+
*
|
|
46650
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
46651
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to be deleted
|
|
46652
|
+
*/
|
|
46653
|
+
deleteWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId) {
|
|
46654
|
+
// verify the required parameter 'managementUnitId' is set
|
|
46655
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
46656
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWorkplanrotation';
|
|
46657
|
+
}
|
|
46658
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
46659
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
46660
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling deleteWorkforcemanagementManagementunitWorkplanrotation';
|
|
46661
|
+
}
|
|
46662
|
+
|
|
46663
|
+
return this.apiClient.callApi(
|
|
46664
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
|
|
46665
|
+
'DELETE',
|
|
46666
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
46667
|
+
{ },
|
|
46668
|
+
{ },
|
|
46669
|
+
{ },
|
|
46670
|
+
null,
|
|
46671
|
+
['PureCloud OAuth'],
|
|
46672
|
+
['application/json'],
|
|
46673
|
+
['application/json']
|
|
46674
|
+
);
|
|
46675
|
+
}
|
|
46676
|
+
|
|
46678
46677
|
/**
|
|
46679
46678
|
* Get a list of UserScheduleAdherence records for the requested users
|
|
46680
46679
|
*
|
|
@@ -47479,36 +47478,6 @@ class WorkforceManagementApi {
|
|
|
47479
47478
|
);
|
|
47480
47479
|
}
|
|
47481
47480
|
|
|
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
47481
|
/**
|
|
47513
47482
|
* Get activity codes
|
|
47514
47483
|
*
|
|
@@ -47627,196 +47596,6 @@ class WorkforceManagementApi {
|
|
|
47627
47596
|
);
|
|
47628
47597
|
}
|
|
47629
47598
|
|
|
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
47599
|
/**
|
|
47821
47600
|
* Gets a summary of all shift trades in the matched state
|
|
47822
47601
|
*
|
|
@@ -48001,41 +47780,6 @@ class WorkforceManagementApi {
|
|
|
48001
47780
|
);
|
|
48002
47781
|
}
|
|
48003
47782
|
|
|
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
47783
|
/**
|
|
48040
47784
|
* Deprecated. Use the equivalent business unit resource instead. Get the list of schedules in a week in management unit
|
|
48041
47785
|
*
|
|
@@ -48106,71 +47850,6 @@ class WorkforceManagementApi {
|
|
|
48106
47850
|
);
|
|
48107
47851
|
}
|
|
48108
47852
|
|
|
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
47853
|
/**
|
|
48175
47854
|
* Get a work plan
|
|
48176
47855
|
*
|
|
@@ -48201,6 +47880,65 @@ class WorkforceManagementApi {
|
|
|
48201
47880
|
);
|
|
48202
47881
|
}
|
|
48203
47882
|
|
|
47883
|
+
/**
|
|
47884
|
+
* Get a work plan rotation
|
|
47885
|
+
*
|
|
47886
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
47887
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to fetch
|
|
47888
|
+
*/
|
|
47889
|
+
getWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId) {
|
|
47890
|
+
// verify the required parameter 'managementUnitId' is set
|
|
47891
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
47892
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplanrotation';
|
|
47893
|
+
}
|
|
47894
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
47895
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
47896
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling getWorkforcemanagementManagementunitWorkplanrotation';
|
|
47897
|
+
}
|
|
47898
|
+
|
|
47899
|
+
return this.apiClient.callApi(
|
|
47900
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
|
|
47901
|
+
'GET',
|
|
47902
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
47903
|
+
{ },
|
|
47904
|
+
{ },
|
|
47905
|
+
{ },
|
|
47906
|
+
null,
|
|
47907
|
+
['PureCloud OAuth'],
|
|
47908
|
+
['application/json'],
|
|
47909
|
+
['application/json']
|
|
47910
|
+
);
|
|
47911
|
+
}
|
|
47912
|
+
|
|
47913
|
+
/**
|
|
47914
|
+
* Get work plan rotations
|
|
47915
|
+
*
|
|
47916
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
47917
|
+
* @param {Object} opts Optional parameters
|
|
47918
|
+
* @param {Array.<String>} opts.expand
|
|
47919
|
+
*/
|
|
47920
|
+
getWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, opts) {
|
|
47921
|
+
opts = opts || {};
|
|
47922
|
+
|
|
47923
|
+
// verify the required parameter 'managementUnitId' is set
|
|
47924
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
47925
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplanrotations';
|
|
47926
|
+
}
|
|
47927
|
+
|
|
47928
|
+
return this.apiClient.callApi(
|
|
47929
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
|
|
47930
|
+
'GET',
|
|
47931
|
+
{ 'managementUnitId': managementUnitId },
|
|
47932
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
47933
|
+
{ },
|
|
47934
|
+
{ },
|
|
47935
|
+
null,
|
|
47936
|
+
['PureCloud OAuth'],
|
|
47937
|
+
['application/json'],
|
|
47938
|
+
['application/json']
|
|
47939
|
+
);
|
|
47940
|
+
}
|
|
47941
|
+
|
|
48204
47942
|
/**
|
|
48205
47943
|
* Get work plans
|
|
48206
47944
|
*
|
|
@@ -48590,129 +48328,6 @@ class WorkforceManagementApi {
|
|
|
48590
48328
|
);
|
|
48591
48329
|
}
|
|
48592
48330
|
|
|
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
48331
|
/**
|
|
48717
48332
|
* Update a time off request
|
|
48718
48333
|
*
|
|
@@ -48752,41 +48367,6 @@ class WorkforceManagementApi {
|
|
|
48752
48367
|
);
|
|
48753
48368
|
}
|
|
48754
48369
|
|
|
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
48370
|
/**
|
|
48791
48371
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
48792
48372
|
*
|
|
@@ -48861,6 +48441,40 @@ class WorkforceManagementApi {
|
|
|
48861
48441
|
);
|
|
48862
48442
|
}
|
|
48863
48443
|
|
|
48444
|
+
/**
|
|
48445
|
+
* Update a work plan rotation
|
|
48446
|
+
*
|
|
48447
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
48448
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to update
|
|
48449
|
+
* @param {Object} opts Optional parameters
|
|
48450
|
+
* @param {Object} opts.body body
|
|
48451
|
+
*/
|
|
48452
|
+
patchWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId, opts) {
|
|
48453
|
+
opts = opts || {};
|
|
48454
|
+
|
|
48455
|
+
// verify the required parameter 'managementUnitId' is set
|
|
48456
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
48457
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
|
|
48458
|
+
}
|
|
48459
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
48460
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
48461
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
|
|
48462
|
+
}
|
|
48463
|
+
|
|
48464
|
+
return this.apiClient.callApi(
|
|
48465
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
|
|
48466
|
+
'PATCH',
|
|
48467
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
48468
|
+
{ },
|
|
48469
|
+
{ },
|
|
48470
|
+
{ },
|
|
48471
|
+
opts['body'],
|
|
48472
|
+
['PureCloud OAuth'],
|
|
48473
|
+
['application/json'],
|
|
48474
|
+
['application/json']
|
|
48475
|
+
);
|
|
48476
|
+
}
|
|
48477
|
+
|
|
48864
48478
|
/**
|
|
48865
48479
|
* Update a time off request for the current user
|
|
48866
48480
|
*
|
|
@@ -49388,31 +49002,6 @@ class WorkforceManagementApi {
|
|
|
49388
49002
|
);
|
|
49389
49003
|
}
|
|
49390
49004
|
|
|
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
49005
|
/**
|
|
49417
49006
|
* Query published schedules for given given time range for set of users
|
|
49418
49007
|
*
|
|
@@ -49473,31 +49062,6 @@ class WorkforceManagementApi {
|
|
|
49473
49062
|
);
|
|
49474
49063
|
}
|
|
49475
49064
|
|
|
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
49065
|
/**
|
|
49502
49066
|
* Move the requested management unit to a new business unit
|
|
49503
49067
|
* Returns status 200 if the management unit is already in the requested business unit
|
|
@@ -49556,31 +49120,6 @@ class WorkforceManagementApi {
|
|
|
49556
49120
|
);
|
|
49557
49121
|
}
|
|
49558
49122
|
|
|
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
49123
|
/**
|
|
49585
49124
|
* Create a new time off request
|
|
49586
49125
|
*
|
|
@@ -49610,35 +49149,6 @@ class WorkforceManagementApi {
|
|
|
49610
49149
|
);
|
|
49611
49150
|
}
|
|
49612
49151
|
|
|
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
49152
|
/**
|
|
49643
49153
|
* Gets the lookup ids to fetch the specified set of requests
|
|
49644
49154
|
*
|
|
@@ -49668,166 +49178,6 @@ class WorkforceManagementApi {
|
|
|
49668
49178
|
);
|
|
49669
49179
|
}
|
|
49670
49180
|
|
|
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
49181
|
/**
|
|
49832
49182
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
49833
49183
|
*
|
|
@@ -49978,94 +49328,33 @@ class WorkforceManagementApi {
|
|
|
49978
49328
|
}
|
|
49979
49329
|
|
|
49980
49330
|
/**
|
|
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
|
|
49331
|
+
* Create a copy of work plan
|
|
50047
49332
|
*
|
|
50048
|
-
* @param {String} managementUnitId
|
|
50049
|
-
* @param {String}
|
|
49333
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
49334
|
+
* @param {String} workPlanId The ID of the work plan to create a copy
|
|
49335
|
+
* @param {Object} opts Optional parameters
|
|
49336
|
+
* @param {Object} opts.body body
|
|
50050
49337
|
*/
|
|
50051
|
-
|
|
49338
|
+
postWorkforcemanagementManagementunitWorkplanCopy(managementUnitId, workPlanId, opts) {
|
|
49339
|
+
opts = opts || {};
|
|
49340
|
+
|
|
50052
49341
|
// verify the required parameter 'managementUnitId' is set
|
|
50053
49342
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
50054
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
49343
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
|
|
50055
49344
|
}
|
|
50056
|
-
// verify the required parameter '
|
|
50057
|
-
if (
|
|
50058
|
-
throw 'Missing the required parameter "
|
|
49345
|
+
// verify the required parameter 'workPlanId' is set
|
|
49346
|
+
if (workPlanId === undefined || workPlanId === null) {
|
|
49347
|
+
throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
|
|
50059
49348
|
}
|
|
50060
49349
|
|
|
50061
49350
|
return this.apiClient.callApi(
|
|
50062
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
49351
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy',
|
|
50063
49352
|
'POST',
|
|
50064
|
-
{ 'managementUnitId': managementUnitId,'
|
|
49353
|
+
{ 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
|
|
50065
49354
|
{ },
|
|
50066
49355
|
{ },
|
|
50067
49356
|
{ },
|
|
50068
|
-
|
|
49357
|
+
opts['body'],
|
|
50069
49358
|
['PureCloud OAuth'],
|
|
50070
49359
|
['application/json'],
|
|
50071
49360
|
['application/json']
|
|
@@ -50073,29 +49362,34 @@ class WorkforceManagementApi {
|
|
|
50073
49362
|
}
|
|
50074
49363
|
|
|
50075
49364
|
/**
|
|
50076
|
-
*
|
|
49365
|
+
* Validate Work Plan
|
|
50077
49366
|
*
|
|
50078
|
-
* @param {String} managementUnitId
|
|
50079
|
-
* @param {String}
|
|
49367
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
49368
|
+
* @param {String} workPlanId The ID of the work plan to validate. For new work plan, use the word 'new' for the ID.
|
|
49369
|
+
* @param {Object} opts Optional parameters
|
|
49370
|
+
* @param {Object} opts.body body
|
|
49371
|
+
* @param {Array.<String>} opts.expand
|
|
50080
49372
|
*/
|
|
50081
|
-
|
|
49373
|
+
postWorkforcemanagementManagementunitWorkplanValidate(managementUnitId, workPlanId, opts) {
|
|
49374
|
+
opts = opts || {};
|
|
49375
|
+
|
|
50082
49376
|
// verify the required parameter 'managementUnitId' is set
|
|
50083
49377
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
50084
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
49378
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
|
|
50085
49379
|
}
|
|
50086
|
-
// verify the required parameter '
|
|
50087
|
-
if (
|
|
50088
|
-
throw 'Missing the required parameter "
|
|
49380
|
+
// verify the required parameter 'workPlanId' is set
|
|
49381
|
+
if (workPlanId === undefined || workPlanId === null) {
|
|
49382
|
+
throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
|
|
50089
49383
|
}
|
|
50090
49384
|
|
|
50091
49385
|
return this.apiClient.callApi(
|
|
50092
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
49386
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate',
|
|
50093
49387
|
'POST',
|
|
50094
|
-
{ 'managementUnitId': managementUnitId,'
|
|
50095
|
-
{
|
|
49388
|
+
{ 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
|
|
49389
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
50096
49390
|
{ },
|
|
50097
49391
|
{ },
|
|
50098
|
-
|
|
49392
|
+
opts['body'],
|
|
50099
49393
|
['PureCloud OAuth'],
|
|
50100
49394
|
['application/json'],
|
|
50101
49395
|
['application/json']
|
|
@@ -50103,29 +49397,29 @@ class WorkforceManagementApi {
|
|
|
50103
49397
|
}
|
|
50104
49398
|
|
|
50105
49399
|
/**
|
|
50106
|
-
* Create a copy of work plan
|
|
49400
|
+
* Create a copy of work plan rotation
|
|
50107
49401
|
*
|
|
50108
49402
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50109
|
-
* @param {String}
|
|
49403
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to create a copy
|
|
50110
49404
|
* @param {Object} opts Optional parameters
|
|
50111
49405
|
* @param {Object} opts.body body
|
|
50112
49406
|
*/
|
|
50113
|
-
|
|
49407
|
+
postWorkforcemanagementManagementunitWorkplanrotationCopy(managementUnitId, workPlanRotationId, opts) {
|
|
50114
49408
|
opts = opts || {};
|
|
50115
49409
|
|
|
50116
49410
|
// verify the required parameter 'managementUnitId' is set
|
|
50117
49411
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
50118
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
49412
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
|
|
50119
49413
|
}
|
|
50120
|
-
// verify the required parameter '
|
|
50121
|
-
if (
|
|
50122
|
-
throw 'Missing the required parameter "
|
|
49414
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
49415
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
49416
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
|
|
50123
49417
|
}
|
|
50124
49418
|
|
|
50125
49419
|
return this.apiClient.callApi(
|
|
50126
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
49420
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy',
|
|
50127
49421
|
'POST',
|
|
50128
|
-
{ 'managementUnitId': managementUnitId,'
|
|
49422
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
50129
49423
|
{ },
|
|
50130
49424
|
{ },
|
|
50131
49425
|
{ },
|
|
@@ -50137,31 +49431,25 @@ class WorkforceManagementApi {
|
|
|
50137
49431
|
}
|
|
50138
49432
|
|
|
50139
49433
|
/**
|
|
50140
|
-
*
|
|
49434
|
+
* Create a new work plan rotation
|
|
50141
49435
|
*
|
|
50142
49436
|
* @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
49437
|
* @param {Object} opts Optional parameters
|
|
50145
49438
|
* @param {Object} opts.body body
|
|
50146
|
-
* @param {Array.<String>} opts.expand
|
|
50147
49439
|
*/
|
|
50148
|
-
|
|
49440
|
+
postWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, opts) {
|
|
50149
49441
|
opts = opts || {};
|
|
50150
49442
|
|
|
50151
49443
|
// verify the required parameter 'managementUnitId' is set
|
|
50152
49444
|
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';
|
|
49445
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotations';
|
|
50158
49446
|
}
|
|
50159
49447
|
|
|
50160
49448
|
return this.apiClient.callApi(
|
|
50161
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
49449
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
|
|
50162
49450
|
'POST',
|
|
50163
|
-
{ 'managementUnitId': managementUnitId
|
|
50164
|
-
{
|
|
49451
|
+
{ 'managementUnitId': managementUnitId },
|
|
49452
|
+
{ },
|
|
50165
49453
|
{ },
|
|
50166
49454
|
{ },
|
|
50167
49455
|
opts['body'],
|
|
@@ -50327,7 +49615,7 @@ class WorkforceManagementApi {
|
|
|
50327
49615
|
* </pre>
|
|
50328
49616
|
* </p>
|
|
50329
49617
|
* @module purecloud-platform-client-v2/index
|
|
50330
|
-
* @version
|
|
49618
|
+
* @version 97.0.0
|
|
50331
49619
|
*/
|
|
50332
49620
|
class platformClient {
|
|
50333
49621
|
constructor() {
|
|
@@ -50586,11 +49874,6 @@ class platformClient {
|
|
|
50586
49874
|
* @property {module:purecloud-platform-client-v2/api/UsageApi}
|
|
50587
49875
|
*/
|
|
50588
49876
|
this.UsageApi = UsageApi;
|
|
50589
|
-
/**
|
|
50590
|
-
* The UserDevelopmentApi service constructor.
|
|
50591
|
-
* @property {module:purecloud-platform-client-v2/api/UserDevelopmentApi}
|
|
50592
|
-
*/
|
|
50593
|
-
this.UserDevelopmentApi = UserDevelopmentApi;
|
|
50594
49877
|
/**
|
|
50595
49878
|
* The UserRecordingsApi service constructor.
|
|
50596
49879
|
* @property {module:purecloud-platform-client-v2/api/UserRecordingsApi}
|
|
@@ -50641,5 +49924,5 @@ var index = new platformClient();
|
|
|
50641
49924
|
|
|
50642
49925
|
module.exports = index;
|
|
50643
49926
|
|
|
50644
|
-
}).call(this,typeof global !== "undefined" ? global : typeof self !== "undefined" ? self : typeof window !== "undefined" ? window : {},require("buffer").Buffer)
|
|
49927
|
+
}).call(this)}).call(this,typeof global !== "undefined" ? global : typeof self !== "undefined" ? self : typeof window !== "undefined" ? window : {},require("buffer").Buffer)
|
|
50645
49928
|
},{"buffer":3,"fs":1,"superagent":7}]},{},[]);
|