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
|
@@ -16,7 +16,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
16
16
|
|
|
17
17
|
/**
|
|
18
18
|
* @module purecloud-platform-client-v2/ApiClient
|
|
19
|
-
* @version
|
|
19
|
+
* @version 97.0.0
|
|
20
20
|
*/
|
|
21
21
|
class ApiClient {
|
|
22
22
|
/**
|
|
@@ -772,7 +772,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
772
772
|
|
|
773
773
|
// set header parameters
|
|
774
774
|
request.set(this.defaultHeaders).set(this.normalizeParams(headerParams));
|
|
775
|
-
//request.set({ 'purecloud-sdk': '
|
|
775
|
+
//request.set({ 'purecloud-sdk': '97.0.0' });
|
|
776
776
|
|
|
777
777
|
// set request timeout
|
|
778
778
|
request.timeout(this.timeout);
|
|
@@ -897,7 +897,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
897
897
|
/**
|
|
898
898
|
* Alerting service.
|
|
899
899
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
900
|
-
* @version
|
|
900
|
+
* @version 97.0.0
|
|
901
901
|
*/
|
|
902
902
|
|
|
903
903
|
/**
|
|
@@ -1211,7 +1211,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
1211
1211
|
/**
|
|
1212
1212
|
* Analytics service.
|
|
1213
1213
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1214
|
-
* @version
|
|
1214
|
+
* @version 97.0.0
|
|
1215
1215
|
*/
|
|
1216
1216
|
|
|
1217
1217
|
/**
|
|
@@ -2291,7 +2291,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
2291
2291
|
/**
|
|
2292
2292
|
* Architect service.
|
|
2293
2293
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2294
|
-
* @version
|
|
2294
|
+
* @version 97.0.0
|
|
2295
2295
|
*/
|
|
2296
2296
|
|
|
2297
2297
|
/**
|
|
@@ -5129,7 +5129,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
5129
5129
|
/**
|
|
5130
5130
|
* Audit service.
|
|
5131
5131
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
5132
|
-
* @version
|
|
5132
|
+
* @version 97.0.0
|
|
5133
5133
|
*/
|
|
5134
5134
|
|
|
5135
5135
|
/**
|
|
@@ -5300,7 +5300,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
5300
5300
|
/**
|
|
5301
5301
|
* Authorization service.
|
|
5302
5302
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
5303
|
-
* @version
|
|
5303
|
+
* @version 97.0.0
|
|
5304
5304
|
*/
|
|
5305
5305
|
|
|
5306
5306
|
/**
|
|
@@ -5635,6 +5635,8 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
5635
5635
|
* @param {Object} opts Optional parameters
|
|
5636
5636
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
5637
5637
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
5638
|
+
* @param {Object} opts.queryType Query filter type
|
|
5639
|
+
* @param {String} opts.query Comma-separated list of permissions or domains to query
|
|
5638
5640
|
*/
|
|
5639
5641
|
getAuthorizationPermissions(opts) {
|
|
5640
5642
|
opts = opts || {};
|
|
@@ -5644,7 +5646,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
5644
5646
|
'/api/v2/authorization/permissions',
|
|
5645
5647
|
'GET',
|
|
5646
5648
|
{ },
|
|
5647
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
5649
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'queryType': opts['queryType'],'query': opts['query'] },
|
|
5648
5650
|
{ },
|
|
5649
5651
|
{ },
|
|
5650
5652
|
null,
|
|
@@ -6417,7 +6419,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
6417
6419
|
/**
|
|
6418
6420
|
* Billing service.
|
|
6419
6421
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
6420
|
-
* @version
|
|
6422
|
+
* @version 97.0.0
|
|
6421
6423
|
*/
|
|
6422
6424
|
|
|
6423
6425
|
/**
|
|
@@ -6435,8 +6437,8 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
6435
6437
|
/**
|
|
6436
6438
|
* Get a report of the billable license usages
|
|
6437
6439
|
* 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.
|
|
6438
|
-
* @param {Date} startDate The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
6439
|
-
* @param {Date} endDate The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
6440
|
+
* @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
|
|
6441
|
+
* @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
|
|
6440
6442
|
*/
|
|
6441
6443
|
getBillingReportsBillableusage(startDate, endDate) {
|
|
6442
6444
|
// verify the required parameter 'startDate' is set
|
|
@@ -6497,7 +6499,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
6497
6499
|
/**
|
|
6498
6500
|
* Coaching service.
|
|
6499
6501
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
6500
|
-
* @version
|
|
6502
|
+
* @version 97.0.0
|
|
6501
6503
|
*/
|
|
6502
6504
|
|
|
6503
6505
|
/**
|
|
@@ -7017,7 +7019,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
7017
7019
|
/**
|
|
7018
7020
|
* ContentManagement service.
|
|
7019
7021
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
7020
|
-
* @version
|
|
7022
|
+
* @version 97.0.0
|
|
7021
7023
|
*/
|
|
7022
7024
|
|
|
7023
7025
|
/**
|
|
@@ -8157,7 +8159,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
8157
8159
|
/**
|
|
8158
8160
|
* Conversations service.
|
|
8159
8161
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
8160
|
-
* @version
|
|
8162
|
+
* @version 97.0.0
|
|
8161
8163
|
*/
|
|
8162
8164
|
|
|
8163
8165
|
/**
|
|
@@ -11786,7 +11788,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
11786
11788
|
|
|
11787
11789
|
/**
|
|
11788
11790
|
* Send message
|
|
11789
|
-
*
|
|
11791
|
+
* 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.
|
|
11790
11792
|
* @param {String} conversationId conversationId
|
|
11791
11793
|
* @param {String} communicationId communicationId
|
|
11792
11794
|
* @param {Object} body Message
|
|
@@ -11967,8 +11969,12 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
11967
11969
|
* Create a Facebook Integration
|
|
11968
11970
|
*
|
|
11969
11971
|
* @param {Object} body FacebookIntegrationRequest
|
|
11972
|
+
* @param {Object} opts Optional parameters
|
|
11973
|
+
* @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)
|
|
11970
11974
|
*/
|
|
11971
|
-
postConversationsMessagingIntegrationsFacebook(body) {
|
|
11975
|
+
postConversationsMessagingIntegrationsFacebook(body, opts) {
|
|
11976
|
+
opts = opts || {};
|
|
11977
|
+
|
|
11972
11978
|
// verify the required parameter 'body' is set
|
|
11973
11979
|
if (body === undefined || body === null) {
|
|
11974
11980
|
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsFacebook';
|
|
@@ -11978,7 +11984,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
11978
11984
|
'/api/v2/conversations/messaging/integrations/facebook',
|
|
11979
11985
|
'POST',
|
|
11980
11986
|
{ },
|
|
11981
|
-
{
|
|
11987
|
+
{ 'async': opts['async'] },
|
|
11982
11988
|
{ },
|
|
11983
11989
|
{ },
|
|
11984
11990
|
body,
|
|
@@ -11992,8 +11998,12 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
11992
11998
|
* Create a LINE messenger Integration
|
|
11993
11999
|
*
|
|
11994
12000
|
* @param {Object} body LineIntegrationRequest
|
|
12001
|
+
* @param {Object} opts Optional parameters
|
|
12002
|
+
* @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)
|
|
11995
12003
|
*/
|
|
11996
|
-
postConversationsMessagingIntegrationsLine(body) {
|
|
12004
|
+
postConversationsMessagingIntegrationsLine(body, opts) {
|
|
12005
|
+
opts = opts || {};
|
|
12006
|
+
|
|
11997
12007
|
// verify the required parameter 'body' is set
|
|
11998
12008
|
if (body === undefined || body === null) {
|
|
11999
12009
|
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsLine';
|
|
@@ -12003,7 +12013,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
12003
12013
|
'/api/v2/conversations/messaging/integrations/line',
|
|
12004
12014
|
'POST',
|
|
12005
12015
|
{ },
|
|
12006
|
-
{
|
|
12016
|
+
{ 'async': opts['async'] },
|
|
12007
12017
|
{ },
|
|
12008
12018
|
{ },
|
|
12009
12019
|
body,
|
|
@@ -12017,8 +12027,12 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
12017
12027
|
* Create a Twitter Integration
|
|
12018
12028
|
*
|
|
12019
12029
|
* @param {Object} body TwitterIntegrationRequest
|
|
12030
|
+
* @param {Object} opts Optional parameters
|
|
12031
|
+
* @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)
|
|
12020
12032
|
*/
|
|
12021
|
-
postConversationsMessagingIntegrationsTwitter(body) {
|
|
12033
|
+
postConversationsMessagingIntegrationsTwitter(body, opts) {
|
|
12034
|
+
opts = opts || {};
|
|
12035
|
+
|
|
12022
12036
|
// verify the required parameter 'body' is set
|
|
12023
12037
|
if (body === undefined || body === null) {
|
|
12024
12038
|
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsTwitter';
|
|
@@ -12028,7 +12042,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
12028
12042
|
'/api/v2/conversations/messaging/integrations/twitter',
|
|
12029
12043
|
'POST',
|
|
12030
12044
|
{ },
|
|
12031
|
-
{
|
|
12045
|
+
{ 'async': opts['async'] },
|
|
12032
12046
|
{ },
|
|
12033
12047
|
{ },
|
|
12034
12048
|
body,
|
|
@@ -12042,8 +12056,12 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
12042
12056
|
* Create a WhatsApp Integration
|
|
12043
12057
|
* 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.
|
|
12044
12058
|
* @param {Object} body WhatsAppIntegrationRequest
|
|
12059
|
+
* @param {Object} opts Optional parameters
|
|
12060
|
+
* @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)
|
|
12045
12061
|
*/
|
|
12046
|
-
postConversationsMessagingIntegrationsWhatsapp(body) {
|
|
12062
|
+
postConversationsMessagingIntegrationsWhatsapp(body, opts) {
|
|
12063
|
+
opts = opts || {};
|
|
12064
|
+
|
|
12047
12065
|
// verify the required parameter 'body' is set
|
|
12048
12066
|
if (body === undefined || body === null) {
|
|
12049
12067
|
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsWhatsapp';
|
|
@@ -12053,7 +12071,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
12053
12071
|
'/api/v2/conversations/messaging/integrations/whatsapp',
|
|
12054
12072
|
'POST',
|
|
12055
12073
|
{ },
|
|
12056
|
-
{
|
|
12074
|
+
{ 'async': opts['async'] },
|
|
12057
12075
|
{ },
|
|
12058
12076
|
{ },
|
|
12059
12077
|
body,
|
|
@@ -12199,7 +12217,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
12199
12217
|
/**
|
|
12200
12218
|
* DataExtensions service.
|
|
12201
12219
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
12202
|
-
* @version
|
|
12220
|
+
* @version 97.0.0
|
|
12203
12221
|
*/
|
|
12204
12222
|
|
|
12205
12223
|
/**
|
|
@@ -12285,7 +12303,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
12285
12303
|
/**
|
|
12286
12304
|
* ExternalContacts service.
|
|
12287
12305
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
12288
|
-
* @version
|
|
12306
|
+
* @version 97.0.0
|
|
12289
12307
|
*/
|
|
12290
12308
|
|
|
12291
12309
|
/**
|
|
@@ -13628,7 +13646,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
13628
13646
|
/**
|
|
13629
13647
|
* Fax service.
|
|
13630
13648
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
13631
|
-
* @version
|
|
13649
|
+
* @version 97.0.0
|
|
13632
13650
|
*/
|
|
13633
13651
|
|
|
13634
13652
|
/**
|
|
@@ -13799,7 +13817,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
13799
13817
|
/**
|
|
13800
13818
|
* Flows service.
|
|
13801
13819
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
13802
|
-
* @version
|
|
13820
|
+
* @version 97.0.0
|
|
13803
13821
|
*/
|
|
13804
13822
|
|
|
13805
13823
|
/**
|
|
@@ -13870,7 +13888,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
13870
13888
|
/**
|
|
13871
13889
|
* GeneralDataProtectionRegulation service.
|
|
13872
13890
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
13873
|
-
* @version
|
|
13891
|
+
* @version 97.0.0
|
|
13874
13892
|
*/
|
|
13875
13893
|
|
|
13876
13894
|
/**
|
|
@@ -14000,7 +14018,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
14000
14018
|
/**
|
|
14001
14019
|
* Geolocation service.
|
|
14002
14020
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
14003
|
-
* @version
|
|
14021
|
+
* @version 97.0.0
|
|
14004
14022
|
*/
|
|
14005
14023
|
|
|
14006
14024
|
/**
|
|
@@ -14131,7 +14149,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
14131
14149
|
/**
|
|
14132
14150
|
* Greetings service.
|
|
14133
14151
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
14134
|
-
* @version
|
|
14152
|
+
* @version 97.0.0
|
|
14135
14153
|
*/
|
|
14136
14154
|
|
|
14137
14155
|
/**
|
|
@@ -14586,7 +14604,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
14586
14604
|
/**
|
|
14587
14605
|
* Groups service.
|
|
14588
14606
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
14589
|
-
* @version
|
|
14607
|
+
* @version 97.0.0
|
|
14590
14608
|
*/
|
|
14591
14609
|
|
|
14592
14610
|
/**
|
|
@@ -14991,7 +15009,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
14991
15009
|
/**
|
|
14992
15010
|
* IdentityProvider service.
|
|
14993
15011
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
14994
|
-
* @version
|
|
15012
|
+
* @version 97.0.0
|
|
14995
15013
|
*/
|
|
14996
15014
|
|
|
14997
15015
|
/**
|
|
@@ -15747,7 +15765,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
15747
15765
|
/**
|
|
15748
15766
|
* Integrations service.
|
|
15749
15767
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
15750
|
-
* @version
|
|
15768
|
+
* @version 97.0.0
|
|
15751
15769
|
*/
|
|
15752
15770
|
|
|
15753
15771
|
/**
|
|
@@ -17239,7 +17257,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
17239
17257
|
/**
|
|
17240
17258
|
* Journey service.
|
|
17241
17259
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
17242
|
-
* @version
|
|
17260
|
+
* @version 97.0.0
|
|
17243
17261
|
*/
|
|
17244
17262
|
|
|
17245
17263
|
/**
|
|
@@ -17304,6 +17322,107 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
17304
17322
|
);
|
|
17305
17323
|
}
|
|
17306
17324
|
|
|
17325
|
+
/**
|
|
17326
|
+
* Retrieve segment assignments by customer ID.
|
|
17327
|
+
*
|
|
17328
|
+
* @param {String} customerIdType Type of ID used to identify customer (e.g. email, cookie, and phone).
|
|
17329
|
+
* @param {String} customerId Primary identifier of the customer to query for segment assignments.
|
|
17330
|
+
* @param {Object} opts Optional parameters
|
|
17331
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
17332
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
17333
|
+
* @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
|
|
17334
|
+
* @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
|
|
17335
|
+
*/
|
|
17336
|
+
getJourneyCustomerCustomerIdSegments(customerIdType, customerId, opts) {
|
|
17337
|
+
opts = opts || {};
|
|
17338
|
+
|
|
17339
|
+
// verify the required parameter 'customerIdType' is set
|
|
17340
|
+
if (customerIdType === undefined || customerIdType === null) {
|
|
17341
|
+
throw 'Missing the required parameter "customerIdType" when calling getJourneyCustomerCustomerIdSegments';
|
|
17342
|
+
}
|
|
17343
|
+
// verify the required parameter 'customerId' is set
|
|
17344
|
+
if (customerId === undefined || customerId === null) {
|
|
17345
|
+
throw 'Missing the required parameter "customerId" when calling getJourneyCustomerCustomerIdSegments';
|
|
17346
|
+
}
|
|
17347
|
+
|
|
17348
|
+
return this.apiClient.callApi(
|
|
17349
|
+
'/api/v2/journey/customers/{customerIdType}/{customerId}/segments',
|
|
17350
|
+
'GET',
|
|
17351
|
+
{ 'customerIdType': customerIdType,'customerId': customerId },
|
|
17352
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'segmentScope': opts['segmentScope'],'assignmentState': opts['assignmentState'] },
|
|
17353
|
+
{ },
|
|
17354
|
+
{ },
|
|
17355
|
+
null,
|
|
17356
|
+
['PureCloud OAuth'],
|
|
17357
|
+
['application/json'],
|
|
17358
|
+
['application/json']
|
|
17359
|
+
);
|
|
17360
|
+
}
|
|
17361
|
+
|
|
17362
|
+
/**
|
|
17363
|
+
* Retrieve segment assignments by external contact ID.
|
|
17364
|
+
*
|
|
17365
|
+
* @param {String} externalContactId ID of the external contact to query for segment assignments.
|
|
17366
|
+
* @param {Object} opts Optional parameters
|
|
17367
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
17368
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
17369
|
+
* @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
|
|
17370
|
+
* @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
|
|
17371
|
+
*/
|
|
17372
|
+
getJourneyExternalcontactSegments(externalContactId, opts) {
|
|
17373
|
+
opts = opts || {};
|
|
17374
|
+
|
|
17375
|
+
// verify the required parameter 'externalContactId' is set
|
|
17376
|
+
if (externalContactId === undefined || externalContactId === null) {
|
|
17377
|
+
throw 'Missing the required parameter "externalContactId" when calling getJourneyExternalcontactSegments';
|
|
17378
|
+
}
|
|
17379
|
+
|
|
17380
|
+
return this.apiClient.callApi(
|
|
17381
|
+
'/api/v2/journey/externalcontacts/{externalContactId}/segments',
|
|
17382
|
+
'GET',
|
|
17383
|
+
{ 'externalContactId': externalContactId },
|
|
17384
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'segmentScope': opts['segmentScope'],'assignmentState': opts['assignmentState'] },
|
|
17385
|
+
{ },
|
|
17386
|
+
{ },
|
|
17387
|
+
null,
|
|
17388
|
+
['PureCloud OAuth'],
|
|
17389
|
+
['application/json'],
|
|
17390
|
+
['application/json']
|
|
17391
|
+
);
|
|
17392
|
+
}
|
|
17393
|
+
|
|
17394
|
+
/**
|
|
17395
|
+
* Retrieve segment assignments by session ID.
|
|
17396
|
+
*
|
|
17397
|
+
* @param {String} sessionId ID of the session to query for segment assignments.
|
|
17398
|
+
* @param {Object} opts Optional parameters
|
|
17399
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
17400
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
17401
|
+
* @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
|
|
17402
|
+
* @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
|
|
17403
|
+
*/
|
|
17404
|
+
getJourneySessionSegments(sessionId, opts) {
|
|
17405
|
+
opts = opts || {};
|
|
17406
|
+
|
|
17407
|
+
// verify the required parameter 'sessionId' is set
|
|
17408
|
+
if (sessionId === undefined || sessionId === null) {
|
|
17409
|
+
throw 'Missing the required parameter "sessionId" when calling getJourneySessionSegments';
|
|
17410
|
+
}
|
|
17411
|
+
|
|
17412
|
+
return this.apiClient.callApi(
|
|
17413
|
+
'/api/v2/journey/sessions/{sessionId}/segments',
|
|
17414
|
+
'GET',
|
|
17415
|
+
{ 'sessionId': sessionId },
|
|
17416
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'segmentScope': opts['segmentScope'],'assignmentState': opts['assignmentState'] },
|
|
17417
|
+
{ },
|
|
17418
|
+
{ },
|
|
17419
|
+
null,
|
|
17420
|
+
['PureCloud OAuth'],
|
|
17421
|
+
['application/json'],
|
|
17422
|
+
['application/json']
|
|
17423
|
+
);
|
|
17424
|
+
}
|
|
17425
|
+
|
|
17307
17426
|
/**
|
|
17308
17427
|
* Update a single action target.
|
|
17309
17428
|
*
|
|
@@ -17358,13 +17477,42 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
17358
17477
|
);
|
|
17359
17478
|
}
|
|
17360
17479
|
|
|
17480
|
+
/**
|
|
17481
|
+
* Assign/Unassign a segment to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment.
|
|
17482
|
+
*
|
|
17483
|
+
* @param {String} externalContactId ID of the external contact to query for segment assignments.
|
|
17484
|
+
* @param {Object} opts Optional parameters
|
|
17485
|
+
* @param {Array.<Object>} opts.body
|
|
17486
|
+
*/
|
|
17487
|
+
postJourneyExternalcontactSegments(externalContactId, opts) {
|
|
17488
|
+
opts = opts || {};
|
|
17489
|
+
|
|
17490
|
+
// verify the required parameter 'externalContactId' is set
|
|
17491
|
+
if (externalContactId === undefined || externalContactId === null) {
|
|
17492
|
+
throw 'Missing the required parameter "externalContactId" when calling postJourneyExternalcontactSegments';
|
|
17493
|
+
}
|
|
17494
|
+
|
|
17495
|
+
return this.apiClient.callApi(
|
|
17496
|
+
'/api/v2/journey/externalcontacts/{externalContactId}/segments',
|
|
17497
|
+
'POST',
|
|
17498
|
+
{ 'externalContactId': externalContactId },
|
|
17499
|
+
{ },
|
|
17500
|
+
{ },
|
|
17501
|
+
{ },
|
|
17502
|
+
opts['body'],
|
|
17503
|
+
['PureCloud OAuth'],
|
|
17504
|
+
['application/json'],
|
|
17505
|
+
['application/json']
|
|
17506
|
+
);
|
|
17507
|
+
}
|
|
17508
|
+
|
|
17361
17509
|
}
|
|
17362
17510
|
|
|
17363
17511
|
class KnowledgeApi {
|
|
17364
17512
|
/**
|
|
17365
17513
|
* Knowledge service.
|
|
17366
17514
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
17367
|
-
* @version
|
|
17515
|
+
* @version 97.0.0
|
|
17368
17516
|
*/
|
|
17369
17517
|
|
|
17370
17518
|
/**
|
|
@@ -17680,7 +17828,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
17680
17828
|
}
|
|
17681
17829
|
|
|
17682
17830
|
/**
|
|
17683
|
-
* Get
|
|
17831
|
+
* Get all trainings information for a knowledgebase
|
|
17684
17832
|
*
|
|
17685
17833
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
17686
17834
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
@@ -17689,6 +17837,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
17689
17837
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
17690
17838
|
* @param {String} opts.limit Number of entities to return. Maximum of 200.
|
|
17691
17839
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
17840
|
+
* @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
|
|
17692
17841
|
*/
|
|
17693
17842
|
getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode, opts) {
|
|
17694
17843
|
opts = opts || {};
|
|
@@ -17706,7 +17855,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
17706
17855
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings',
|
|
17707
17856
|
'GET',
|
|
17708
17857
|
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
17709
|
-
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'] },
|
|
17858
|
+
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'knowledgeDocumentsState': opts['knowledgeDocumentsState'] },
|
|
17710
17859
|
{ },
|
|
17711
17860
|
{ },
|
|
17712
17861
|
null,
|
|
@@ -18084,7 +18233,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
18084
18233
|
/**
|
|
18085
18234
|
* LanguageUnderstanding service.
|
|
18086
18235
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
18087
|
-
* @version
|
|
18236
|
+
* @version 97.0.0
|
|
18088
18237
|
*/
|
|
18089
18238
|
|
|
18090
18239
|
/**
|
|
@@ -18650,7 +18799,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
18650
18799
|
/**
|
|
18651
18800
|
* Languages service.
|
|
18652
18801
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
18653
|
-
* @version
|
|
18802
|
+
* @version 97.0.0
|
|
18654
18803
|
*/
|
|
18655
18804
|
|
|
18656
18805
|
/**
|
|
@@ -18918,7 +19067,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
18918
19067
|
/**
|
|
18919
19068
|
* License service.
|
|
18920
19069
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
18921
|
-
* @version
|
|
19070
|
+
* @version 97.0.0
|
|
18922
19071
|
*/
|
|
18923
19072
|
|
|
18924
19073
|
/**
|
|
@@ -19156,7 +19305,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
19156
19305
|
/**
|
|
19157
19306
|
* Locations service.
|
|
19158
19307
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
19159
|
-
* @version
|
|
19308
|
+
* @version 97.0.0
|
|
19160
19309
|
*/
|
|
19161
19310
|
|
|
19162
19311
|
/**
|
|
@@ -19392,7 +19541,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
19392
19541
|
/**
|
|
19393
19542
|
* MobileDevices service.
|
|
19394
19543
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
19395
|
-
* @version
|
|
19544
|
+
* @version 97.0.0
|
|
19396
19545
|
*/
|
|
19397
19546
|
|
|
19398
19547
|
/**
|
|
@@ -19543,7 +19692,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
19543
19692
|
/**
|
|
19544
19693
|
* Notifications service.
|
|
19545
19694
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
19546
|
-
* @version
|
|
19695
|
+
* @version 97.0.0
|
|
19547
19696
|
*/
|
|
19548
19697
|
|
|
19549
19698
|
/**
|
|
@@ -19742,7 +19891,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
19742
19891
|
/**
|
|
19743
19892
|
* OAuth service.
|
|
19744
19893
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
19745
|
-
* @version
|
|
19894
|
+
* @version 97.0.0
|
|
19746
19895
|
*/
|
|
19747
19896
|
|
|
19748
19897
|
/**
|
|
@@ -20100,7 +20249,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
20100
20249
|
/**
|
|
20101
20250
|
* Objects service.
|
|
20102
20251
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
20103
|
-
* @version
|
|
20252
|
+
* @version 97.0.0
|
|
20104
20253
|
*/
|
|
20105
20254
|
|
|
20106
20255
|
/**
|
|
@@ -20341,7 +20490,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
20341
20490
|
/**
|
|
20342
20491
|
* Organization service.
|
|
20343
20492
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
20344
|
-
* @version
|
|
20493
|
+
* @version 97.0.0
|
|
20345
20494
|
*/
|
|
20346
20495
|
|
|
20347
20496
|
/**
|
|
@@ -20596,7 +20745,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
20596
20745
|
/**
|
|
20597
20746
|
* OrganizationAuthorization service.
|
|
20598
20747
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
20599
|
-
* @version
|
|
20748
|
+
* @version 97.0.0
|
|
20600
20749
|
*/
|
|
20601
20750
|
|
|
20602
20751
|
/**
|
|
@@ -21306,7 +21455,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
21306
21455
|
/**
|
|
21307
21456
|
* Outbound service.
|
|
21308
21457
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
21309
|
-
* @version
|
|
21458
|
+
* @version 97.0.0
|
|
21310
21459
|
*/
|
|
21311
21460
|
|
|
21312
21461
|
/**
|
|
@@ -24280,7 +24429,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
24280
24429
|
/**
|
|
24281
24430
|
* Presence service.
|
|
24282
24431
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
24283
|
-
* @version
|
|
24432
|
+
* @version 97.0.0
|
|
24284
24433
|
*/
|
|
24285
24434
|
|
|
24286
24435
|
/**
|
|
@@ -24627,7 +24776,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
24627
24776
|
/**
|
|
24628
24777
|
* Quality service.
|
|
24629
24778
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
24630
|
-
* @version
|
|
24779
|
+
* @version 97.0.0
|
|
24631
24780
|
*/
|
|
24632
24781
|
|
|
24633
24782
|
/**
|
|
@@ -24841,8 +24990,8 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
24841
24990
|
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
24842
24991
|
* @param {String} opts.nextPage next page token
|
|
24843
24992
|
* @param {String} opts.previousPage Previous page token
|
|
24844
|
-
* @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.
|
|
24845
|
-
* @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.
|
|
24993
|
+
* @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
|
|
24994
|
+
* @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
|
|
24846
24995
|
* @param {Array.<String>} opts.agentUserId user id of agent requested
|
|
24847
24996
|
* @param {String} opts.evaluatorUserId user id of the evaluator
|
|
24848
24997
|
* @param {String} opts.name name
|
|
@@ -24908,8 +25057,8 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
24908
25057
|
* @param {String} opts.nextPage next page token
|
|
24909
25058
|
* @param {String} opts.previousPage Previous page token
|
|
24910
25059
|
* @param {String} opts.conversationId conversation id
|
|
24911
|
-
* @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.
|
|
24912
|
-
* @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.
|
|
25060
|
+
* @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
|
|
25061
|
+
* @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
|
|
24913
25062
|
*/
|
|
24914
25063
|
getQualityCalibrations(calibratorId, opts) {
|
|
24915
25064
|
opts = opts || {};
|
|
@@ -25079,8 +25228,8 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
25079
25228
|
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
25080
25229
|
* @param {String} opts.nextPage next page token
|
|
25081
25230
|
* @param {String} opts.previousPage Previous page token
|
|
25082
|
-
* @param {Date} opts.startTime The start time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
25083
|
-
* @param {Date} opts.endTime The end time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
25231
|
+
* @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
|
|
25232
|
+
* @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
|
|
25084
25233
|
* @param {String} opts.name Evaluator name
|
|
25085
25234
|
* @param {Array.<String>} opts.permission permission strings
|
|
25086
25235
|
* @param {String} opts.group group id
|
|
@@ -26324,7 +26473,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
26324
26473
|
/**
|
|
26325
26474
|
* Recording service.
|
|
26326
26475
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
26327
|
-
* @version
|
|
26476
|
+
* @version 97.0.0
|
|
26328
26477
|
*/
|
|
26329
26478
|
|
|
26330
26479
|
/**
|
|
@@ -27570,7 +27719,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
27570
27719
|
/**
|
|
27571
27720
|
* ResponseManagement service.
|
|
27572
27721
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
27573
|
-
* @version
|
|
27722
|
+
* @version 97.0.0
|
|
27574
27723
|
*/
|
|
27575
27724
|
|
|
27576
27725
|
/**
|
|
@@ -27895,7 +28044,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
27895
28044
|
/**
|
|
27896
28045
|
* Routing service.
|
|
27897
28046
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
27898
|
-
* @version
|
|
28047
|
+
* @version 97.0.0
|
|
27899
28048
|
*/
|
|
27900
28049
|
|
|
27901
28050
|
/**
|
|
@@ -30193,7 +30342,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
30193
30342
|
/**
|
|
30194
30343
|
* SCIM service.
|
|
30195
30344
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
30196
|
-
* @version
|
|
30345
|
+
* @version 97.0.0
|
|
30197
30346
|
*/
|
|
30198
30347
|
|
|
30199
30348
|
/**
|
|
@@ -30329,8 +30478,8 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
30329
30478
|
*
|
|
30330
30479
|
* @param {String} groupId The ID of a group. Returned with GET /api/v2/scim/groups.
|
|
30331
30480
|
* @param {Object} opts Optional parameters
|
|
30332
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
30333
|
-
* @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.
|
|
30481
|
+
* @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.
|
|
30482
|
+
* @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.
|
|
30334
30483
|
* @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.
|
|
30335
30484
|
*/
|
|
30336
30485
|
getScimGroup(groupId, opts) {
|
|
@@ -30360,9 +30509,9 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
30360
30509
|
*
|
|
30361
30510
|
* @param {Object} opts Optional parameters
|
|
30362
30511
|
* @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
|
|
30363
|
-
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
30364
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
30365
|
-
* @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.
|
|
30512
|
+
* @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)
|
|
30513
|
+
* @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.
|
|
30514
|
+
* @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.
|
|
30366
30515
|
* @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\".
|
|
30367
30516
|
*/
|
|
30368
30517
|
getScimGroups(opts) {
|
|
@@ -30506,9 +30655,9 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
30506
30655
|
*
|
|
30507
30656
|
* @param {String} userId The ID of a user. Returned with GET /api/v2/scim/users.
|
|
30508
30657
|
* @param {Object} opts Optional parameters
|
|
30509
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
30510
|
-
* @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.
|
|
30511
|
-
* @param {String} opts.ifNoneMatch
|
|
30658
|
+
* @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.
|
|
30659
|
+
* @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.
|
|
30660
|
+
* @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.
|
|
30512
30661
|
*/
|
|
30513
30662
|
getScimUser(userId, opts) {
|
|
30514
30663
|
opts = opts || {};
|
|
@@ -30537,9 +30686,9 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
30537
30686
|
* 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\".
|
|
30538
30687
|
* @param {Object} opts Optional parameters
|
|
30539
30688
|
* @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
|
|
30540
|
-
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
30541
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
30542
|
-
* @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.
|
|
30689
|
+
* @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)
|
|
30690
|
+
* @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.
|
|
30691
|
+
* @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.
|
|
30543
30692
|
* @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\".
|
|
30544
30693
|
*/
|
|
30545
30694
|
getScimUsers(opts) {
|
|
@@ -30565,9 +30714,9 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
30565
30714
|
*
|
|
30566
30715
|
* @param {String} groupId The ID of a group. Returned with GET /api/v2/scim/v2/groups.
|
|
30567
30716
|
* @param {Object} opts Optional parameters
|
|
30568
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
30569
|
-
* @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.
|
|
30570
|
-
* @param {String} opts.ifNoneMatch
|
|
30717
|
+
* @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.
|
|
30718
|
+
* @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.
|
|
30719
|
+
* @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.
|
|
30571
30720
|
*/
|
|
30572
30721
|
getScimV2Group(groupId, opts) {
|
|
30573
30722
|
opts = opts || {};
|
|
@@ -30597,9 +30746,9 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
30597
30746
|
* @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\".
|
|
30598
30747
|
* @param {Object} opts Optional parameters
|
|
30599
30748
|
* @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
|
|
30600
|
-
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
30601
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
30602
|
-
* @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.
|
|
30749
|
+
* @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)
|
|
30750
|
+
* @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.
|
|
30751
|
+
* @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.
|
|
30603
30752
|
*/
|
|
30604
30753
|
getScimV2Groups(filter, opts) {
|
|
30605
30754
|
opts = opts || {};
|
|
@@ -30746,8 +30895,8 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
30746
30895
|
*
|
|
30747
30896
|
* @param {String} userId The ID of a user. Returned with GET /api/v2/scim/v2/users.
|
|
30748
30897
|
* @param {Object} opts Optional parameters
|
|
30749
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
30750
|
-
* @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.
|
|
30898
|
+
* @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.
|
|
30899
|
+
* @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.
|
|
30751
30900
|
* @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.
|
|
30752
30901
|
*/
|
|
30753
30902
|
getScimV2User(userId, opts) {
|
|
@@ -30777,9 +30926,9 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
30777
30926
|
* 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\".
|
|
30778
30927
|
* @param {Object} opts Optional parameters
|
|
30779
30928
|
* @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
|
|
30780
|
-
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
30781
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
30782
|
-
* @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.
|
|
30929
|
+
* @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)
|
|
30930
|
+
* @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.
|
|
30931
|
+
* @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.
|
|
30783
30932
|
* @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\".
|
|
30784
30933
|
*/
|
|
30785
30934
|
getScimV2Users(opts) {
|
|
@@ -30937,8 +31086,8 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
30937
31086
|
}
|
|
30938
31087
|
|
|
30939
31088
|
/**
|
|
30940
|
-
*
|
|
30941
|
-
* 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}
|
|
31089
|
+
* Create a group
|
|
31090
|
+
* 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.
|
|
30942
31091
|
* @param {Object} body The information used to create a group.
|
|
30943
31092
|
*/
|
|
30944
31093
|
postScimGroups(body) {
|
|
@@ -30989,7 +31138,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
30989
31138
|
/**
|
|
30990
31139
|
* Create a group
|
|
30991
31140
|
* 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.
|
|
30992
|
-
* @param {Object} body
|
|
31141
|
+
* @param {Object} body The information used to create a group.
|
|
30993
31142
|
*/
|
|
30994
31143
|
postScimV2Groups(body) {
|
|
30995
31144
|
// verify the required parameter 'body' is set
|
|
@@ -31178,7 +31327,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
31178
31327
|
/**
|
|
31179
31328
|
* Scripts service.
|
|
31180
31329
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
31181
|
-
* @version
|
|
31330
|
+
* @version 97.0.0
|
|
31182
31331
|
*/
|
|
31183
31332
|
|
|
31184
31333
|
/**
|
|
@@ -31531,7 +31680,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
31531
31680
|
/**
|
|
31532
31681
|
* Search service.
|
|
31533
31682
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
31534
|
-
* @version
|
|
31683
|
+
* @version 97.0.0
|
|
31535
31684
|
*/
|
|
31536
31685
|
|
|
31537
31686
|
/**
|
|
@@ -32041,7 +32190,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
32041
32190
|
/**
|
|
32042
32191
|
* SpeechTextAnalytics service.
|
|
32043
32192
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
32044
|
-
* @version
|
|
32193
|
+
* @version 97.0.0
|
|
32045
32194
|
*/
|
|
32046
32195
|
|
|
32047
32196
|
/**
|
|
@@ -32117,7 +32266,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
32117
32266
|
/**
|
|
32118
32267
|
* Stations service.
|
|
32119
32268
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
32120
|
-
* @version
|
|
32269
|
+
* @version 97.0.0
|
|
32121
32270
|
*/
|
|
32122
32271
|
|
|
32123
32272
|
/**
|
|
@@ -32264,7 +32413,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
32264
32413
|
/**
|
|
32265
32414
|
* Suggest service.
|
|
32266
32415
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
32267
|
-
* @version
|
|
32416
|
+
* @version 97.0.0
|
|
32268
32417
|
*/
|
|
32269
32418
|
|
|
32270
32419
|
/**
|
|
@@ -32403,7 +32552,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
32403
32552
|
/**
|
|
32404
32553
|
* Telephony service.
|
|
32405
32554
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
32406
|
-
* @version
|
|
32555
|
+
* @version 97.0.0
|
|
32407
32556
|
*/
|
|
32408
32557
|
|
|
32409
32558
|
/**
|
|
@@ -32421,8 +32570,8 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
32421
32570
|
/**
|
|
32422
32571
|
* Fetch SIP metadata
|
|
32423
32572
|
* 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
|
|
32424
|
-
* @param {Date} dateStart Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
32425
|
-
* @param {Date} dateEnd End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
32573
|
+
* @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
|
|
32574
|
+
* @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
|
|
32426
32575
|
* @param {Object} opts Optional parameters
|
|
32427
32576
|
* @param {String} opts.callId unique identification of the placed call
|
|
32428
32577
|
* @param {String} opts.toUser User to who the call was placed
|
|
@@ -32511,7 +32660,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
32511
32660
|
/**
|
|
32512
32661
|
* TelephonyProvidersEdge service.
|
|
32513
32662
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
32514
|
-
* @version
|
|
32663
|
+
* @version 97.0.0
|
|
32515
32664
|
*/
|
|
32516
32665
|
|
|
32517
32666
|
/**
|
|
@@ -36088,7 +36237,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
36088
36237
|
/**
|
|
36089
36238
|
* Textbots service.
|
|
36090
36239
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
36091
|
-
* @version
|
|
36240
|
+
* @version 97.0.0
|
|
36092
36241
|
*/
|
|
36093
36242
|
|
|
36094
36243
|
/**
|
|
@@ -36134,7 +36283,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
36134
36283
|
/**
|
|
36135
36284
|
* Tokens service.
|
|
36136
36285
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
36137
|
-
* @version
|
|
36286
|
+
* @version 97.0.0
|
|
36138
36287
|
*/
|
|
36139
36288
|
|
|
36140
36289
|
/**
|
|
@@ -36220,7 +36369,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
36220
36369
|
/**
|
|
36221
36370
|
* Uploads service.
|
|
36222
36371
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
36223
|
-
* @version
|
|
36372
|
+
* @version 97.0.0
|
|
36224
36373
|
*/
|
|
36225
36374
|
|
|
36226
36375
|
/**
|
|
@@ -36266,7 +36415,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
36266
36415
|
/**
|
|
36267
36416
|
* Usage service.
|
|
36268
36417
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
36269
|
-
* @version
|
|
36418
|
+
* @version 97.0.0
|
|
36270
36419
|
*/
|
|
36271
36420
|
|
|
36272
36421
|
/**
|
|
@@ -36333,154 +36482,11 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
36333
36482
|
|
|
36334
36483
|
}
|
|
36335
36484
|
|
|
36336
|
-
class UserDevelopmentApi {
|
|
36337
|
-
/**
|
|
36338
|
-
* UserDevelopment service.
|
|
36339
|
-
* @module purecloud-platform-client-v2/api/UserDevelopmentApi
|
|
36340
|
-
* @version 94.0.0
|
|
36341
|
-
*/
|
|
36342
|
-
|
|
36343
|
-
/**
|
|
36344
|
-
* Constructs a new UserDevelopmentApi.
|
|
36345
|
-
* @alias module:purecloud-platform-client-v2/api/UserDevelopmentApi
|
|
36346
|
-
* @class
|
|
36347
|
-
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
36348
|
-
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
36349
|
-
*/
|
|
36350
|
-
constructor(apiClient) {
|
|
36351
|
-
this.apiClient = apiClient || ApiClient.instance;
|
|
36352
|
-
}
|
|
36353
|
-
|
|
36354
|
-
|
|
36355
|
-
/**
|
|
36356
|
-
* Get list of Development Activities
|
|
36357
|
-
* Either moduleId or userId is required. Results are filtered based on the applicable permissions.
|
|
36358
|
-
* @param {Object} opts Optional parameters
|
|
36359
|
-
* @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.
|
|
36360
|
-
* @param {String} opts.moduleId Specifies the ID of the learning module.
|
|
36361
|
-
* @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
|
|
36362
|
-
* @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
|
|
36363
|
-
* @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
|
|
36364
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
36365
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
36366
|
-
* @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)
|
|
36367
|
-
* @param {Array.<String>} opts.types Specifies the activity types.
|
|
36368
|
-
* @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
|
|
36369
|
-
* @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.
|
|
36370
|
-
*/
|
|
36371
|
-
getUsersDevelopmentActivities(opts) {
|
|
36372
|
-
opts = opts || {};
|
|
36373
|
-
|
|
36374
|
-
|
|
36375
|
-
return this.apiClient.callApi(
|
|
36376
|
-
'/api/v2/users/development/activities',
|
|
36377
|
-
'GET',
|
|
36378
|
-
{ },
|
|
36379
|
-
{ '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') },
|
|
36380
|
-
{ },
|
|
36381
|
-
{ },
|
|
36382
|
-
null,
|
|
36383
|
-
['PureCloud OAuth'],
|
|
36384
|
-
['application/json'],
|
|
36385
|
-
['application/json']
|
|
36386
|
-
);
|
|
36387
|
-
}
|
|
36388
|
-
|
|
36389
|
-
/**
|
|
36390
|
-
* Get list of Development Activities for current user
|
|
36391
|
-
* Results are filtered based on the applicable permissions.
|
|
36392
|
-
* @param {Object} opts Optional parameters
|
|
36393
|
-
* @param {String} opts.moduleId Specifies the ID of the learning module.
|
|
36394
|
-
* @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
|
|
36395
|
-
* @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
|
|
36396
|
-
* @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
|
|
36397
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
36398
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
36399
|
-
* @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)
|
|
36400
|
-
* @param {Array.<String>} opts.types Specifies the activity types.
|
|
36401
|
-
* @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
|
|
36402
|
-
* @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.
|
|
36403
|
-
*/
|
|
36404
|
-
getUsersDevelopmentActivitiesMe(opts) {
|
|
36405
|
-
opts = opts || {};
|
|
36406
|
-
|
|
36407
|
-
|
|
36408
|
-
return this.apiClient.callApi(
|
|
36409
|
-
'/api/v2/users/development/activities/me',
|
|
36410
|
-
'GET',
|
|
36411
|
-
{ },
|
|
36412
|
-
{ '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') },
|
|
36413
|
-
{ },
|
|
36414
|
-
{ },
|
|
36415
|
-
null,
|
|
36416
|
-
['PureCloud OAuth'],
|
|
36417
|
-
['application/json'],
|
|
36418
|
-
['application/json']
|
|
36419
|
-
);
|
|
36420
|
-
}
|
|
36421
|
-
|
|
36422
|
-
/**
|
|
36423
|
-
* Get a Development Activity
|
|
36424
|
-
*
|
|
36425
|
-
* @param {String} activityId Specifies the activity ID, maps to either assignment or appointment ID
|
|
36426
|
-
* @param {Object} type Specifies the activity type.
|
|
36427
|
-
*/
|
|
36428
|
-
getUsersDevelopmentActivity(activityId, type) {
|
|
36429
|
-
// verify the required parameter 'activityId' is set
|
|
36430
|
-
if (activityId === undefined || activityId === null) {
|
|
36431
|
-
throw 'Missing the required parameter "activityId" when calling getUsersDevelopmentActivity';
|
|
36432
|
-
}
|
|
36433
|
-
// verify the required parameter 'type' is set
|
|
36434
|
-
if (type === undefined || type === null) {
|
|
36435
|
-
throw 'Missing the required parameter "type" when calling getUsersDevelopmentActivity';
|
|
36436
|
-
}
|
|
36437
|
-
|
|
36438
|
-
return this.apiClient.callApi(
|
|
36439
|
-
'/api/v2/users/development/activities/{activityId}',
|
|
36440
|
-
'GET',
|
|
36441
|
-
{ 'activityId': activityId },
|
|
36442
|
-
{ 'type': type },
|
|
36443
|
-
{ },
|
|
36444
|
-
{ },
|
|
36445
|
-
null,
|
|
36446
|
-
['PureCloud OAuth'],
|
|
36447
|
-
['application/json'],
|
|
36448
|
-
['application/json']
|
|
36449
|
-
);
|
|
36450
|
-
}
|
|
36451
|
-
|
|
36452
|
-
/**
|
|
36453
|
-
* Retrieve aggregated development activity data
|
|
36454
|
-
* Results are filtered based on the applicable permissions.
|
|
36455
|
-
* @param {Object} body Aggregate Request
|
|
36456
|
-
*/
|
|
36457
|
-
postUsersDevelopmentActivitiesAggregatesQuery(body) {
|
|
36458
|
-
// verify the required parameter 'body' is set
|
|
36459
|
-
if (body === undefined || body === null) {
|
|
36460
|
-
throw 'Missing the required parameter "body" when calling postUsersDevelopmentActivitiesAggregatesQuery';
|
|
36461
|
-
}
|
|
36462
|
-
|
|
36463
|
-
return this.apiClient.callApi(
|
|
36464
|
-
'/api/v2/users/development/activities/aggregates/query',
|
|
36465
|
-
'POST',
|
|
36466
|
-
{ },
|
|
36467
|
-
{ },
|
|
36468
|
-
{ },
|
|
36469
|
-
{ },
|
|
36470
|
-
body,
|
|
36471
|
-
['PureCloud OAuth'],
|
|
36472
|
-
['application/json'],
|
|
36473
|
-
['application/json']
|
|
36474
|
-
);
|
|
36475
|
-
}
|
|
36476
|
-
|
|
36477
|
-
}
|
|
36478
|
-
|
|
36479
36485
|
class UserRecordingsApi {
|
|
36480
36486
|
/**
|
|
36481
36487
|
* UserRecordings service.
|
|
36482
36488
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
36483
|
-
* @version
|
|
36489
|
+
* @version 97.0.0
|
|
36484
36490
|
*/
|
|
36485
36491
|
|
|
36486
36492
|
/**
|
|
@@ -36664,7 +36670,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
36664
36670
|
/**
|
|
36665
36671
|
* Users service.
|
|
36666
36672
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
36667
|
-
* @version
|
|
36673
|
+
* @version 97.0.0
|
|
36668
36674
|
*/
|
|
36669
36675
|
|
|
36670
36676
|
/**
|
|
@@ -37708,6 +37714,103 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
37708
37714
|
);
|
|
37709
37715
|
}
|
|
37710
37716
|
|
|
37717
|
+
/**
|
|
37718
|
+
* Get list of Development Activities
|
|
37719
|
+
* Either moduleId or userId is required. Results are filtered based on the applicable permissions.
|
|
37720
|
+
* @param {Object} opts Optional parameters
|
|
37721
|
+
* @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.
|
|
37722
|
+
* @param {String} opts.moduleId Specifies the ID of the learning module.
|
|
37723
|
+
* @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
|
|
37724
|
+
* @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
|
|
37725
|
+
* @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
|
|
37726
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
37727
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
37728
|
+
* @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)
|
|
37729
|
+
* @param {Array.<String>} opts.types Specifies the activity types.
|
|
37730
|
+
* @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
|
|
37731
|
+
* @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.
|
|
37732
|
+
*/
|
|
37733
|
+
getUsersDevelopmentActivities(opts) {
|
|
37734
|
+
opts = opts || {};
|
|
37735
|
+
|
|
37736
|
+
|
|
37737
|
+
return this.apiClient.callApi(
|
|
37738
|
+
'/api/v2/users/development/activities',
|
|
37739
|
+
'GET',
|
|
37740
|
+
{ },
|
|
37741
|
+
{ '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') },
|
|
37742
|
+
{ },
|
|
37743
|
+
{ },
|
|
37744
|
+
null,
|
|
37745
|
+
['PureCloud OAuth'],
|
|
37746
|
+
['application/json'],
|
|
37747
|
+
['application/json']
|
|
37748
|
+
);
|
|
37749
|
+
}
|
|
37750
|
+
|
|
37751
|
+
/**
|
|
37752
|
+
* Get list of Development Activities for current user
|
|
37753
|
+
* Results are filtered based on the applicable permissions.
|
|
37754
|
+
* @param {Object} opts Optional parameters
|
|
37755
|
+
* @param {String} opts.moduleId Specifies the ID of the learning module.
|
|
37756
|
+
* @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
|
|
37757
|
+
* @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
|
|
37758
|
+
* @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
|
|
37759
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
37760
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
37761
|
+
* @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)
|
|
37762
|
+
* @param {Array.<String>} opts.types Specifies the activity types.
|
|
37763
|
+
* @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
|
|
37764
|
+
* @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.
|
|
37765
|
+
*/
|
|
37766
|
+
getUsersDevelopmentActivitiesMe(opts) {
|
|
37767
|
+
opts = opts || {};
|
|
37768
|
+
|
|
37769
|
+
|
|
37770
|
+
return this.apiClient.callApi(
|
|
37771
|
+
'/api/v2/users/development/activities/me',
|
|
37772
|
+
'GET',
|
|
37773
|
+
{ },
|
|
37774
|
+
{ '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') },
|
|
37775
|
+
{ },
|
|
37776
|
+
{ },
|
|
37777
|
+
null,
|
|
37778
|
+
['PureCloud OAuth'],
|
|
37779
|
+
['application/json'],
|
|
37780
|
+
['application/json']
|
|
37781
|
+
);
|
|
37782
|
+
}
|
|
37783
|
+
|
|
37784
|
+
/**
|
|
37785
|
+
* Get a Development Activity
|
|
37786
|
+
*
|
|
37787
|
+
* @param {String} activityId Specifies the activity ID, maps to either assignment or appointment ID
|
|
37788
|
+
* @param {Object} type Specifies the activity type.
|
|
37789
|
+
*/
|
|
37790
|
+
getUsersDevelopmentActivity(activityId, type) {
|
|
37791
|
+
// verify the required parameter 'activityId' is set
|
|
37792
|
+
if (activityId === undefined || activityId === null) {
|
|
37793
|
+
throw 'Missing the required parameter "activityId" when calling getUsersDevelopmentActivity';
|
|
37794
|
+
}
|
|
37795
|
+
// verify the required parameter 'type' is set
|
|
37796
|
+
if (type === undefined || type === null) {
|
|
37797
|
+
throw 'Missing the required parameter "type" when calling getUsersDevelopmentActivity';
|
|
37798
|
+
}
|
|
37799
|
+
|
|
37800
|
+
return this.apiClient.callApi(
|
|
37801
|
+
'/api/v2/users/development/activities/{activityId}',
|
|
37802
|
+
'GET',
|
|
37803
|
+
{ 'activityId': activityId },
|
|
37804
|
+
{ 'type': type },
|
|
37805
|
+
{ },
|
|
37806
|
+
{ },
|
|
37807
|
+
null,
|
|
37808
|
+
['PureCloud OAuth'],
|
|
37809
|
+
['application/json'],
|
|
37810
|
+
['application/json']
|
|
37811
|
+
);
|
|
37812
|
+
}
|
|
37813
|
+
|
|
37711
37814
|
/**
|
|
37712
37815
|
* Get current user details.
|
|
37713
37816
|
* This request is not valid when using the Client Credentials OAuth grant.
|
|
@@ -38394,6 +38497,31 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
38394
38497
|
);
|
|
38395
38498
|
}
|
|
38396
38499
|
|
|
38500
|
+
/**
|
|
38501
|
+
* Retrieve aggregated development activity data
|
|
38502
|
+
* Results are filtered based on the applicable permissions.
|
|
38503
|
+
* @param {Object} body Aggregate Request
|
|
38504
|
+
*/
|
|
38505
|
+
postUsersDevelopmentActivitiesAggregatesQuery(body) {
|
|
38506
|
+
// verify the required parameter 'body' is set
|
|
38507
|
+
if (body === undefined || body === null) {
|
|
38508
|
+
throw 'Missing the required parameter "body" when calling postUsersDevelopmentActivitiesAggregatesQuery';
|
|
38509
|
+
}
|
|
38510
|
+
|
|
38511
|
+
return this.apiClient.callApi(
|
|
38512
|
+
'/api/v2/users/development/activities/aggregates/query',
|
|
38513
|
+
'POST',
|
|
38514
|
+
{ },
|
|
38515
|
+
{ },
|
|
38516
|
+
{ },
|
|
38517
|
+
{ },
|
|
38518
|
+
body,
|
|
38519
|
+
['PureCloud OAuth'],
|
|
38520
|
+
['application/json'],
|
|
38521
|
+
['application/json']
|
|
38522
|
+
);
|
|
38523
|
+
}
|
|
38524
|
+
|
|
38397
38525
|
/**
|
|
38398
38526
|
* Change your password
|
|
38399
38527
|
*
|
|
@@ -38755,7 +38883,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
38755
38883
|
/**
|
|
38756
38884
|
* Utilities service.
|
|
38757
38885
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
38758
|
-
* @version
|
|
38886
|
+
* @version 97.0.0
|
|
38759
38887
|
*/
|
|
38760
38888
|
|
|
38761
38889
|
/**
|
|
@@ -38866,7 +38994,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
38866
38994
|
/**
|
|
38867
38995
|
* Voicemail service.
|
|
38868
38996
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
38869
|
-
* @version
|
|
38997
|
+
* @version 97.0.0
|
|
38870
38998
|
*/
|
|
38871
38999
|
|
|
38872
39000
|
/**
|
|
@@ -39503,7 +39631,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
39503
39631
|
/**
|
|
39504
39632
|
* WebChat service.
|
|
39505
39633
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
39506
|
-
* @version
|
|
39634
|
+
* @version 97.0.0
|
|
39507
39635
|
*/
|
|
39508
39636
|
|
|
39509
39637
|
/**
|
|
@@ -40047,7 +40175,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
40047
40175
|
/**
|
|
40048
40176
|
* Widgets service.
|
|
40049
40177
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
40050
|
-
* @version
|
|
40178
|
+
* @version 97.0.0
|
|
40051
40179
|
*/
|
|
40052
40180
|
|
|
40053
40181
|
/**
|
|
@@ -40193,7 +40321,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
40193
40321
|
/**
|
|
40194
40322
|
* WorkforceManagement service.
|
|
40195
40323
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
40196
|
-
* @version
|
|
40324
|
+
* @version 97.0.0
|
|
40197
40325
|
*/
|
|
40198
40326
|
|
|
40199
40327
|
/**
|
|
@@ -40448,166 +40576,6 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
40448
40576
|
);
|
|
40449
40577
|
}
|
|
40450
40578
|
|
|
40451
|
-
/**
|
|
40452
|
-
* Deprecated/Gone: Use the new business unit activity code resources
|
|
40453
|
-
*
|
|
40454
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
40455
|
-
* @param {String} acId The ID of the activity code to delete
|
|
40456
|
-
*/
|
|
40457
|
-
deleteWorkforcemanagementManagementunitActivitycode(muId, acId) {
|
|
40458
|
-
// verify the required parameter 'muId' is set
|
|
40459
|
-
if (muId === undefined || muId === null) {
|
|
40460
|
-
throw 'Missing the required parameter "muId" when calling deleteWorkforcemanagementManagementunitActivitycode';
|
|
40461
|
-
}
|
|
40462
|
-
// verify the required parameter 'acId' is set
|
|
40463
|
-
if (acId === undefined || acId === null) {
|
|
40464
|
-
throw 'Missing the required parameter "acId" when calling deleteWorkforcemanagementManagementunitActivitycode';
|
|
40465
|
-
}
|
|
40466
|
-
|
|
40467
|
-
return this.apiClient.callApi(
|
|
40468
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}',
|
|
40469
|
-
'DELETE',
|
|
40470
|
-
{ 'muId': muId,'acId': acId },
|
|
40471
|
-
{ },
|
|
40472
|
-
{ },
|
|
40473
|
-
{ },
|
|
40474
|
-
null,
|
|
40475
|
-
['PureCloud OAuth'],
|
|
40476
|
-
['application/json'],
|
|
40477
|
-
['application/json']
|
|
40478
|
-
);
|
|
40479
|
-
}
|
|
40480
|
-
|
|
40481
|
-
/**
|
|
40482
|
-
* Gone. Scheduling has moved under business units
|
|
40483
|
-
*
|
|
40484
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
|
|
40485
|
-
* @param {String} runId The ID of the schedule run
|
|
40486
|
-
*/
|
|
40487
|
-
deleteWorkforcemanagementManagementunitSchedulingRun(managementUnitId, runId) {
|
|
40488
|
-
// verify the required parameter 'managementUnitId' is set
|
|
40489
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
40490
|
-
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitSchedulingRun';
|
|
40491
|
-
}
|
|
40492
|
-
// verify the required parameter 'runId' is set
|
|
40493
|
-
if (runId === undefined || runId === null) {
|
|
40494
|
-
throw 'Missing the required parameter "runId" when calling deleteWorkforcemanagementManagementunitSchedulingRun';
|
|
40495
|
-
}
|
|
40496
|
-
|
|
40497
|
-
return this.apiClient.callApi(
|
|
40498
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}',
|
|
40499
|
-
'DELETE',
|
|
40500
|
-
{ 'managementUnitId': managementUnitId,'runId': runId },
|
|
40501
|
-
{ },
|
|
40502
|
-
{ },
|
|
40503
|
-
{ },
|
|
40504
|
-
null,
|
|
40505
|
-
['PureCloud OAuth'],
|
|
40506
|
-
['application/json'],
|
|
40507
|
-
['application/json']
|
|
40508
|
-
);
|
|
40509
|
-
}
|
|
40510
|
-
|
|
40511
|
-
/**
|
|
40512
|
-
* Gone. Replaced with service goal templates and planning groups under business units
|
|
40513
|
-
*
|
|
40514
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
40515
|
-
* @param {String} serviceGoalGroupId Gone. The ID of the service goal group to delete
|
|
40516
|
-
*/
|
|
40517
|
-
deleteWorkforcemanagementManagementunitServicegoalgroup(managementUnitId, serviceGoalGroupId) {
|
|
40518
|
-
// verify the required parameter 'managementUnitId' is set
|
|
40519
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
40520
|
-
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitServicegoalgroup';
|
|
40521
|
-
}
|
|
40522
|
-
// verify the required parameter 'serviceGoalGroupId' is set
|
|
40523
|
-
if (serviceGoalGroupId === undefined || serviceGoalGroupId === null) {
|
|
40524
|
-
throw 'Missing the required parameter "serviceGoalGroupId" when calling deleteWorkforcemanagementManagementunitServicegoalgroup';
|
|
40525
|
-
}
|
|
40526
|
-
|
|
40527
|
-
return this.apiClient.callApi(
|
|
40528
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}',
|
|
40529
|
-
'DELETE',
|
|
40530
|
-
{ 'managementUnitId': managementUnitId,'serviceGoalGroupId': serviceGoalGroupId },
|
|
40531
|
-
{ },
|
|
40532
|
-
{ },
|
|
40533
|
-
{ },
|
|
40534
|
-
null,
|
|
40535
|
-
['PureCloud OAuth'],
|
|
40536
|
-
['application/json'],
|
|
40537
|
-
['application/json']
|
|
40538
|
-
);
|
|
40539
|
-
}
|
|
40540
|
-
|
|
40541
|
-
/**
|
|
40542
|
-
* Gone. Scheduling has moved under business units
|
|
40543
|
-
*
|
|
40544
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
40545
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
40546
|
-
* @param {String} scheduleId Gone/deprecated. The ID of the schedule to delete
|
|
40547
|
-
*/
|
|
40548
|
-
deleteWorkforcemanagementManagementunitWeekSchedule(managementUnitId, weekId, scheduleId) {
|
|
40549
|
-
// verify the required parameter 'managementUnitId' is set
|
|
40550
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
40551
|
-
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWeekSchedule';
|
|
40552
|
-
}
|
|
40553
|
-
// verify the required parameter 'weekId' is set
|
|
40554
|
-
if (weekId === undefined || weekId === null) {
|
|
40555
|
-
throw 'Missing the required parameter "weekId" when calling deleteWorkforcemanagementManagementunitWeekSchedule';
|
|
40556
|
-
}
|
|
40557
|
-
// verify the required parameter 'scheduleId' is set
|
|
40558
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
40559
|
-
throw 'Missing the required parameter "scheduleId" when calling deleteWorkforcemanagementManagementunitWeekSchedule';
|
|
40560
|
-
}
|
|
40561
|
-
|
|
40562
|
-
return this.apiClient.callApi(
|
|
40563
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}',
|
|
40564
|
-
'DELETE',
|
|
40565
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
40566
|
-
{ },
|
|
40567
|
-
{ },
|
|
40568
|
-
{ },
|
|
40569
|
-
null,
|
|
40570
|
-
['PureCloud OAuth'],
|
|
40571
|
-
['application/json'],
|
|
40572
|
-
['application/json']
|
|
40573
|
-
);
|
|
40574
|
-
}
|
|
40575
|
-
|
|
40576
|
-
/**
|
|
40577
|
-
* Gone. Use equivalent business unit resource instead
|
|
40578
|
-
*
|
|
40579
|
-
* @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
|
|
40580
|
-
* @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
|
|
40581
|
-
* @param {String} forecastId (Gone/Deprecated): The ID of the forecast
|
|
40582
|
-
*/
|
|
40583
|
-
deleteWorkforcemanagementManagementunitWeekShorttermforecast(managementUnitId, weekDateId, forecastId) {
|
|
40584
|
-
// verify the required parameter 'managementUnitId' is set
|
|
40585
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
40586
|
-
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWeekShorttermforecast';
|
|
40587
|
-
}
|
|
40588
|
-
// verify the required parameter 'weekDateId' is set
|
|
40589
|
-
if (weekDateId === undefined || weekDateId === null) {
|
|
40590
|
-
throw 'Missing the required parameter "weekDateId" when calling deleteWorkforcemanagementManagementunitWeekShorttermforecast';
|
|
40591
|
-
}
|
|
40592
|
-
// verify the required parameter 'forecastId' is set
|
|
40593
|
-
if (forecastId === undefined || forecastId === null) {
|
|
40594
|
-
throw 'Missing the required parameter "forecastId" when calling deleteWorkforcemanagementManagementunitWeekShorttermforecast';
|
|
40595
|
-
}
|
|
40596
|
-
|
|
40597
|
-
return this.apiClient.callApi(
|
|
40598
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}',
|
|
40599
|
-
'DELETE',
|
|
40600
|
-
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
|
|
40601
|
-
{ },
|
|
40602
|
-
{ },
|
|
40603
|
-
{ },
|
|
40604
|
-
null,
|
|
40605
|
-
['PureCloud OAuth'],
|
|
40606
|
-
['application/json'],
|
|
40607
|
-
['application/json']
|
|
40608
|
-
);
|
|
40609
|
-
}
|
|
40610
|
-
|
|
40611
40579
|
/**
|
|
40612
40580
|
* Delete a work plan
|
|
40613
40581
|
*
|
|
@@ -40638,6 +40606,36 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
40638
40606
|
);
|
|
40639
40607
|
}
|
|
40640
40608
|
|
|
40609
|
+
/**
|
|
40610
|
+
* Delete a work plan rotation
|
|
40611
|
+
*
|
|
40612
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
40613
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to be deleted
|
|
40614
|
+
*/
|
|
40615
|
+
deleteWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId) {
|
|
40616
|
+
// verify the required parameter 'managementUnitId' is set
|
|
40617
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
40618
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWorkplanrotation';
|
|
40619
|
+
}
|
|
40620
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
40621
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
40622
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling deleteWorkforcemanagementManagementunitWorkplanrotation';
|
|
40623
|
+
}
|
|
40624
|
+
|
|
40625
|
+
return this.apiClient.callApi(
|
|
40626
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
|
|
40627
|
+
'DELETE',
|
|
40628
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
40629
|
+
{ },
|
|
40630
|
+
{ },
|
|
40631
|
+
{ },
|
|
40632
|
+
null,
|
|
40633
|
+
['PureCloud OAuth'],
|
|
40634
|
+
['application/json'],
|
|
40635
|
+
['application/json']
|
|
40636
|
+
);
|
|
40637
|
+
}
|
|
40638
|
+
|
|
40641
40639
|
/**
|
|
40642
40640
|
* Get a list of UserScheduleAdherence records for the requested users
|
|
40643
40641
|
*
|
|
@@ -41442,36 +41440,6 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
41442
41440
|
);
|
|
41443
41441
|
}
|
|
41444
41442
|
|
|
41445
|
-
/**
|
|
41446
|
-
* Get an activity code
|
|
41447
|
-
*
|
|
41448
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
41449
|
-
* @param {String} acId The ID of the activity code to fetch
|
|
41450
|
-
*/
|
|
41451
|
-
getWorkforcemanagementManagementunitActivitycode(muId, acId) {
|
|
41452
|
-
// verify the required parameter 'muId' is set
|
|
41453
|
-
if (muId === undefined || muId === null) {
|
|
41454
|
-
throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitActivitycode';
|
|
41455
|
-
}
|
|
41456
|
-
// verify the required parameter 'acId' is set
|
|
41457
|
-
if (acId === undefined || acId === null) {
|
|
41458
|
-
throw 'Missing the required parameter "acId" when calling getWorkforcemanagementManagementunitActivitycode';
|
|
41459
|
-
}
|
|
41460
|
-
|
|
41461
|
-
return this.apiClient.callApi(
|
|
41462
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}',
|
|
41463
|
-
'GET',
|
|
41464
|
-
{ 'muId': muId,'acId': acId },
|
|
41465
|
-
{ },
|
|
41466
|
-
{ },
|
|
41467
|
-
{ },
|
|
41468
|
-
null,
|
|
41469
|
-
['PureCloud OAuth'],
|
|
41470
|
-
['application/json'],
|
|
41471
|
-
['application/json']
|
|
41472
|
-
);
|
|
41473
|
-
}
|
|
41474
|
-
|
|
41475
41443
|
/**
|
|
41476
41444
|
* Get activity codes
|
|
41477
41445
|
*
|
|
@@ -41590,196 +41558,6 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
41590
41558
|
);
|
|
41591
41559
|
}
|
|
41592
41560
|
|
|
41593
|
-
/**
|
|
41594
|
-
* Gone. Moved under business units
|
|
41595
|
-
*
|
|
41596
|
-
* @param {String} muId The management unit ID of the management unit
|
|
41597
|
-
*/
|
|
41598
|
-
getWorkforcemanagementManagementunitIntradayQueues(muId) {
|
|
41599
|
-
// verify the required parameter 'muId' is set
|
|
41600
|
-
if (muId === undefined || muId === null) {
|
|
41601
|
-
throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitIntradayQueues';
|
|
41602
|
-
}
|
|
41603
|
-
|
|
41604
|
-
return this.apiClient.callApi(
|
|
41605
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/intraday/queues',
|
|
41606
|
-
'GET',
|
|
41607
|
-
{ 'muId': muId },
|
|
41608
|
-
{ },
|
|
41609
|
-
{ },
|
|
41610
|
-
{ },
|
|
41611
|
-
null,
|
|
41612
|
-
['PureCloud OAuth'],
|
|
41613
|
-
['application/json'],
|
|
41614
|
-
['application/json']
|
|
41615
|
-
);
|
|
41616
|
-
}
|
|
41617
|
-
|
|
41618
|
-
/**
|
|
41619
|
-
* Gone. Scheduling has moved under business units
|
|
41620
|
-
*
|
|
41621
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
|
|
41622
|
-
* @param {String} runId The ID of the schedule run
|
|
41623
|
-
*/
|
|
41624
|
-
getWorkforcemanagementManagementunitSchedulingRun(managementUnitId, runId) {
|
|
41625
|
-
// verify the required parameter 'managementUnitId' is set
|
|
41626
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
41627
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitSchedulingRun';
|
|
41628
|
-
}
|
|
41629
|
-
// verify the required parameter 'runId' is set
|
|
41630
|
-
if (runId === undefined || runId === null) {
|
|
41631
|
-
throw 'Missing the required parameter "runId" when calling getWorkforcemanagementManagementunitSchedulingRun';
|
|
41632
|
-
}
|
|
41633
|
-
|
|
41634
|
-
return this.apiClient.callApi(
|
|
41635
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}',
|
|
41636
|
-
'GET',
|
|
41637
|
-
{ 'managementUnitId': managementUnitId,'runId': runId },
|
|
41638
|
-
{ },
|
|
41639
|
-
{ },
|
|
41640
|
-
{ },
|
|
41641
|
-
null,
|
|
41642
|
-
['PureCloud OAuth'],
|
|
41643
|
-
['application/json'],
|
|
41644
|
-
['application/json']
|
|
41645
|
-
);
|
|
41646
|
-
}
|
|
41647
|
-
|
|
41648
|
-
/**
|
|
41649
|
-
* Gone. Scheduling has moved under business units
|
|
41650
|
-
*
|
|
41651
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
|
|
41652
|
-
* @param {String} runId The ID of the schedule run
|
|
41653
|
-
*/
|
|
41654
|
-
getWorkforcemanagementManagementunitSchedulingRunResult(managementUnitId, runId) {
|
|
41655
|
-
// verify the required parameter 'managementUnitId' is set
|
|
41656
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
41657
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitSchedulingRunResult';
|
|
41658
|
-
}
|
|
41659
|
-
// verify the required parameter 'runId' is set
|
|
41660
|
-
if (runId === undefined || runId === null) {
|
|
41661
|
-
throw 'Missing the required parameter "runId" when calling getWorkforcemanagementManagementunitSchedulingRunResult';
|
|
41662
|
-
}
|
|
41663
|
-
|
|
41664
|
-
return this.apiClient.callApi(
|
|
41665
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}/result',
|
|
41666
|
-
'GET',
|
|
41667
|
-
{ 'managementUnitId': managementUnitId,'runId': runId },
|
|
41668
|
-
{ },
|
|
41669
|
-
{ },
|
|
41670
|
-
{ },
|
|
41671
|
-
null,
|
|
41672
|
-
['PureCloud OAuth'],
|
|
41673
|
-
['application/json'],
|
|
41674
|
-
['application/json']
|
|
41675
|
-
);
|
|
41676
|
-
}
|
|
41677
|
-
|
|
41678
|
-
/**
|
|
41679
|
-
* Gone. Scheduling has moved under business units
|
|
41680
|
-
*
|
|
41681
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
|
|
41682
|
-
*/
|
|
41683
|
-
getWorkforcemanagementManagementunitSchedulingRuns(managementUnitId) {
|
|
41684
|
-
// verify the required parameter 'managementUnitId' is set
|
|
41685
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
41686
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitSchedulingRuns';
|
|
41687
|
-
}
|
|
41688
|
-
|
|
41689
|
-
return this.apiClient.callApi(
|
|
41690
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs',
|
|
41691
|
-
'GET',
|
|
41692
|
-
{ 'managementUnitId': managementUnitId },
|
|
41693
|
-
{ },
|
|
41694
|
-
{ },
|
|
41695
|
-
{ },
|
|
41696
|
-
null,
|
|
41697
|
-
['PureCloud OAuth'],
|
|
41698
|
-
['application/json'],
|
|
41699
|
-
['application/json']
|
|
41700
|
-
);
|
|
41701
|
-
}
|
|
41702
|
-
|
|
41703
|
-
/**
|
|
41704
|
-
* Gone. Replaced with service goal templates and planning groups under business units
|
|
41705
|
-
*
|
|
41706
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
41707
|
-
* @param {String} serviceGoalGroupId Gone. The ID of the service goal group to fetch
|
|
41708
|
-
*/
|
|
41709
|
-
getWorkforcemanagementManagementunitServicegoalgroup(managementUnitId, serviceGoalGroupId) {
|
|
41710
|
-
// verify the required parameter 'managementUnitId' is set
|
|
41711
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
41712
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitServicegoalgroup';
|
|
41713
|
-
}
|
|
41714
|
-
// verify the required parameter 'serviceGoalGroupId' is set
|
|
41715
|
-
if (serviceGoalGroupId === undefined || serviceGoalGroupId === null) {
|
|
41716
|
-
throw 'Missing the required parameter "serviceGoalGroupId" when calling getWorkforcemanagementManagementunitServicegoalgroup';
|
|
41717
|
-
}
|
|
41718
|
-
|
|
41719
|
-
return this.apiClient.callApi(
|
|
41720
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}',
|
|
41721
|
-
'GET',
|
|
41722
|
-
{ 'managementUnitId': managementUnitId,'serviceGoalGroupId': serviceGoalGroupId },
|
|
41723
|
-
{ },
|
|
41724
|
-
{ },
|
|
41725
|
-
{ },
|
|
41726
|
-
null,
|
|
41727
|
-
['PureCloud OAuth'],
|
|
41728
|
-
['application/json'],
|
|
41729
|
-
['application/json']
|
|
41730
|
-
);
|
|
41731
|
-
}
|
|
41732
|
-
|
|
41733
|
-
/**
|
|
41734
|
-
* Gone. Replaced with service goal templates and planning groups under business units
|
|
41735
|
-
*
|
|
41736
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
41737
|
-
*/
|
|
41738
|
-
getWorkforcemanagementManagementunitServicegoalgroups(managementUnitId) {
|
|
41739
|
-
// verify the required parameter 'managementUnitId' is set
|
|
41740
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
41741
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitServicegoalgroups';
|
|
41742
|
-
}
|
|
41743
|
-
|
|
41744
|
-
return this.apiClient.callApi(
|
|
41745
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups',
|
|
41746
|
-
'GET',
|
|
41747
|
-
{ 'managementUnitId': managementUnitId },
|
|
41748
|
-
{ },
|
|
41749
|
-
{ },
|
|
41750
|
-
{ },
|
|
41751
|
-
null,
|
|
41752
|
-
['PureCloud OAuth'],
|
|
41753
|
-
['application/json'],
|
|
41754
|
-
['application/json']
|
|
41755
|
-
);
|
|
41756
|
-
}
|
|
41757
|
-
|
|
41758
|
-
/**
|
|
41759
|
-
* Gone. Get management unit settings via expand parameters on the GET management unit
|
|
41760
|
-
*
|
|
41761
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
41762
|
-
*/
|
|
41763
|
-
getWorkforcemanagementManagementunitSettings(muId) {
|
|
41764
|
-
// verify the required parameter 'muId' is set
|
|
41765
|
-
if (muId === undefined || muId === null) {
|
|
41766
|
-
throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitSettings';
|
|
41767
|
-
}
|
|
41768
|
-
|
|
41769
|
-
return this.apiClient.callApi(
|
|
41770
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/settings',
|
|
41771
|
-
'GET',
|
|
41772
|
-
{ 'muId': muId },
|
|
41773
|
-
{ },
|
|
41774
|
-
{ },
|
|
41775
|
-
{ },
|
|
41776
|
-
null,
|
|
41777
|
-
['PureCloud OAuth'],
|
|
41778
|
-
['application/json'],
|
|
41779
|
-
['application/json']
|
|
41780
|
-
);
|
|
41781
|
-
}
|
|
41782
|
-
|
|
41783
41561
|
/**
|
|
41784
41562
|
* Gets a summary of all shift trades in the matched state
|
|
41785
41563
|
*
|
|
@@ -41964,41 +41742,6 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
41964
41742
|
);
|
|
41965
41743
|
}
|
|
41966
41744
|
|
|
41967
|
-
/**
|
|
41968
|
-
* Gone. Scheduling has moved under business units
|
|
41969
|
-
*
|
|
41970
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
41971
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
41972
|
-
* @param {String} scheduleId Gone/deprecated. The ID of the schedule to fetch generation results
|
|
41973
|
-
*/
|
|
41974
|
-
getWorkforcemanagementManagementunitWeekScheduleGenerationresults(managementUnitId, weekId, scheduleId) {
|
|
41975
|
-
// verify the required parameter 'managementUnitId' is set
|
|
41976
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
41977
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekScheduleGenerationresults';
|
|
41978
|
-
}
|
|
41979
|
-
// verify the required parameter 'weekId' is set
|
|
41980
|
-
if (weekId === undefined || weekId === null) {
|
|
41981
|
-
throw 'Missing the required parameter "weekId" when calling getWorkforcemanagementManagementunitWeekScheduleGenerationresults';
|
|
41982
|
-
}
|
|
41983
|
-
// verify the required parameter 'scheduleId' is set
|
|
41984
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
41985
|
-
throw 'Missing the required parameter "scheduleId" when calling getWorkforcemanagementManagementunitWeekScheduleGenerationresults';
|
|
41986
|
-
}
|
|
41987
|
-
|
|
41988
|
-
return this.apiClient.callApi(
|
|
41989
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/generationresults',
|
|
41990
|
-
'GET',
|
|
41991
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
41992
|
-
{ },
|
|
41993
|
-
{ },
|
|
41994
|
-
{ },
|
|
41995
|
-
null,
|
|
41996
|
-
['PureCloud OAuth'],
|
|
41997
|
-
['application/json'],
|
|
41998
|
-
['application/json']
|
|
41999
|
-
);
|
|
42000
|
-
}
|
|
42001
|
-
|
|
42002
41745
|
/**
|
|
42003
41746
|
* Deprecated. Use the equivalent business unit resource instead. Get the list of schedules in a week in management unit
|
|
42004
41747
|
*
|
|
@@ -42069,71 +41812,6 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
42069
41812
|
);
|
|
42070
41813
|
}
|
|
42071
41814
|
|
|
42072
|
-
/**
|
|
42073
|
-
* Gone. Use equivalent business unit resource instead
|
|
42074
|
-
*
|
|
42075
|
-
* @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
|
|
42076
|
-
* @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
|
|
42077
|
-
* @param {String} forecastId (Gone/Deprecated): The ID of the forecast
|
|
42078
|
-
*/
|
|
42079
|
-
getWorkforcemanagementManagementunitWeekShorttermforecastFinal(managementUnitId, weekDateId, forecastId) {
|
|
42080
|
-
// verify the required parameter 'managementUnitId' is set
|
|
42081
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
42082
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekShorttermforecastFinal';
|
|
42083
|
-
}
|
|
42084
|
-
// verify the required parameter 'weekDateId' is set
|
|
42085
|
-
if (weekDateId === undefined || weekDateId === null) {
|
|
42086
|
-
throw 'Missing the required parameter "weekDateId" when calling getWorkforcemanagementManagementunitWeekShorttermforecastFinal';
|
|
42087
|
-
}
|
|
42088
|
-
// verify the required parameter 'forecastId' is set
|
|
42089
|
-
if (forecastId === undefined || forecastId === null) {
|
|
42090
|
-
throw 'Missing the required parameter "forecastId" when calling getWorkforcemanagementManagementunitWeekShorttermforecastFinal';
|
|
42091
|
-
}
|
|
42092
|
-
|
|
42093
|
-
return this.apiClient.callApi(
|
|
42094
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/final',
|
|
42095
|
-
'GET',
|
|
42096
|
-
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
|
|
42097
|
-
{ },
|
|
42098
|
-
{ },
|
|
42099
|
-
{ },
|
|
42100
|
-
null,
|
|
42101
|
-
['PureCloud OAuth'],
|
|
42102
|
-
['application/json'],
|
|
42103
|
-
['application/json']
|
|
42104
|
-
);
|
|
42105
|
-
}
|
|
42106
|
-
|
|
42107
|
-
/**
|
|
42108
|
-
* Gone. Use equivalent business unit resource instead
|
|
42109
|
-
*
|
|
42110
|
-
* @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
|
|
42111
|
-
* @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
|
|
42112
|
-
*/
|
|
42113
|
-
getWorkforcemanagementManagementunitWeekShorttermforecasts(managementUnitId, weekDateId) {
|
|
42114
|
-
// verify the required parameter 'managementUnitId' is set
|
|
42115
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
42116
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekShorttermforecasts';
|
|
42117
|
-
}
|
|
42118
|
-
// verify the required parameter 'weekDateId' is set
|
|
42119
|
-
if (weekDateId === undefined || weekDateId === null) {
|
|
42120
|
-
throw 'Missing the required parameter "weekDateId" when calling getWorkforcemanagementManagementunitWeekShorttermforecasts';
|
|
42121
|
-
}
|
|
42122
|
-
|
|
42123
|
-
return this.apiClient.callApi(
|
|
42124
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts',
|
|
42125
|
-
'GET',
|
|
42126
|
-
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
|
|
42127
|
-
{ },
|
|
42128
|
-
{ },
|
|
42129
|
-
{ },
|
|
42130
|
-
null,
|
|
42131
|
-
['PureCloud OAuth'],
|
|
42132
|
-
['application/json'],
|
|
42133
|
-
['application/json']
|
|
42134
|
-
);
|
|
42135
|
-
}
|
|
42136
|
-
|
|
42137
41815
|
/**
|
|
42138
41816
|
* Get a work plan
|
|
42139
41817
|
*
|
|
@@ -42164,6 +41842,65 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
42164
41842
|
);
|
|
42165
41843
|
}
|
|
42166
41844
|
|
|
41845
|
+
/**
|
|
41846
|
+
* Get a work plan rotation
|
|
41847
|
+
*
|
|
41848
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
41849
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to fetch
|
|
41850
|
+
*/
|
|
41851
|
+
getWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId) {
|
|
41852
|
+
// verify the required parameter 'managementUnitId' is set
|
|
41853
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
41854
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplanrotation';
|
|
41855
|
+
}
|
|
41856
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
41857
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
41858
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling getWorkforcemanagementManagementunitWorkplanrotation';
|
|
41859
|
+
}
|
|
41860
|
+
|
|
41861
|
+
return this.apiClient.callApi(
|
|
41862
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
|
|
41863
|
+
'GET',
|
|
41864
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
41865
|
+
{ },
|
|
41866
|
+
{ },
|
|
41867
|
+
{ },
|
|
41868
|
+
null,
|
|
41869
|
+
['PureCloud OAuth'],
|
|
41870
|
+
['application/json'],
|
|
41871
|
+
['application/json']
|
|
41872
|
+
);
|
|
41873
|
+
}
|
|
41874
|
+
|
|
41875
|
+
/**
|
|
41876
|
+
* Get work plan rotations
|
|
41877
|
+
*
|
|
41878
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
41879
|
+
* @param {Object} opts Optional parameters
|
|
41880
|
+
* @param {Array.<String>} opts.expand
|
|
41881
|
+
*/
|
|
41882
|
+
getWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, opts) {
|
|
41883
|
+
opts = opts || {};
|
|
41884
|
+
|
|
41885
|
+
// verify the required parameter 'managementUnitId' is set
|
|
41886
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
41887
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplanrotations';
|
|
41888
|
+
}
|
|
41889
|
+
|
|
41890
|
+
return this.apiClient.callApi(
|
|
41891
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
|
|
41892
|
+
'GET',
|
|
41893
|
+
{ 'managementUnitId': managementUnitId },
|
|
41894
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
41895
|
+
{ },
|
|
41896
|
+
{ },
|
|
41897
|
+
null,
|
|
41898
|
+
['PureCloud OAuth'],
|
|
41899
|
+
['application/json'],
|
|
41900
|
+
['application/json']
|
|
41901
|
+
);
|
|
41902
|
+
}
|
|
41903
|
+
|
|
42167
41904
|
/**
|
|
42168
41905
|
* Get work plans
|
|
42169
41906
|
*
|
|
@@ -42553,129 +42290,6 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
42553
42290
|
);
|
|
42554
42291
|
}
|
|
42555
42292
|
|
|
42556
|
-
/**
|
|
42557
|
-
* Deprecated/Gone: Use the new business unit activity code resources
|
|
42558
|
-
*
|
|
42559
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
42560
|
-
* @param {String} acId The ID of the activity code to update
|
|
42561
|
-
* @param {Object} opts Optional parameters
|
|
42562
|
-
* @param {Object} opts.body body
|
|
42563
|
-
*/
|
|
42564
|
-
patchWorkforcemanagementManagementunitActivitycode(muId, acId, opts) {
|
|
42565
|
-
opts = opts || {};
|
|
42566
|
-
|
|
42567
|
-
// verify the required parameter 'muId' is set
|
|
42568
|
-
if (muId === undefined || muId === null) {
|
|
42569
|
-
throw 'Missing the required parameter "muId" when calling patchWorkforcemanagementManagementunitActivitycode';
|
|
42570
|
-
}
|
|
42571
|
-
// verify the required parameter 'acId' is set
|
|
42572
|
-
if (acId === undefined || acId === null) {
|
|
42573
|
-
throw 'Missing the required parameter "acId" when calling patchWorkforcemanagementManagementunitActivitycode';
|
|
42574
|
-
}
|
|
42575
|
-
|
|
42576
|
-
return this.apiClient.callApi(
|
|
42577
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}',
|
|
42578
|
-
'PATCH',
|
|
42579
|
-
{ 'muId': muId,'acId': acId },
|
|
42580
|
-
{ },
|
|
42581
|
-
{ },
|
|
42582
|
-
{ },
|
|
42583
|
-
opts['body'],
|
|
42584
|
-
['PureCloud OAuth'],
|
|
42585
|
-
['application/json'],
|
|
42586
|
-
['application/json']
|
|
42587
|
-
);
|
|
42588
|
-
}
|
|
42589
|
-
|
|
42590
|
-
/**
|
|
42591
|
-
* Gone. Scheduling has moved under business units
|
|
42592
|
-
*
|
|
42593
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
|
|
42594
|
-
* @param {String} runId The ID of the schedule run
|
|
42595
|
-
* @param {Object} opts Optional parameters
|
|
42596
|
-
* @param {Object} opts.body body
|
|
42597
|
-
*/
|
|
42598
|
-
patchWorkforcemanagementManagementunitSchedulingRun(managementUnitId, runId, opts) {
|
|
42599
|
-
opts = opts || {};
|
|
42600
|
-
|
|
42601
|
-
// verify the required parameter 'managementUnitId' is set
|
|
42602
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
42603
|
-
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitSchedulingRun';
|
|
42604
|
-
}
|
|
42605
|
-
// verify the required parameter 'runId' is set
|
|
42606
|
-
if (runId === undefined || runId === null) {
|
|
42607
|
-
throw 'Missing the required parameter "runId" when calling patchWorkforcemanagementManagementunitSchedulingRun';
|
|
42608
|
-
}
|
|
42609
|
-
|
|
42610
|
-
return this.apiClient.callApi(
|
|
42611
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}',
|
|
42612
|
-
'PATCH',
|
|
42613
|
-
{ 'managementUnitId': managementUnitId,'runId': runId },
|
|
42614
|
-
{ },
|
|
42615
|
-
{ },
|
|
42616
|
-
{ },
|
|
42617
|
-
opts['body'],
|
|
42618
|
-
['PureCloud OAuth'],
|
|
42619
|
-
['application/json'],
|
|
42620
|
-
['application/json']
|
|
42621
|
-
);
|
|
42622
|
-
}
|
|
42623
|
-
|
|
42624
|
-
/**
|
|
42625
|
-
* Gone. Replaced with service goal templates and planning groups under business units
|
|
42626
|
-
*
|
|
42627
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
42628
|
-
* @param {String} serviceGoalGroupId Gone. The ID of the service goal group to update
|
|
42629
|
-
*/
|
|
42630
|
-
patchWorkforcemanagementManagementunitServicegoalgroup(managementUnitId, serviceGoalGroupId) {
|
|
42631
|
-
// verify the required parameter 'managementUnitId' is set
|
|
42632
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
42633
|
-
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitServicegoalgroup';
|
|
42634
|
-
}
|
|
42635
|
-
// verify the required parameter 'serviceGoalGroupId' is set
|
|
42636
|
-
if (serviceGoalGroupId === undefined || serviceGoalGroupId === null) {
|
|
42637
|
-
throw 'Missing the required parameter "serviceGoalGroupId" when calling patchWorkforcemanagementManagementunitServicegoalgroup';
|
|
42638
|
-
}
|
|
42639
|
-
|
|
42640
|
-
return this.apiClient.callApi(
|
|
42641
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}',
|
|
42642
|
-
'PATCH',
|
|
42643
|
-
{ 'managementUnitId': managementUnitId,'serviceGoalGroupId': serviceGoalGroupId },
|
|
42644
|
-
{ },
|
|
42645
|
-
{ },
|
|
42646
|
-
{ },
|
|
42647
|
-
null,
|
|
42648
|
-
['PureCloud OAuth'],
|
|
42649
|
-
['application/json'],
|
|
42650
|
-
['application/json']
|
|
42651
|
-
);
|
|
42652
|
-
}
|
|
42653
|
-
|
|
42654
|
-
/**
|
|
42655
|
-
* Gone. Update settings by PATCHing the management unit
|
|
42656
|
-
*
|
|
42657
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
42658
|
-
*/
|
|
42659
|
-
patchWorkforcemanagementManagementunitSettings(muId) {
|
|
42660
|
-
// verify the required parameter 'muId' is set
|
|
42661
|
-
if (muId === undefined || muId === null) {
|
|
42662
|
-
throw 'Missing the required parameter "muId" when calling patchWorkforcemanagementManagementunitSettings';
|
|
42663
|
-
}
|
|
42664
|
-
|
|
42665
|
-
return this.apiClient.callApi(
|
|
42666
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/settings',
|
|
42667
|
-
'PATCH',
|
|
42668
|
-
{ 'muId': muId },
|
|
42669
|
-
{ },
|
|
42670
|
-
{ },
|
|
42671
|
-
{ },
|
|
42672
|
-
null,
|
|
42673
|
-
['PureCloud OAuth'],
|
|
42674
|
-
['application/json'],
|
|
42675
|
-
['application/json']
|
|
42676
|
-
);
|
|
42677
|
-
}
|
|
42678
|
-
|
|
42679
42293
|
/**
|
|
42680
42294
|
* Update a time off request
|
|
42681
42295
|
*
|
|
@@ -42715,41 +42329,6 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
42715
42329
|
);
|
|
42716
42330
|
}
|
|
42717
42331
|
|
|
42718
|
-
/**
|
|
42719
|
-
* Gone. Scheduling has moved under business units
|
|
42720
|
-
*
|
|
42721
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
42722
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
42723
|
-
* @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
|
|
42724
|
-
*/
|
|
42725
|
-
patchWorkforcemanagementManagementunitWeekSchedule(managementUnitId, weekId, scheduleId) {
|
|
42726
|
-
// verify the required parameter 'managementUnitId' is set
|
|
42727
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
42728
|
-
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWeekSchedule';
|
|
42729
|
-
}
|
|
42730
|
-
// verify the required parameter 'weekId' is set
|
|
42731
|
-
if (weekId === undefined || weekId === null) {
|
|
42732
|
-
throw 'Missing the required parameter "weekId" when calling patchWorkforcemanagementManagementunitWeekSchedule';
|
|
42733
|
-
}
|
|
42734
|
-
// verify the required parameter 'scheduleId' is set
|
|
42735
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
42736
|
-
throw 'Missing the required parameter "scheduleId" when calling patchWorkforcemanagementManagementunitWeekSchedule';
|
|
42737
|
-
}
|
|
42738
|
-
|
|
42739
|
-
return this.apiClient.callApi(
|
|
42740
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}',
|
|
42741
|
-
'PATCH',
|
|
42742
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
42743
|
-
{ },
|
|
42744
|
-
{ },
|
|
42745
|
-
{ },
|
|
42746
|
-
null,
|
|
42747
|
-
['PureCloud OAuth'],
|
|
42748
|
-
['application/json'],
|
|
42749
|
-
['application/json']
|
|
42750
|
-
);
|
|
42751
|
-
}
|
|
42752
|
-
|
|
42753
42332
|
/**
|
|
42754
42333
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
42755
42334
|
*
|
|
@@ -42824,6 +42403,40 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
42824
42403
|
);
|
|
42825
42404
|
}
|
|
42826
42405
|
|
|
42406
|
+
/**
|
|
42407
|
+
* Update a work plan rotation
|
|
42408
|
+
*
|
|
42409
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
42410
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to update
|
|
42411
|
+
* @param {Object} opts Optional parameters
|
|
42412
|
+
* @param {Object} opts.body body
|
|
42413
|
+
*/
|
|
42414
|
+
patchWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId, opts) {
|
|
42415
|
+
opts = opts || {};
|
|
42416
|
+
|
|
42417
|
+
// verify the required parameter 'managementUnitId' is set
|
|
42418
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
42419
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
|
|
42420
|
+
}
|
|
42421
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
42422
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
42423
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
|
|
42424
|
+
}
|
|
42425
|
+
|
|
42426
|
+
return this.apiClient.callApi(
|
|
42427
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
|
|
42428
|
+
'PATCH',
|
|
42429
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
42430
|
+
{ },
|
|
42431
|
+
{ },
|
|
42432
|
+
{ },
|
|
42433
|
+
opts['body'],
|
|
42434
|
+
['PureCloud OAuth'],
|
|
42435
|
+
['application/json'],
|
|
42436
|
+
['application/json']
|
|
42437
|
+
);
|
|
42438
|
+
}
|
|
42439
|
+
|
|
42827
42440
|
/**
|
|
42828
42441
|
* Update a time off request for the current user
|
|
42829
42442
|
*
|
|
@@ -43351,31 +42964,6 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
43351
42964
|
);
|
|
43352
42965
|
}
|
|
43353
42966
|
|
|
43354
|
-
/**
|
|
43355
|
-
* Deprecated/Gone: Use the new business unit activity code resources
|
|
43356
|
-
*
|
|
43357
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
43358
|
-
*/
|
|
43359
|
-
postWorkforcemanagementManagementunitActivitycodes(muId) {
|
|
43360
|
-
// verify the required parameter 'muId' is set
|
|
43361
|
-
if (muId === undefined || muId === null) {
|
|
43362
|
-
throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitActivitycodes';
|
|
43363
|
-
}
|
|
43364
|
-
|
|
43365
|
-
return this.apiClient.callApi(
|
|
43366
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/activitycodes',
|
|
43367
|
-
'POST',
|
|
43368
|
-
{ 'muId': muId },
|
|
43369
|
-
{ },
|
|
43370
|
-
{ },
|
|
43371
|
-
{ },
|
|
43372
|
-
null,
|
|
43373
|
-
['PureCloud OAuth'],
|
|
43374
|
-
['application/json'],
|
|
43375
|
-
['application/json']
|
|
43376
|
-
);
|
|
43377
|
-
}
|
|
43378
|
-
|
|
43379
42967
|
/**
|
|
43380
42968
|
* Query published schedules for given given time range for set of users
|
|
43381
42969
|
*
|
|
@@ -43436,31 +43024,6 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
43436
43024
|
);
|
|
43437
43025
|
}
|
|
43438
43026
|
|
|
43439
|
-
/**
|
|
43440
|
-
* Gone. Moved under business units
|
|
43441
|
-
*
|
|
43442
|
-
* @param {String} muId The management unit ID of the management unit
|
|
43443
|
-
*/
|
|
43444
|
-
postWorkforcemanagementManagementunitIntraday(muId) {
|
|
43445
|
-
// verify the required parameter 'muId' is set
|
|
43446
|
-
if (muId === undefined || muId === null) {
|
|
43447
|
-
throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitIntraday';
|
|
43448
|
-
}
|
|
43449
|
-
|
|
43450
|
-
return this.apiClient.callApi(
|
|
43451
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/intraday',
|
|
43452
|
-
'POST',
|
|
43453
|
-
{ 'muId': muId },
|
|
43454
|
-
{ },
|
|
43455
|
-
{ },
|
|
43456
|
-
{ },
|
|
43457
|
-
null,
|
|
43458
|
-
['PureCloud OAuth'],
|
|
43459
|
-
['application/json'],
|
|
43460
|
-
['application/json']
|
|
43461
|
-
);
|
|
43462
|
-
}
|
|
43463
|
-
|
|
43464
43027
|
/**
|
|
43465
43028
|
* Move the requested management unit to a new business unit
|
|
43466
43029
|
* Returns status 200 if the management unit is already in the requested business unit
|
|
@@ -43519,31 +43082,6 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
43519
43082
|
);
|
|
43520
43083
|
}
|
|
43521
43084
|
|
|
43522
|
-
/**
|
|
43523
|
-
* Gone. Replaced with service goal templates and planning groups under business units
|
|
43524
|
-
*
|
|
43525
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
43526
|
-
*/
|
|
43527
|
-
postWorkforcemanagementManagementunitServicegoalgroups(managementUnitId) {
|
|
43528
|
-
// verify the required parameter 'managementUnitId' is set
|
|
43529
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
43530
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitServicegoalgroups';
|
|
43531
|
-
}
|
|
43532
|
-
|
|
43533
|
-
return this.apiClient.callApi(
|
|
43534
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups',
|
|
43535
|
-
'POST',
|
|
43536
|
-
{ 'managementUnitId': managementUnitId },
|
|
43537
|
-
{ },
|
|
43538
|
-
{ },
|
|
43539
|
-
{ },
|
|
43540
|
-
null,
|
|
43541
|
-
['PureCloud OAuth'],
|
|
43542
|
-
['application/json'],
|
|
43543
|
-
['application/json']
|
|
43544
|
-
);
|
|
43545
|
-
}
|
|
43546
|
-
|
|
43547
43085
|
/**
|
|
43548
43086
|
* Create a new time off request
|
|
43549
43087
|
*
|
|
@@ -43573,35 +43111,6 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
43573
43111
|
);
|
|
43574
43112
|
}
|
|
43575
43113
|
|
|
43576
|
-
/**
|
|
43577
|
-
* Gone. All data is now returned in the query route
|
|
43578
|
-
*
|
|
43579
|
-
* @param {String} muId The muId of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
43580
|
-
* @param {Object} opts Optional parameters
|
|
43581
|
-
* @param {Object} opts.body body
|
|
43582
|
-
*/
|
|
43583
|
-
postWorkforcemanagementManagementunitTimeoffrequestsFetchdetails(muId, opts) {
|
|
43584
|
-
opts = opts || {};
|
|
43585
|
-
|
|
43586
|
-
// verify the required parameter 'muId' is set
|
|
43587
|
-
if (muId === undefined || muId === null) {
|
|
43588
|
-
throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitTimeoffrequestsFetchdetails';
|
|
43589
|
-
}
|
|
43590
|
-
|
|
43591
|
-
return this.apiClient.callApi(
|
|
43592
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests/fetchdetails',
|
|
43593
|
-
'POST',
|
|
43594
|
-
{ 'muId': muId },
|
|
43595
|
-
{ },
|
|
43596
|
-
{ },
|
|
43597
|
-
{ },
|
|
43598
|
-
opts['body'],
|
|
43599
|
-
['PureCloud OAuth'],
|
|
43600
|
-
['application/json'],
|
|
43601
|
-
['application/json']
|
|
43602
|
-
);
|
|
43603
|
-
}
|
|
43604
|
-
|
|
43605
43114
|
/**
|
|
43606
43115
|
* Gets the lookup ids to fetch the specified set of requests
|
|
43607
43116
|
*
|
|
@@ -43631,166 +43140,6 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
43631
43140
|
);
|
|
43632
43141
|
}
|
|
43633
43142
|
|
|
43634
|
-
/**
|
|
43635
|
-
* Gone. Scheduling has moved under business units
|
|
43636
|
-
*
|
|
43637
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
43638
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
43639
|
-
* @param {String} scheduleId Gone/deprecated. The ID of the schedule to copy from
|
|
43640
|
-
*/
|
|
43641
|
-
postWorkforcemanagementManagementunitWeekScheduleCopy(managementUnitId, weekId, scheduleId) {
|
|
43642
|
-
// verify the required parameter 'managementUnitId' is set
|
|
43643
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
43644
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekScheduleCopy';
|
|
43645
|
-
}
|
|
43646
|
-
// verify the required parameter 'weekId' is set
|
|
43647
|
-
if (weekId === undefined || weekId === null) {
|
|
43648
|
-
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekScheduleCopy';
|
|
43649
|
-
}
|
|
43650
|
-
// verify the required parameter 'scheduleId' is set
|
|
43651
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
43652
|
-
throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementManagementunitWeekScheduleCopy';
|
|
43653
|
-
}
|
|
43654
|
-
|
|
43655
|
-
return this.apiClient.callApi(
|
|
43656
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy',
|
|
43657
|
-
'POST',
|
|
43658
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
43659
|
-
{ },
|
|
43660
|
-
{ },
|
|
43661
|
-
{ },
|
|
43662
|
-
null,
|
|
43663
|
-
['PureCloud OAuth'],
|
|
43664
|
-
['application/json'],
|
|
43665
|
-
['application/json']
|
|
43666
|
-
);
|
|
43667
|
-
}
|
|
43668
|
-
|
|
43669
|
-
/**
|
|
43670
|
-
* Gone. Scheduling has moved under business units
|
|
43671
|
-
*
|
|
43672
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
43673
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
43674
|
-
* @param {String} scheduleId Gone/deprecated. The ID of the schedule to re-optimize
|
|
43675
|
-
*/
|
|
43676
|
-
postWorkforcemanagementManagementunitWeekScheduleReschedule(managementUnitId, weekId, scheduleId) {
|
|
43677
|
-
// verify the required parameter 'managementUnitId' is set
|
|
43678
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
43679
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekScheduleReschedule';
|
|
43680
|
-
}
|
|
43681
|
-
// verify the required parameter 'weekId' is set
|
|
43682
|
-
if (weekId === undefined || weekId === null) {
|
|
43683
|
-
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekScheduleReschedule';
|
|
43684
|
-
}
|
|
43685
|
-
// verify the required parameter 'scheduleId' is set
|
|
43686
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
43687
|
-
throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementManagementunitWeekScheduleReschedule';
|
|
43688
|
-
}
|
|
43689
|
-
|
|
43690
|
-
return this.apiClient.callApi(
|
|
43691
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/reschedule',
|
|
43692
|
-
'POST',
|
|
43693
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
43694
|
-
{ },
|
|
43695
|
-
{ },
|
|
43696
|
-
{ },
|
|
43697
|
-
null,
|
|
43698
|
-
['PureCloud OAuth'],
|
|
43699
|
-
['application/json'],
|
|
43700
|
-
['application/json']
|
|
43701
|
-
);
|
|
43702
|
-
}
|
|
43703
|
-
|
|
43704
|
-
/**
|
|
43705
|
-
* Gone. Scheduling has moved under business units
|
|
43706
|
-
*
|
|
43707
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
43708
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
43709
|
-
*/
|
|
43710
|
-
postWorkforcemanagementManagementunitWeekSchedules(managementUnitId, weekId) {
|
|
43711
|
-
// verify the required parameter 'managementUnitId' is set
|
|
43712
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
43713
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekSchedules';
|
|
43714
|
-
}
|
|
43715
|
-
// verify the required parameter 'weekId' is set
|
|
43716
|
-
if (weekId === undefined || weekId === null) {
|
|
43717
|
-
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekSchedules';
|
|
43718
|
-
}
|
|
43719
|
-
|
|
43720
|
-
return this.apiClient.callApi(
|
|
43721
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules',
|
|
43722
|
-
'POST',
|
|
43723
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId },
|
|
43724
|
-
{ },
|
|
43725
|
-
{ },
|
|
43726
|
-
{ },
|
|
43727
|
-
null,
|
|
43728
|
-
['PureCloud OAuth'],
|
|
43729
|
-
['application/json'],
|
|
43730
|
-
['application/json']
|
|
43731
|
-
);
|
|
43732
|
-
}
|
|
43733
|
-
|
|
43734
|
-
/**
|
|
43735
|
-
* Gone. Scheduling has moved under business units
|
|
43736
|
-
*
|
|
43737
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
43738
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
43739
|
-
*/
|
|
43740
|
-
postWorkforcemanagementManagementunitWeekSchedulesGenerate(managementUnitId, weekId) {
|
|
43741
|
-
// verify the required parameter 'managementUnitId' is set
|
|
43742
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
43743
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekSchedulesGenerate';
|
|
43744
|
-
}
|
|
43745
|
-
// verify the required parameter 'weekId' is set
|
|
43746
|
-
if (weekId === undefined || weekId === null) {
|
|
43747
|
-
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekSchedulesGenerate';
|
|
43748
|
-
}
|
|
43749
|
-
|
|
43750
|
-
return this.apiClient.callApi(
|
|
43751
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/generate',
|
|
43752
|
-
'POST',
|
|
43753
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId },
|
|
43754
|
-
{ },
|
|
43755
|
-
{ },
|
|
43756
|
-
{ },
|
|
43757
|
-
null,
|
|
43758
|
-
['PureCloud OAuth'],
|
|
43759
|
-
['application/json'],
|
|
43760
|
-
['application/json']
|
|
43761
|
-
);
|
|
43762
|
-
}
|
|
43763
|
-
|
|
43764
|
-
/**
|
|
43765
|
-
* Gone. Scheduling has moved under business units
|
|
43766
|
-
*
|
|
43767
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
43768
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
43769
|
-
*/
|
|
43770
|
-
postWorkforcemanagementManagementunitWeekSchedulesPartialupload(managementUnitId, weekId) {
|
|
43771
|
-
// verify the required parameter 'managementUnitId' is set
|
|
43772
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
43773
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekSchedulesPartialupload';
|
|
43774
|
-
}
|
|
43775
|
-
// verify the required parameter 'weekId' is set
|
|
43776
|
-
if (weekId === undefined || weekId === null) {
|
|
43777
|
-
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekSchedulesPartialupload';
|
|
43778
|
-
}
|
|
43779
|
-
|
|
43780
|
-
return this.apiClient.callApi(
|
|
43781
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/partialupload',
|
|
43782
|
-
'POST',
|
|
43783
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId },
|
|
43784
|
-
{ },
|
|
43785
|
-
{ },
|
|
43786
|
-
{ },
|
|
43787
|
-
null,
|
|
43788
|
-
['PureCloud OAuth'],
|
|
43789
|
-
['application/json'],
|
|
43790
|
-
['application/json']
|
|
43791
|
-
);
|
|
43792
|
-
}
|
|
43793
|
-
|
|
43794
43143
|
/**
|
|
43795
43144
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
43796
43145
|
*
|
|
@@ -43941,94 +43290,33 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
43941
43290
|
}
|
|
43942
43291
|
|
|
43943
43292
|
/**
|
|
43944
|
-
*
|
|
43945
|
-
*
|
|
43946
|
-
* @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
|
|
43947
|
-
* @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
|
|
43948
|
-
* @param {String} forecastId (Gone/Deprecated): The ID of the forecast
|
|
43949
|
-
*/
|
|
43950
|
-
postWorkforcemanagementManagementunitWeekShorttermforecastCopy(managementUnitId, weekDateId, forecastId) {
|
|
43951
|
-
// verify the required parameter 'managementUnitId' is set
|
|
43952
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
43953
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastCopy';
|
|
43954
|
-
}
|
|
43955
|
-
// verify the required parameter 'weekDateId' is set
|
|
43956
|
-
if (weekDateId === undefined || weekDateId === null) {
|
|
43957
|
-
throw 'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastCopy';
|
|
43958
|
-
}
|
|
43959
|
-
// verify the required parameter 'forecastId' is set
|
|
43960
|
-
if (forecastId === undefined || forecastId === null) {
|
|
43961
|
-
throw 'Missing the required parameter "forecastId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastCopy';
|
|
43962
|
-
}
|
|
43963
|
-
|
|
43964
|
-
return this.apiClient.callApi(
|
|
43965
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/copy',
|
|
43966
|
-
'POST',
|
|
43967
|
-
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
|
|
43968
|
-
{ },
|
|
43969
|
-
{ },
|
|
43970
|
-
{ },
|
|
43971
|
-
null,
|
|
43972
|
-
['PureCloud OAuth'],
|
|
43973
|
-
['application/json'],
|
|
43974
|
-
['application/json']
|
|
43975
|
-
);
|
|
43976
|
-
}
|
|
43977
|
-
|
|
43978
|
-
/**
|
|
43979
|
-
* Gone. Use equivalent business unit resource instead
|
|
43980
|
-
*
|
|
43981
|
-
* @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
|
|
43982
|
-
* @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
|
|
43983
|
-
*/
|
|
43984
|
-
postWorkforcemanagementManagementunitWeekShorttermforecasts(managementUnitId, weekDateId) {
|
|
43985
|
-
// verify the required parameter 'managementUnitId' is set
|
|
43986
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
43987
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShorttermforecasts';
|
|
43988
|
-
}
|
|
43989
|
-
// verify the required parameter 'weekDateId' is set
|
|
43990
|
-
if (weekDateId === undefined || weekDateId === null) {
|
|
43991
|
-
throw 'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShorttermforecasts';
|
|
43992
|
-
}
|
|
43993
|
-
|
|
43994
|
-
return this.apiClient.callApi(
|
|
43995
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts',
|
|
43996
|
-
'POST',
|
|
43997
|
-
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
|
|
43998
|
-
{ },
|
|
43999
|
-
{ },
|
|
44000
|
-
{ },
|
|
44001
|
-
null,
|
|
44002
|
-
['PureCloud OAuth'],
|
|
44003
|
-
['application/json'],
|
|
44004
|
-
['application/json']
|
|
44005
|
-
);
|
|
44006
|
-
}
|
|
44007
|
-
|
|
44008
|
-
/**
|
|
44009
|
-
* Gone. Use equivalent business unit resource instead
|
|
43293
|
+
* Create a copy of work plan
|
|
44010
43294
|
*
|
|
44011
|
-
* @param {String} managementUnitId
|
|
44012
|
-
* @param {String}
|
|
43295
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
43296
|
+
* @param {String} workPlanId The ID of the work plan to create a copy
|
|
43297
|
+
* @param {Object} opts Optional parameters
|
|
43298
|
+
* @param {Object} opts.body body
|
|
44013
43299
|
*/
|
|
44014
|
-
|
|
43300
|
+
postWorkforcemanagementManagementunitWorkplanCopy(managementUnitId, workPlanId, opts) {
|
|
43301
|
+
opts = opts || {};
|
|
43302
|
+
|
|
44015
43303
|
// verify the required parameter 'managementUnitId' is set
|
|
44016
43304
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
44017
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
43305
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
|
|
44018
43306
|
}
|
|
44019
|
-
// verify the required parameter '
|
|
44020
|
-
if (
|
|
44021
|
-
throw 'Missing the required parameter "
|
|
43307
|
+
// verify the required parameter 'workPlanId' is set
|
|
43308
|
+
if (workPlanId === undefined || workPlanId === null) {
|
|
43309
|
+
throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
|
|
44022
43310
|
}
|
|
44023
43311
|
|
|
44024
43312
|
return this.apiClient.callApi(
|
|
44025
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
43313
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy',
|
|
44026
43314
|
'POST',
|
|
44027
|
-
{ 'managementUnitId': managementUnitId,'
|
|
43315
|
+
{ 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
|
|
44028
43316
|
{ },
|
|
44029
43317
|
{ },
|
|
44030
43318
|
{ },
|
|
44031
|
-
|
|
43319
|
+
opts['body'],
|
|
44032
43320
|
['PureCloud OAuth'],
|
|
44033
43321
|
['application/json'],
|
|
44034
43322
|
['application/json']
|
|
@@ -44036,29 +43324,34 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
44036
43324
|
}
|
|
44037
43325
|
|
|
44038
43326
|
/**
|
|
44039
|
-
*
|
|
43327
|
+
* Validate Work Plan
|
|
44040
43328
|
*
|
|
44041
|
-
* @param {String} managementUnitId
|
|
44042
|
-
* @param {String}
|
|
43329
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
43330
|
+
* @param {String} workPlanId The ID of the work plan to validate. For new work plan, use the word 'new' for the ID.
|
|
43331
|
+
* @param {Object} opts Optional parameters
|
|
43332
|
+
* @param {Object} opts.body body
|
|
43333
|
+
* @param {Array.<String>} opts.expand
|
|
44043
43334
|
*/
|
|
44044
|
-
|
|
43335
|
+
postWorkforcemanagementManagementunitWorkplanValidate(managementUnitId, workPlanId, opts) {
|
|
43336
|
+
opts = opts || {};
|
|
43337
|
+
|
|
44045
43338
|
// verify the required parameter 'managementUnitId' is set
|
|
44046
43339
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
44047
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
43340
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
|
|
44048
43341
|
}
|
|
44049
|
-
// verify the required parameter '
|
|
44050
|
-
if (
|
|
44051
|
-
throw 'Missing the required parameter "
|
|
43342
|
+
// verify the required parameter 'workPlanId' is set
|
|
43343
|
+
if (workPlanId === undefined || workPlanId === null) {
|
|
43344
|
+
throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
|
|
44052
43345
|
}
|
|
44053
43346
|
|
|
44054
43347
|
return this.apiClient.callApi(
|
|
44055
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
43348
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate',
|
|
44056
43349
|
'POST',
|
|
44057
|
-
{ 'managementUnitId': managementUnitId,'
|
|
44058
|
-
{
|
|
43350
|
+
{ 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
|
|
43351
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
44059
43352
|
{ },
|
|
44060
43353
|
{ },
|
|
44061
|
-
|
|
43354
|
+
opts['body'],
|
|
44062
43355
|
['PureCloud OAuth'],
|
|
44063
43356
|
['application/json'],
|
|
44064
43357
|
['application/json']
|
|
@@ -44066,29 +43359,29 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
44066
43359
|
}
|
|
44067
43360
|
|
|
44068
43361
|
/**
|
|
44069
|
-
* Create a copy of work plan
|
|
43362
|
+
* Create a copy of work plan rotation
|
|
44070
43363
|
*
|
|
44071
43364
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
44072
|
-
* @param {String}
|
|
43365
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to create a copy
|
|
44073
43366
|
* @param {Object} opts Optional parameters
|
|
44074
43367
|
* @param {Object} opts.body body
|
|
44075
43368
|
*/
|
|
44076
|
-
|
|
43369
|
+
postWorkforcemanagementManagementunitWorkplanrotationCopy(managementUnitId, workPlanRotationId, opts) {
|
|
44077
43370
|
opts = opts || {};
|
|
44078
43371
|
|
|
44079
43372
|
// verify the required parameter 'managementUnitId' is set
|
|
44080
43373
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
44081
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
43374
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
|
|
44082
43375
|
}
|
|
44083
|
-
// verify the required parameter '
|
|
44084
|
-
if (
|
|
44085
|
-
throw 'Missing the required parameter "
|
|
43376
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
43377
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
43378
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
|
|
44086
43379
|
}
|
|
44087
43380
|
|
|
44088
43381
|
return this.apiClient.callApi(
|
|
44089
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
43382
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy',
|
|
44090
43383
|
'POST',
|
|
44091
|
-
{ 'managementUnitId': managementUnitId,'
|
|
43384
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
44092
43385
|
{ },
|
|
44093
43386
|
{ },
|
|
44094
43387
|
{ },
|
|
@@ -44100,31 +43393,25 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
44100
43393
|
}
|
|
44101
43394
|
|
|
44102
43395
|
/**
|
|
44103
|
-
*
|
|
43396
|
+
* Create a new work plan rotation
|
|
44104
43397
|
*
|
|
44105
43398
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
44106
|
-
* @param {String} workPlanId The ID of the work plan to validate. For new work plan, use the word 'new' for the ID.
|
|
44107
43399
|
* @param {Object} opts Optional parameters
|
|
44108
43400
|
* @param {Object} opts.body body
|
|
44109
|
-
* @param {Array.<String>} opts.expand
|
|
44110
43401
|
*/
|
|
44111
|
-
|
|
43402
|
+
postWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, opts) {
|
|
44112
43403
|
opts = opts || {};
|
|
44113
43404
|
|
|
44114
43405
|
// verify the required parameter 'managementUnitId' is set
|
|
44115
43406
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
44116
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
44117
|
-
}
|
|
44118
|
-
// verify the required parameter 'workPlanId' is set
|
|
44119
|
-
if (workPlanId === undefined || workPlanId === null) {
|
|
44120
|
-
throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
|
|
43407
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotations';
|
|
44121
43408
|
}
|
|
44122
43409
|
|
|
44123
43410
|
return this.apiClient.callApi(
|
|
44124
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
43411
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
|
|
44125
43412
|
'POST',
|
|
44126
|
-
{ 'managementUnitId': managementUnitId
|
|
44127
|
-
{
|
|
43413
|
+
{ 'managementUnitId': managementUnitId },
|
|
43414
|
+
{ },
|
|
44128
43415
|
{ },
|
|
44129
43416
|
{ },
|
|
44130
43417
|
opts['body'],
|
|
@@ -44290,7 +43577,7 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
44290
43577
|
* </pre>
|
|
44291
43578
|
* </p>
|
|
44292
43579
|
* @module purecloud-platform-client-v2/index
|
|
44293
|
-
* @version
|
|
43580
|
+
* @version 97.0.0
|
|
44294
43581
|
*/
|
|
44295
43582
|
class platformClient {
|
|
44296
43583
|
constructor() {
|
|
@@ -44549,11 +43836,6 @@ define(['superagent'], function (superagent) { 'use strict';
|
|
|
44549
43836
|
* @property {module:purecloud-platform-client-v2/api/UsageApi}
|
|
44550
43837
|
*/
|
|
44551
43838
|
this.UsageApi = UsageApi;
|
|
44552
|
-
/**
|
|
44553
|
-
* The UserDevelopmentApi service constructor.
|
|
44554
|
-
* @property {module:purecloud-platform-client-v2/api/UserDevelopmentApi}
|
|
44555
|
-
*/
|
|
44556
|
-
this.UserDevelopmentApi = UserDevelopmentApi;
|
|
44557
43839
|
/**
|
|
44558
43840
|
* The UserRecordingsApi service constructor.
|
|
44559
43841
|
* @property {module:purecloud-platform-client-v2/api/UserRecordingsApi}
|