purecloud-platform-client-v2 95.0.0 → 98.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/node/purecloud-platform-client-v2.js +412 -1256
- package/dist/web-amd/purecloud-platform-client-v2.js +412 -1256
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +412 -1256
- package/dist/web-cjs/purecloud-platform-client-v2.js +418 -1263
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +319 -128
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +4 -2
- package/src/purecloud-platform-client-v2/api/BillingApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +26 -10
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +6 -4
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +9 -8
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +26 -26
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +123 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +309 -1148
- package/src/purecloud-platform-client-v2/index.js +1 -7
- package/src/purecloud-platform-client-v2/api/UserDevelopmentApi.js +0 -148
|
@@ -18,7 +18,7 @@ var PureCloudRegionHosts = {
|
|
|
18
18
|
|
|
19
19
|
/**
|
|
20
20
|
* @module purecloud-platform-client-v2/ApiClient
|
|
21
|
-
* @version
|
|
21
|
+
* @version 98.0.0
|
|
22
22
|
*/
|
|
23
23
|
class ApiClient {
|
|
24
24
|
/**
|
|
@@ -774,7 +774,7 @@ class ApiClient {
|
|
|
774
774
|
|
|
775
775
|
// set header parameters
|
|
776
776
|
request.set(this.defaultHeaders).set(this.normalizeParams(headerParams));
|
|
777
|
-
//request.set({ 'purecloud-sdk': '
|
|
777
|
+
//request.set({ 'purecloud-sdk': '98.0.0' });
|
|
778
778
|
|
|
779
779
|
// set request timeout
|
|
780
780
|
request.timeout(this.timeout);
|
|
@@ -899,7 +899,7 @@ class AlertingApi {
|
|
|
899
899
|
/**
|
|
900
900
|
* Alerting service.
|
|
901
901
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
902
|
-
* @version
|
|
902
|
+
* @version 98.0.0
|
|
903
903
|
*/
|
|
904
904
|
|
|
905
905
|
/**
|
|
@@ -1213,7 +1213,7 @@ class AnalyticsApi {
|
|
|
1213
1213
|
/**
|
|
1214
1214
|
* Analytics service.
|
|
1215
1215
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1216
|
-
* @version
|
|
1216
|
+
* @version 98.0.0
|
|
1217
1217
|
*/
|
|
1218
1218
|
|
|
1219
1219
|
/**
|
|
@@ -2293,7 +2293,7 @@ class ArchitectApi {
|
|
|
2293
2293
|
/**
|
|
2294
2294
|
* Architect service.
|
|
2295
2295
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2296
|
-
* @version
|
|
2296
|
+
* @version 98.0.0
|
|
2297
2297
|
*/
|
|
2298
2298
|
|
|
2299
2299
|
/**
|
|
@@ -5131,7 +5131,7 @@ class AuditApi {
|
|
|
5131
5131
|
/**
|
|
5132
5132
|
* Audit service.
|
|
5133
5133
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
5134
|
-
* @version
|
|
5134
|
+
* @version 98.0.0
|
|
5135
5135
|
*/
|
|
5136
5136
|
|
|
5137
5137
|
/**
|
|
@@ -5302,7 +5302,7 @@ class AuthorizationApi {
|
|
|
5302
5302
|
/**
|
|
5303
5303
|
* Authorization service.
|
|
5304
5304
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
5305
|
-
* @version
|
|
5305
|
+
* @version 98.0.0
|
|
5306
5306
|
*/
|
|
5307
5307
|
|
|
5308
5308
|
/**
|
|
@@ -5637,6 +5637,8 @@ class AuthorizationApi {
|
|
|
5637
5637
|
* @param {Object} opts Optional parameters
|
|
5638
5638
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
5639
5639
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
5640
|
+
* @param {Object} opts.queryType Query filter type
|
|
5641
|
+
* @param {String} opts.query Comma-separated list of permissions or domains to query
|
|
5640
5642
|
*/
|
|
5641
5643
|
getAuthorizationPermissions(opts) {
|
|
5642
5644
|
opts = opts || {};
|
|
@@ -5646,7 +5648,7 @@ class AuthorizationApi {
|
|
|
5646
5648
|
'/api/v2/authorization/permissions',
|
|
5647
5649
|
'GET',
|
|
5648
5650
|
{ },
|
|
5649
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
5651
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'queryType': opts['queryType'],'query': opts['query'] },
|
|
5650
5652
|
{ },
|
|
5651
5653
|
{ },
|
|
5652
5654
|
null,
|
|
@@ -6419,7 +6421,7 @@ class BillingApi {
|
|
|
6419
6421
|
/**
|
|
6420
6422
|
* Billing service.
|
|
6421
6423
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
6422
|
-
* @version
|
|
6424
|
+
* @version 98.0.0
|
|
6423
6425
|
*/
|
|
6424
6426
|
|
|
6425
6427
|
/**
|
|
@@ -6437,8 +6439,8 @@ class BillingApi {
|
|
|
6437
6439
|
/**
|
|
6438
6440
|
* Get a report of the billable license usages
|
|
6439
6441
|
* 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.
|
|
6440
|
-
* @param {Date} startDate The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
6441
|
-
* @param {Date} endDate The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
6442
|
+
* @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
|
|
6443
|
+
* @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
|
|
6442
6444
|
*/
|
|
6443
6445
|
getBillingReportsBillableusage(startDate, endDate) {
|
|
6444
6446
|
// verify the required parameter 'startDate' is set
|
|
@@ -6499,7 +6501,7 @@ class CoachingApi {
|
|
|
6499
6501
|
/**
|
|
6500
6502
|
* Coaching service.
|
|
6501
6503
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
6502
|
-
* @version
|
|
6504
|
+
* @version 98.0.0
|
|
6503
6505
|
*/
|
|
6504
6506
|
|
|
6505
6507
|
/**
|
|
@@ -7019,7 +7021,7 @@ class ContentManagementApi {
|
|
|
7019
7021
|
/**
|
|
7020
7022
|
* ContentManagement service.
|
|
7021
7023
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
7022
|
-
* @version
|
|
7024
|
+
* @version 98.0.0
|
|
7023
7025
|
*/
|
|
7024
7026
|
|
|
7025
7027
|
/**
|
|
@@ -8159,7 +8161,7 @@ class ConversationsApi {
|
|
|
8159
8161
|
/**
|
|
8160
8162
|
* Conversations service.
|
|
8161
8163
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
8162
|
-
* @version
|
|
8164
|
+
* @version 98.0.0
|
|
8163
8165
|
*/
|
|
8164
8166
|
|
|
8165
8167
|
/**
|
|
@@ -11788,7 +11790,7 @@ class ConversationsApi {
|
|
|
11788
11790
|
|
|
11789
11791
|
/**
|
|
11790
11792
|
* Send message
|
|
11791
|
-
*
|
|
11793
|
+
* 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.
|
|
11792
11794
|
* @param {String} conversationId conversationId
|
|
11793
11795
|
* @param {String} communicationId communicationId
|
|
11794
11796
|
* @param {Object} body Message
|
|
@@ -11969,8 +11971,12 @@ class ConversationsApi {
|
|
|
11969
11971
|
* Create a Facebook Integration
|
|
11970
11972
|
*
|
|
11971
11973
|
* @param {Object} body FacebookIntegrationRequest
|
|
11974
|
+
* @param {Object} opts Optional parameters
|
|
11975
|
+
* @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)
|
|
11972
11976
|
*/
|
|
11973
|
-
postConversationsMessagingIntegrationsFacebook(body) {
|
|
11977
|
+
postConversationsMessagingIntegrationsFacebook(body, opts) {
|
|
11978
|
+
opts = opts || {};
|
|
11979
|
+
|
|
11974
11980
|
// verify the required parameter 'body' is set
|
|
11975
11981
|
if (body === undefined || body === null) {
|
|
11976
11982
|
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsFacebook';
|
|
@@ -11980,7 +11986,7 @@ class ConversationsApi {
|
|
|
11980
11986
|
'/api/v2/conversations/messaging/integrations/facebook',
|
|
11981
11987
|
'POST',
|
|
11982
11988
|
{ },
|
|
11983
|
-
{
|
|
11989
|
+
{ 'async': opts['async'] },
|
|
11984
11990
|
{ },
|
|
11985
11991
|
{ },
|
|
11986
11992
|
body,
|
|
@@ -11994,8 +12000,12 @@ class ConversationsApi {
|
|
|
11994
12000
|
* Create a LINE messenger Integration
|
|
11995
12001
|
*
|
|
11996
12002
|
* @param {Object} body LineIntegrationRequest
|
|
12003
|
+
* @param {Object} opts Optional parameters
|
|
12004
|
+
* @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)
|
|
11997
12005
|
*/
|
|
11998
|
-
postConversationsMessagingIntegrationsLine(body) {
|
|
12006
|
+
postConversationsMessagingIntegrationsLine(body, opts) {
|
|
12007
|
+
opts = opts || {};
|
|
12008
|
+
|
|
11999
12009
|
// verify the required parameter 'body' is set
|
|
12000
12010
|
if (body === undefined || body === null) {
|
|
12001
12011
|
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsLine';
|
|
@@ -12005,7 +12015,7 @@ class ConversationsApi {
|
|
|
12005
12015
|
'/api/v2/conversations/messaging/integrations/line',
|
|
12006
12016
|
'POST',
|
|
12007
12017
|
{ },
|
|
12008
|
-
{
|
|
12018
|
+
{ 'async': opts['async'] },
|
|
12009
12019
|
{ },
|
|
12010
12020
|
{ },
|
|
12011
12021
|
body,
|
|
@@ -12019,8 +12029,12 @@ class ConversationsApi {
|
|
|
12019
12029
|
* Create a Twitter Integration
|
|
12020
12030
|
*
|
|
12021
12031
|
* @param {Object} body TwitterIntegrationRequest
|
|
12032
|
+
* @param {Object} opts Optional parameters
|
|
12033
|
+
* @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)
|
|
12022
12034
|
*/
|
|
12023
|
-
postConversationsMessagingIntegrationsTwitter(body) {
|
|
12035
|
+
postConversationsMessagingIntegrationsTwitter(body, opts) {
|
|
12036
|
+
opts = opts || {};
|
|
12037
|
+
|
|
12024
12038
|
// verify the required parameter 'body' is set
|
|
12025
12039
|
if (body === undefined || body === null) {
|
|
12026
12040
|
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsTwitter';
|
|
@@ -12030,7 +12044,7 @@ class ConversationsApi {
|
|
|
12030
12044
|
'/api/v2/conversations/messaging/integrations/twitter',
|
|
12031
12045
|
'POST',
|
|
12032
12046
|
{ },
|
|
12033
|
-
{
|
|
12047
|
+
{ 'async': opts['async'] },
|
|
12034
12048
|
{ },
|
|
12035
12049
|
{ },
|
|
12036
12050
|
body,
|
|
@@ -12044,8 +12058,12 @@ class ConversationsApi {
|
|
|
12044
12058
|
* Create a WhatsApp Integration
|
|
12045
12059
|
* 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.
|
|
12046
12060
|
* @param {Object} body WhatsAppIntegrationRequest
|
|
12061
|
+
* @param {Object} opts Optional parameters
|
|
12062
|
+
* @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)
|
|
12047
12063
|
*/
|
|
12048
|
-
postConversationsMessagingIntegrationsWhatsapp(body) {
|
|
12064
|
+
postConversationsMessagingIntegrationsWhatsapp(body, opts) {
|
|
12065
|
+
opts = opts || {};
|
|
12066
|
+
|
|
12049
12067
|
// verify the required parameter 'body' is set
|
|
12050
12068
|
if (body === undefined || body === null) {
|
|
12051
12069
|
throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsWhatsapp';
|
|
@@ -12055,7 +12073,7 @@ class ConversationsApi {
|
|
|
12055
12073
|
'/api/v2/conversations/messaging/integrations/whatsapp',
|
|
12056
12074
|
'POST',
|
|
12057
12075
|
{ },
|
|
12058
|
-
{
|
|
12076
|
+
{ 'async': opts['async'] },
|
|
12059
12077
|
{ },
|
|
12060
12078
|
{ },
|
|
12061
12079
|
body,
|
|
@@ -12201,7 +12219,7 @@ class DataExtensionsApi {
|
|
|
12201
12219
|
/**
|
|
12202
12220
|
* DataExtensions service.
|
|
12203
12221
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
12204
|
-
* @version
|
|
12222
|
+
* @version 98.0.0
|
|
12205
12223
|
*/
|
|
12206
12224
|
|
|
12207
12225
|
/**
|
|
@@ -12287,7 +12305,7 @@ class ExternalContactsApi {
|
|
|
12287
12305
|
/**
|
|
12288
12306
|
* ExternalContacts service.
|
|
12289
12307
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
12290
|
-
* @version
|
|
12308
|
+
* @version 98.0.0
|
|
12291
12309
|
*/
|
|
12292
12310
|
|
|
12293
12311
|
/**
|
|
@@ -13630,7 +13648,7 @@ class FaxApi {
|
|
|
13630
13648
|
/**
|
|
13631
13649
|
* Fax service.
|
|
13632
13650
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
13633
|
-
* @version
|
|
13651
|
+
* @version 98.0.0
|
|
13634
13652
|
*/
|
|
13635
13653
|
|
|
13636
13654
|
/**
|
|
@@ -13801,7 +13819,7 @@ class FlowsApi {
|
|
|
13801
13819
|
/**
|
|
13802
13820
|
* Flows service.
|
|
13803
13821
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
13804
|
-
* @version
|
|
13822
|
+
* @version 98.0.0
|
|
13805
13823
|
*/
|
|
13806
13824
|
|
|
13807
13825
|
/**
|
|
@@ -13872,7 +13890,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
13872
13890
|
/**
|
|
13873
13891
|
* GeneralDataProtectionRegulation service.
|
|
13874
13892
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
13875
|
-
* @version
|
|
13893
|
+
* @version 98.0.0
|
|
13876
13894
|
*/
|
|
13877
13895
|
|
|
13878
13896
|
/**
|
|
@@ -14002,7 +14020,7 @@ class GeolocationApi {
|
|
|
14002
14020
|
/**
|
|
14003
14021
|
* Geolocation service.
|
|
14004
14022
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
14005
|
-
* @version
|
|
14023
|
+
* @version 98.0.0
|
|
14006
14024
|
*/
|
|
14007
14025
|
|
|
14008
14026
|
/**
|
|
@@ -14133,7 +14151,7 @@ class GreetingsApi {
|
|
|
14133
14151
|
/**
|
|
14134
14152
|
* Greetings service.
|
|
14135
14153
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
14136
|
-
* @version
|
|
14154
|
+
* @version 98.0.0
|
|
14137
14155
|
*/
|
|
14138
14156
|
|
|
14139
14157
|
/**
|
|
@@ -14588,7 +14606,7 @@ class GroupsApi {
|
|
|
14588
14606
|
/**
|
|
14589
14607
|
* Groups service.
|
|
14590
14608
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
14591
|
-
* @version
|
|
14609
|
+
* @version 98.0.0
|
|
14592
14610
|
*/
|
|
14593
14611
|
|
|
14594
14612
|
/**
|
|
@@ -14993,7 +15011,7 @@ class IdentityProviderApi {
|
|
|
14993
15011
|
/**
|
|
14994
15012
|
* IdentityProvider service.
|
|
14995
15013
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
14996
|
-
* @version
|
|
15014
|
+
* @version 98.0.0
|
|
14997
15015
|
*/
|
|
14998
15016
|
|
|
14999
15017
|
/**
|
|
@@ -15749,7 +15767,7 @@ class IntegrationsApi {
|
|
|
15749
15767
|
/**
|
|
15750
15768
|
* Integrations service.
|
|
15751
15769
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
15752
|
-
* @version
|
|
15770
|
+
* @version 98.0.0
|
|
15753
15771
|
*/
|
|
15754
15772
|
|
|
15755
15773
|
/**
|
|
@@ -17241,7 +17259,7 @@ class JourneyApi {
|
|
|
17241
17259
|
/**
|
|
17242
17260
|
* Journey service.
|
|
17243
17261
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
17244
|
-
* @version
|
|
17262
|
+
* @version 98.0.0
|
|
17245
17263
|
*/
|
|
17246
17264
|
|
|
17247
17265
|
/**
|
|
@@ -17366,7 +17384,7 @@ class KnowledgeApi {
|
|
|
17366
17384
|
/**
|
|
17367
17385
|
* Knowledge service.
|
|
17368
17386
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
17369
|
-
* @version
|
|
17387
|
+
* @version 98.0.0
|
|
17370
17388
|
*/
|
|
17371
17389
|
|
|
17372
17390
|
/**
|
|
@@ -17619,6 +17637,7 @@ class KnowledgeApi {
|
|
|
17619
17637
|
* @param {String} opts.limit Number of entities to return. Maximum of 200.
|
|
17620
17638
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
17621
17639
|
* @param {String} opts.categories Filter by categories ids, comma separated values expected.
|
|
17640
|
+
* @param {String} opts.title Filter by document title.
|
|
17622
17641
|
*/
|
|
17623
17642
|
getKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, opts) {
|
|
17624
17643
|
opts = opts || {};
|
|
@@ -17636,7 +17655,7 @@ class KnowledgeApi {
|
|
|
17636
17655
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents',
|
|
17637
17656
|
'GET',
|
|
17638
17657
|
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
17639
|
-
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'categories': opts['categories'] },
|
|
17658
|
+
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'categories': opts['categories'],'title': opts['title'] },
|
|
17640
17659
|
{ },
|
|
17641
17660
|
{ },
|
|
17642
17661
|
null,
|
|
@@ -17682,7 +17701,7 @@ class KnowledgeApi {
|
|
|
17682
17701
|
}
|
|
17683
17702
|
|
|
17684
17703
|
/**
|
|
17685
|
-
* Get
|
|
17704
|
+
* Get all trainings information for a knowledgebase
|
|
17686
17705
|
*
|
|
17687
17706
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
17688
17707
|
* @param {Object} languageCode Language code, format: iso2-LOCALE
|
|
@@ -17691,6 +17710,7 @@ class KnowledgeApi {
|
|
|
17691
17710
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
17692
17711
|
* @param {String} opts.limit Number of entities to return. Maximum of 200.
|
|
17693
17712
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
17713
|
+
* @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
|
|
17694
17714
|
*/
|
|
17695
17715
|
getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode, opts) {
|
|
17696
17716
|
opts = opts || {};
|
|
@@ -17708,7 +17728,7 @@ class KnowledgeApi {
|
|
|
17708
17728
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/trainings',
|
|
17709
17729
|
'GET',
|
|
17710
17730
|
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
17711
|
-
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'] },
|
|
17731
|
+
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'knowledgeDocumentsState': opts['knowledgeDocumentsState'] },
|
|
17712
17732
|
{ },
|
|
17713
17733
|
{ },
|
|
17714
17734
|
null,
|
|
@@ -18086,7 +18106,7 @@ class LanguageUnderstandingApi {
|
|
|
18086
18106
|
/**
|
|
18087
18107
|
* LanguageUnderstanding service.
|
|
18088
18108
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
18089
|
-
* @version
|
|
18109
|
+
* @version 98.0.0
|
|
18090
18110
|
*/
|
|
18091
18111
|
|
|
18092
18112
|
/**
|
|
@@ -18652,7 +18672,7 @@ class LanguagesApi {
|
|
|
18652
18672
|
/**
|
|
18653
18673
|
* Languages service.
|
|
18654
18674
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
18655
|
-
* @version
|
|
18675
|
+
* @version 98.0.0
|
|
18656
18676
|
*/
|
|
18657
18677
|
|
|
18658
18678
|
/**
|
|
@@ -18920,7 +18940,7 @@ class LicenseApi {
|
|
|
18920
18940
|
/**
|
|
18921
18941
|
* License service.
|
|
18922
18942
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
18923
|
-
* @version
|
|
18943
|
+
* @version 98.0.0
|
|
18924
18944
|
*/
|
|
18925
18945
|
|
|
18926
18946
|
/**
|
|
@@ -19158,7 +19178,7 @@ class LocationsApi {
|
|
|
19158
19178
|
/**
|
|
19159
19179
|
* Locations service.
|
|
19160
19180
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
19161
|
-
* @version
|
|
19181
|
+
* @version 98.0.0
|
|
19162
19182
|
*/
|
|
19163
19183
|
|
|
19164
19184
|
/**
|
|
@@ -19394,7 +19414,7 @@ class MobileDevicesApi {
|
|
|
19394
19414
|
/**
|
|
19395
19415
|
* MobileDevices service.
|
|
19396
19416
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
19397
|
-
* @version
|
|
19417
|
+
* @version 98.0.0
|
|
19398
19418
|
*/
|
|
19399
19419
|
|
|
19400
19420
|
/**
|
|
@@ -19545,7 +19565,7 @@ class NotificationsApi {
|
|
|
19545
19565
|
/**
|
|
19546
19566
|
* Notifications service.
|
|
19547
19567
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
19548
|
-
* @version
|
|
19568
|
+
* @version 98.0.0
|
|
19549
19569
|
*/
|
|
19550
19570
|
|
|
19551
19571
|
/**
|
|
@@ -19744,7 +19764,7 @@ class OAuthApi {
|
|
|
19744
19764
|
/**
|
|
19745
19765
|
* OAuth service.
|
|
19746
19766
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
19747
|
-
* @version
|
|
19767
|
+
* @version 98.0.0
|
|
19748
19768
|
*/
|
|
19749
19769
|
|
|
19750
19770
|
/**
|
|
@@ -20102,7 +20122,7 @@ class ObjectsApi {
|
|
|
20102
20122
|
/**
|
|
20103
20123
|
* Objects service.
|
|
20104
20124
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
20105
|
-
* @version
|
|
20125
|
+
* @version 98.0.0
|
|
20106
20126
|
*/
|
|
20107
20127
|
|
|
20108
20128
|
/**
|
|
@@ -20343,7 +20363,7 @@ class OrganizationApi {
|
|
|
20343
20363
|
/**
|
|
20344
20364
|
* Organization service.
|
|
20345
20365
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
20346
|
-
* @version
|
|
20366
|
+
* @version 98.0.0
|
|
20347
20367
|
*/
|
|
20348
20368
|
|
|
20349
20369
|
/**
|
|
@@ -20598,7 +20618,7 @@ class OrganizationAuthorizationApi {
|
|
|
20598
20618
|
/**
|
|
20599
20619
|
* OrganizationAuthorization service.
|
|
20600
20620
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
20601
|
-
* @version
|
|
20621
|
+
* @version 98.0.0
|
|
20602
20622
|
*/
|
|
20603
20623
|
|
|
20604
20624
|
/**
|
|
@@ -21308,7 +21328,7 @@ class OutboundApi {
|
|
|
21308
21328
|
/**
|
|
21309
21329
|
* Outbound service.
|
|
21310
21330
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
21311
|
-
* @version
|
|
21331
|
+
* @version 98.0.0
|
|
21312
21332
|
*/
|
|
21313
21333
|
|
|
21314
21334
|
/**
|
|
@@ -24282,7 +24302,7 @@ class PresenceApi {
|
|
|
24282
24302
|
/**
|
|
24283
24303
|
* Presence service.
|
|
24284
24304
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
24285
|
-
* @version
|
|
24305
|
+
* @version 98.0.0
|
|
24286
24306
|
*/
|
|
24287
24307
|
|
|
24288
24308
|
/**
|
|
@@ -24629,7 +24649,7 @@ class QualityApi {
|
|
|
24629
24649
|
/**
|
|
24630
24650
|
* Quality service.
|
|
24631
24651
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
24632
|
-
* @version
|
|
24652
|
+
* @version 98.0.0
|
|
24633
24653
|
*/
|
|
24634
24654
|
|
|
24635
24655
|
/**
|
|
@@ -24843,8 +24863,8 @@ class QualityApi {
|
|
|
24843
24863
|
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
24844
24864
|
* @param {String} opts.nextPage next page token
|
|
24845
24865
|
* @param {String} opts.previousPage Previous page token
|
|
24846
|
-
* @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.
|
|
24847
|
-
* @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.
|
|
24866
|
+
* @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
|
|
24867
|
+
* @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
|
|
24848
24868
|
* @param {Array.<String>} opts.agentUserId user id of agent requested
|
|
24849
24869
|
* @param {String} opts.evaluatorUserId user id of the evaluator
|
|
24850
24870
|
* @param {String} opts.name name
|
|
@@ -24910,8 +24930,8 @@ class QualityApi {
|
|
|
24910
24930
|
* @param {String} opts.nextPage next page token
|
|
24911
24931
|
* @param {String} opts.previousPage Previous page token
|
|
24912
24932
|
* @param {String} opts.conversationId conversation id
|
|
24913
|
-
* @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.
|
|
24914
|
-
* @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.
|
|
24933
|
+
* @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
|
|
24934
|
+
* @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
|
|
24915
24935
|
*/
|
|
24916
24936
|
getQualityCalibrations(calibratorId, opts) {
|
|
24917
24937
|
opts = opts || {};
|
|
@@ -25081,8 +25101,8 @@ class QualityApi {
|
|
|
25081
25101
|
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
25082
25102
|
* @param {String} opts.nextPage next page token
|
|
25083
25103
|
* @param {String} opts.previousPage Previous page token
|
|
25084
|
-
* @param {Date} opts.startTime The start time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
25085
|
-
* @param {Date} opts.endTime The end time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
25104
|
+
* @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
|
|
25105
|
+
* @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
|
|
25086
25106
|
* @param {String} opts.name Evaluator name
|
|
25087
25107
|
* @param {Array.<String>} opts.permission permission strings
|
|
25088
25108
|
* @param {String} opts.group group id
|
|
@@ -25223,6 +25243,7 @@ class QualityApi {
|
|
|
25223
25243
|
* @param {Object} opts Optional parameters
|
|
25224
25244
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
25225
25245
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
25246
|
+
* @param {String} opts.sortOrder Sort order (default to asc)
|
|
25226
25247
|
*/
|
|
25227
25248
|
getQualityFormsEvaluationVersions(formId, opts) {
|
|
25228
25249
|
opts = opts || {};
|
|
@@ -25236,7 +25257,7 @@ class QualityApi {
|
|
|
25236
25257
|
'/api/v2/quality/forms/evaluations/{formId}/versions',
|
|
25237
25258
|
'GET',
|
|
25238
25259
|
{ 'formId': formId },
|
|
25239
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
25260
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'] },
|
|
25240
25261
|
{ },
|
|
25241
25262
|
{ },
|
|
25242
25263
|
null,
|
|
@@ -26326,7 +26347,7 @@ class RecordingApi {
|
|
|
26326
26347
|
/**
|
|
26327
26348
|
* Recording service.
|
|
26328
26349
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
26329
|
-
* @version
|
|
26350
|
+
* @version 98.0.0
|
|
26330
26351
|
*/
|
|
26331
26352
|
|
|
26332
26353
|
/**
|
|
@@ -27572,7 +27593,7 @@ class ResponseManagementApi {
|
|
|
27572
27593
|
/**
|
|
27573
27594
|
* ResponseManagement service.
|
|
27574
27595
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
27575
|
-
* @version
|
|
27596
|
+
* @version 98.0.0
|
|
27576
27597
|
*/
|
|
27577
27598
|
|
|
27578
27599
|
/**
|
|
@@ -27897,7 +27918,7 @@ class RoutingApi {
|
|
|
27897
27918
|
/**
|
|
27898
27919
|
* Routing service.
|
|
27899
27920
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
27900
|
-
* @version
|
|
27921
|
+
* @version 98.0.0
|
|
27901
27922
|
*/
|
|
27902
27923
|
|
|
27903
27924
|
/**
|
|
@@ -30195,7 +30216,7 @@ class SCIMApi {
|
|
|
30195
30216
|
/**
|
|
30196
30217
|
* SCIM service.
|
|
30197
30218
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
30198
|
-
* @version
|
|
30219
|
+
* @version 98.0.0
|
|
30199
30220
|
*/
|
|
30200
30221
|
|
|
30201
30222
|
/**
|
|
@@ -30331,8 +30352,8 @@ class SCIMApi {
|
|
|
30331
30352
|
*
|
|
30332
30353
|
* @param {String} groupId The ID of a group. Returned with GET /api/v2/scim/groups.
|
|
30333
30354
|
* @param {Object} opts Optional parameters
|
|
30334
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
30335
|
-
* @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.
|
|
30355
|
+
* @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.
|
|
30356
|
+
* @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.
|
|
30336
30357
|
* @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.
|
|
30337
30358
|
*/
|
|
30338
30359
|
getScimGroup(groupId, opts) {
|
|
@@ -30362,9 +30383,9 @@ class SCIMApi {
|
|
|
30362
30383
|
*
|
|
30363
30384
|
* @param {Object} opts Optional parameters
|
|
30364
30385
|
* @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
|
|
30365
|
-
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
30366
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
30367
|
-
* @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.
|
|
30386
|
+
* @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)
|
|
30387
|
+
* @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.
|
|
30388
|
+
* @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.
|
|
30368
30389
|
* @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\".
|
|
30369
30390
|
*/
|
|
30370
30391
|
getScimGroups(opts) {
|
|
@@ -30508,9 +30529,9 @@ class SCIMApi {
|
|
|
30508
30529
|
*
|
|
30509
30530
|
* @param {String} userId The ID of a user. Returned with GET /api/v2/scim/users.
|
|
30510
30531
|
* @param {Object} opts Optional parameters
|
|
30511
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
30512
|
-
* @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.
|
|
30513
|
-
* @param {String} opts.ifNoneMatch
|
|
30532
|
+
* @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.
|
|
30533
|
+
* @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.
|
|
30534
|
+
* @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.
|
|
30514
30535
|
*/
|
|
30515
30536
|
getScimUser(userId, opts) {
|
|
30516
30537
|
opts = opts || {};
|
|
@@ -30539,9 +30560,9 @@ class SCIMApi {
|
|
|
30539
30560
|
* 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\".
|
|
30540
30561
|
* @param {Object} opts Optional parameters
|
|
30541
30562
|
* @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
|
|
30542
|
-
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
30543
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
30544
|
-
* @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.
|
|
30563
|
+
* @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)
|
|
30564
|
+
* @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.
|
|
30565
|
+
* @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.
|
|
30545
30566
|
* @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\".
|
|
30546
30567
|
*/
|
|
30547
30568
|
getScimUsers(opts) {
|
|
@@ -30567,9 +30588,9 @@ class SCIMApi {
|
|
|
30567
30588
|
*
|
|
30568
30589
|
* @param {String} groupId The ID of a group. Returned with GET /api/v2/scim/v2/groups.
|
|
30569
30590
|
* @param {Object} opts Optional parameters
|
|
30570
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
30571
|
-
* @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.
|
|
30572
|
-
* @param {String} opts.ifNoneMatch
|
|
30591
|
+
* @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.
|
|
30592
|
+
* @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.
|
|
30593
|
+
* @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.
|
|
30573
30594
|
*/
|
|
30574
30595
|
getScimV2Group(groupId, opts) {
|
|
30575
30596
|
opts = opts || {};
|
|
@@ -30599,9 +30620,9 @@ class SCIMApi {
|
|
|
30599
30620
|
* @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\".
|
|
30600
30621
|
* @param {Object} opts Optional parameters
|
|
30601
30622
|
* @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
|
|
30602
|
-
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
30603
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
30604
|
-
* @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.
|
|
30623
|
+
* @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)
|
|
30624
|
+
* @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.
|
|
30625
|
+
* @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.
|
|
30605
30626
|
*/
|
|
30606
30627
|
getScimV2Groups(filter, opts) {
|
|
30607
30628
|
opts = opts || {};
|
|
@@ -30748,8 +30769,8 @@ class SCIMApi {
|
|
|
30748
30769
|
*
|
|
30749
30770
|
* @param {String} userId The ID of a user. Returned with GET /api/v2/scim/v2/users.
|
|
30750
30771
|
* @param {Object} opts Optional parameters
|
|
30751
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
30752
|
-
* @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.
|
|
30772
|
+
* @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.
|
|
30773
|
+
* @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.
|
|
30753
30774
|
* @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.
|
|
30754
30775
|
*/
|
|
30755
30776
|
getScimV2User(userId, opts) {
|
|
@@ -30779,9 +30800,9 @@ class SCIMApi {
|
|
|
30779
30800
|
* 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\".
|
|
30780
30801
|
* @param {Object} opts Optional parameters
|
|
30781
30802
|
* @param {Number} opts.startIndex The 1-based index of the first query result. (default to 1)
|
|
30782
|
-
* @param {Number} opts.count The requested number of items per page. A value of 0 returns \"totalResults\".
|
|
30783
|
-
* @param {Array.<String>} opts.attributes Indicates which attributes to include. Returns these attributes and the
|
|
30784
|
-
* @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.
|
|
30803
|
+
* @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)
|
|
30804
|
+
* @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.
|
|
30805
|
+
* @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.
|
|
30785
30806
|
* @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\".
|
|
30786
30807
|
*/
|
|
30787
30808
|
getScimV2Users(opts) {
|
|
@@ -30939,8 +30960,8 @@ class SCIMApi {
|
|
|
30939
30960
|
}
|
|
30940
30961
|
|
|
30941
30962
|
/**
|
|
30942
|
-
*
|
|
30943
|
-
* 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}
|
|
30963
|
+
* Create a group
|
|
30964
|
+
* 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.
|
|
30944
30965
|
* @param {Object} body The information used to create a group.
|
|
30945
30966
|
*/
|
|
30946
30967
|
postScimGroups(body) {
|
|
@@ -30991,7 +31012,7 @@ class SCIMApi {
|
|
|
30991
31012
|
/**
|
|
30992
31013
|
* Create a group
|
|
30993
31014
|
* 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.
|
|
30994
|
-
* @param {Object} body
|
|
31015
|
+
* @param {Object} body The information used to create a group.
|
|
30995
31016
|
*/
|
|
30996
31017
|
postScimV2Groups(body) {
|
|
30997
31018
|
// verify the required parameter 'body' is set
|
|
@@ -31180,7 +31201,7 @@ class ScriptsApi {
|
|
|
31180
31201
|
/**
|
|
31181
31202
|
* Scripts service.
|
|
31182
31203
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
31183
|
-
* @version
|
|
31204
|
+
* @version 98.0.0
|
|
31184
31205
|
*/
|
|
31185
31206
|
|
|
31186
31207
|
/**
|
|
@@ -31533,7 +31554,7 @@ class SearchApi {
|
|
|
31533
31554
|
/**
|
|
31534
31555
|
* Search service.
|
|
31535
31556
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
31536
|
-
* @version
|
|
31557
|
+
* @version 98.0.0
|
|
31537
31558
|
*/
|
|
31538
31559
|
|
|
31539
31560
|
/**
|
|
@@ -32043,7 +32064,7 @@ class SpeechTextAnalyticsApi {
|
|
|
32043
32064
|
/**
|
|
32044
32065
|
* SpeechTextAnalytics service.
|
|
32045
32066
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
32046
|
-
* @version
|
|
32067
|
+
* @version 98.0.0
|
|
32047
32068
|
*/
|
|
32048
32069
|
|
|
32049
32070
|
/**
|
|
@@ -32119,7 +32140,7 @@ class StationsApi {
|
|
|
32119
32140
|
/**
|
|
32120
32141
|
* Stations service.
|
|
32121
32142
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
32122
|
-
* @version
|
|
32143
|
+
* @version 98.0.0
|
|
32123
32144
|
*/
|
|
32124
32145
|
|
|
32125
32146
|
/**
|
|
@@ -32266,7 +32287,7 @@ class SuggestApi {
|
|
|
32266
32287
|
/**
|
|
32267
32288
|
* Suggest service.
|
|
32268
32289
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
32269
|
-
* @version
|
|
32290
|
+
* @version 98.0.0
|
|
32270
32291
|
*/
|
|
32271
32292
|
|
|
32272
32293
|
/**
|
|
@@ -32405,7 +32426,7 @@ class TelephonyApi {
|
|
|
32405
32426
|
/**
|
|
32406
32427
|
* Telephony service.
|
|
32407
32428
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
32408
|
-
* @version
|
|
32429
|
+
* @version 98.0.0
|
|
32409
32430
|
*/
|
|
32410
32431
|
|
|
32411
32432
|
/**
|
|
@@ -32423,8 +32444,8 @@ class TelephonyApi {
|
|
|
32423
32444
|
/**
|
|
32424
32445
|
* Fetch SIP metadata
|
|
32425
32446
|
* 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
|
|
32426
|
-
* @param {Date} dateStart Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
32427
|
-
* @param {Date} dateEnd End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.
|
|
32447
|
+
* @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
|
|
32448
|
+
* @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
|
|
32428
32449
|
* @param {Object} opts Optional parameters
|
|
32429
32450
|
* @param {String} opts.callId unique identification of the placed call
|
|
32430
32451
|
* @param {String} opts.toUser User to who the call was placed
|
|
@@ -32513,7 +32534,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
32513
32534
|
/**
|
|
32514
32535
|
* TelephonyProvidersEdge service.
|
|
32515
32536
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
32516
|
-
* @version
|
|
32537
|
+
* @version 98.0.0
|
|
32517
32538
|
*/
|
|
32518
32539
|
|
|
32519
32540
|
/**
|
|
@@ -36090,7 +36111,7 @@ class TextbotsApi {
|
|
|
36090
36111
|
/**
|
|
36091
36112
|
* Textbots service.
|
|
36092
36113
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
36093
|
-
* @version
|
|
36114
|
+
* @version 98.0.0
|
|
36094
36115
|
*/
|
|
36095
36116
|
|
|
36096
36117
|
/**
|
|
@@ -36136,7 +36157,7 @@ class TokensApi {
|
|
|
36136
36157
|
/**
|
|
36137
36158
|
* Tokens service.
|
|
36138
36159
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
36139
|
-
* @version
|
|
36160
|
+
* @version 98.0.0
|
|
36140
36161
|
*/
|
|
36141
36162
|
|
|
36142
36163
|
/**
|
|
@@ -36222,7 +36243,7 @@ class UploadsApi {
|
|
|
36222
36243
|
/**
|
|
36223
36244
|
* Uploads service.
|
|
36224
36245
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
36225
|
-
* @version
|
|
36246
|
+
* @version 98.0.0
|
|
36226
36247
|
*/
|
|
36227
36248
|
|
|
36228
36249
|
/**
|
|
@@ -36268,7 +36289,7 @@ class UsageApi {
|
|
|
36268
36289
|
/**
|
|
36269
36290
|
* Usage service.
|
|
36270
36291
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
36271
|
-
* @version
|
|
36292
|
+
* @version 98.0.0
|
|
36272
36293
|
*/
|
|
36273
36294
|
|
|
36274
36295
|
/**
|
|
@@ -36335,154 +36356,11 @@ class UsageApi {
|
|
|
36335
36356
|
|
|
36336
36357
|
}
|
|
36337
36358
|
|
|
36338
|
-
class UserDevelopmentApi {
|
|
36339
|
-
/**
|
|
36340
|
-
* UserDevelopment service.
|
|
36341
|
-
* @module purecloud-platform-client-v2/api/UserDevelopmentApi
|
|
36342
|
-
* @version 95.0.0
|
|
36343
|
-
*/
|
|
36344
|
-
|
|
36345
|
-
/**
|
|
36346
|
-
* Constructs a new UserDevelopmentApi.
|
|
36347
|
-
* @alias module:purecloud-platform-client-v2/api/UserDevelopmentApi
|
|
36348
|
-
* @class
|
|
36349
|
-
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
36350
|
-
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
36351
|
-
*/
|
|
36352
|
-
constructor(apiClient) {
|
|
36353
|
-
this.apiClient = apiClient || ApiClient.instance;
|
|
36354
|
-
}
|
|
36355
|
-
|
|
36356
|
-
|
|
36357
|
-
/**
|
|
36358
|
-
* Get list of Development Activities
|
|
36359
|
-
* Either moduleId or userId is required. Results are filtered based on the applicable permissions.
|
|
36360
|
-
* @param {Object} opts Optional parameters
|
|
36361
|
-
* @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.
|
|
36362
|
-
* @param {String} opts.moduleId Specifies the ID of the learning module.
|
|
36363
|
-
* @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
|
|
36364
|
-
* @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
|
|
36365
|
-
* @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
|
|
36366
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
36367
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
36368
|
-
* @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)
|
|
36369
|
-
* @param {Array.<String>} opts.types Specifies the activity types.
|
|
36370
|
-
* @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
|
|
36371
|
-
* @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.
|
|
36372
|
-
*/
|
|
36373
|
-
getUsersDevelopmentActivities(opts) {
|
|
36374
|
-
opts = opts || {};
|
|
36375
|
-
|
|
36376
|
-
|
|
36377
|
-
return this.apiClient.callApi(
|
|
36378
|
-
'/api/v2/users/development/activities',
|
|
36379
|
-
'GET',
|
|
36380
|
-
{ },
|
|
36381
|
-
{ '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') },
|
|
36382
|
-
{ },
|
|
36383
|
-
{ },
|
|
36384
|
-
null,
|
|
36385
|
-
['PureCloud OAuth'],
|
|
36386
|
-
['application/json'],
|
|
36387
|
-
['application/json']
|
|
36388
|
-
);
|
|
36389
|
-
}
|
|
36390
|
-
|
|
36391
|
-
/**
|
|
36392
|
-
* Get list of Development Activities for current user
|
|
36393
|
-
* Results are filtered based on the applicable permissions.
|
|
36394
|
-
* @param {Object} opts Optional parameters
|
|
36395
|
-
* @param {String} opts.moduleId Specifies the ID of the learning module.
|
|
36396
|
-
* @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
|
|
36397
|
-
* @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
|
|
36398
|
-
* @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
|
|
36399
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
36400
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
36401
|
-
* @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)
|
|
36402
|
-
* @param {Array.<String>} opts.types Specifies the activity types.
|
|
36403
|
-
* @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
|
|
36404
|
-
* @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.
|
|
36405
|
-
*/
|
|
36406
|
-
getUsersDevelopmentActivitiesMe(opts) {
|
|
36407
|
-
opts = opts || {};
|
|
36408
|
-
|
|
36409
|
-
|
|
36410
|
-
return this.apiClient.callApi(
|
|
36411
|
-
'/api/v2/users/development/activities/me',
|
|
36412
|
-
'GET',
|
|
36413
|
-
{ },
|
|
36414
|
-
{ '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') },
|
|
36415
|
-
{ },
|
|
36416
|
-
{ },
|
|
36417
|
-
null,
|
|
36418
|
-
['PureCloud OAuth'],
|
|
36419
|
-
['application/json'],
|
|
36420
|
-
['application/json']
|
|
36421
|
-
);
|
|
36422
|
-
}
|
|
36423
|
-
|
|
36424
|
-
/**
|
|
36425
|
-
* Get a Development Activity
|
|
36426
|
-
*
|
|
36427
|
-
* @param {String} activityId Specifies the activity ID, maps to either assignment or appointment ID
|
|
36428
|
-
* @param {Object} type Specifies the activity type.
|
|
36429
|
-
*/
|
|
36430
|
-
getUsersDevelopmentActivity(activityId, type) {
|
|
36431
|
-
// verify the required parameter 'activityId' is set
|
|
36432
|
-
if (activityId === undefined || activityId === null) {
|
|
36433
|
-
throw 'Missing the required parameter "activityId" when calling getUsersDevelopmentActivity';
|
|
36434
|
-
}
|
|
36435
|
-
// verify the required parameter 'type' is set
|
|
36436
|
-
if (type === undefined || type === null) {
|
|
36437
|
-
throw 'Missing the required parameter "type" when calling getUsersDevelopmentActivity';
|
|
36438
|
-
}
|
|
36439
|
-
|
|
36440
|
-
return this.apiClient.callApi(
|
|
36441
|
-
'/api/v2/users/development/activities/{activityId}',
|
|
36442
|
-
'GET',
|
|
36443
|
-
{ 'activityId': activityId },
|
|
36444
|
-
{ 'type': type },
|
|
36445
|
-
{ },
|
|
36446
|
-
{ },
|
|
36447
|
-
null,
|
|
36448
|
-
['PureCloud OAuth'],
|
|
36449
|
-
['application/json'],
|
|
36450
|
-
['application/json']
|
|
36451
|
-
);
|
|
36452
|
-
}
|
|
36453
|
-
|
|
36454
|
-
/**
|
|
36455
|
-
* Retrieve aggregated development activity data
|
|
36456
|
-
* Results are filtered based on the applicable permissions.
|
|
36457
|
-
* @param {Object} body Aggregate Request
|
|
36458
|
-
*/
|
|
36459
|
-
postUsersDevelopmentActivitiesAggregatesQuery(body) {
|
|
36460
|
-
// verify the required parameter 'body' is set
|
|
36461
|
-
if (body === undefined || body === null) {
|
|
36462
|
-
throw 'Missing the required parameter "body" when calling postUsersDevelopmentActivitiesAggregatesQuery';
|
|
36463
|
-
}
|
|
36464
|
-
|
|
36465
|
-
return this.apiClient.callApi(
|
|
36466
|
-
'/api/v2/users/development/activities/aggregates/query',
|
|
36467
|
-
'POST',
|
|
36468
|
-
{ },
|
|
36469
|
-
{ },
|
|
36470
|
-
{ },
|
|
36471
|
-
{ },
|
|
36472
|
-
body,
|
|
36473
|
-
['PureCloud OAuth'],
|
|
36474
|
-
['application/json'],
|
|
36475
|
-
['application/json']
|
|
36476
|
-
);
|
|
36477
|
-
}
|
|
36478
|
-
|
|
36479
|
-
}
|
|
36480
|
-
|
|
36481
36359
|
class UserRecordingsApi {
|
|
36482
36360
|
/**
|
|
36483
36361
|
* UserRecordings service.
|
|
36484
36362
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
36485
|
-
* @version
|
|
36363
|
+
* @version 98.0.0
|
|
36486
36364
|
*/
|
|
36487
36365
|
|
|
36488
36366
|
/**
|
|
@@ -36666,7 +36544,7 @@ class UsersApi {
|
|
|
36666
36544
|
/**
|
|
36667
36545
|
* Users service.
|
|
36668
36546
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
36669
|
-
* @version
|
|
36547
|
+
* @version 98.0.0
|
|
36670
36548
|
*/
|
|
36671
36549
|
|
|
36672
36550
|
/**
|
|
@@ -37710,6 +37588,103 @@ class UsersApi {
|
|
|
37710
37588
|
);
|
|
37711
37589
|
}
|
|
37712
37590
|
|
|
37591
|
+
/**
|
|
37592
|
+
* Get list of Development Activities
|
|
37593
|
+
* Either moduleId or userId is required. Results are filtered based on the applicable permissions.
|
|
37594
|
+
* @param {Object} opts Optional parameters
|
|
37595
|
+
* @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.
|
|
37596
|
+
* @param {String} opts.moduleId Specifies the ID of the learning module.
|
|
37597
|
+
* @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
|
|
37598
|
+
* @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
|
|
37599
|
+
* @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
|
|
37600
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
37601
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
37602
|
+
* @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)
|
|
37603
|
+
* @param {Array.<String>} opts.types Specifies the activity types.
|
|
37604
|
+
* @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
|
|
37605
|
+
* @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.
|
|
37606
|
+
*/
|
|
37607
|
+
getUsersDevelopmentActivities(opts) {
|
|
37608
|
+
opts = opts || {};
|
|
37609
|
+
|
|
37610
|
+
|
|
37611
|
+
return this.apiClient.callApi(
|
|
37612
|
+
'/api/v2/users/development/activities',
|
|
37613
|
+
'GET',
|
|
37614
|
+
{ },
|
|
37615
|
+
{ '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') },
|
|
37616
|
+
{ },
|
|
37617
|
+
{ },
|
|
37618
|
+
null,
|
|
37619
|
+
['PureCloud OAuth'],
|
|
37620
|
+
['application/json'],
|
|
37621
|
+
['application/json']
|
|
37622
|
+
);
|
|
37623
|
+
}
|
|
37624
|
+
|
|
37625
|
+
/**
|
|
37626
|
+
* Get list of Development Activities for current user
|
|
37627
|
+
* Results are filtered based on the applicable permissions.
|
|
37628
|
+
* @param {Object} opts Optional parameters
|
|
37629
|
+
* @param {String} opts.moduleId Specifies the ID of the learning module.
|
|
37630
|
+
* @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
|
|
37631
|
+
* @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
|
|
37632
|
+
* @param {Object} opts.overdue Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (default to Any)
|
|
37633
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
37634
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
37635
|
+
* @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)
|
|
37636
|
+
* @param {Array.<String>} opts.types Specifies the activity types.
|
|
37637
|
+
* @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
|
|
37638
|
+
* @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.
|
|
37639
|
+
*/
|
|
37640
|
+
getUsersDevelopmentActivitiesMe(opts) {
|
|
37641
|
+
opts = opts || {};
|
|
37642
|
+
|
|
37643
|
+
|
|
37644
|
+
return this.apiClient.callApi(
|
|
37645
|
+
'/api/v2/users/development/activities/me',
|
|
37646
|
+
'GET',
|
|
37647
|
+
{ },
|
|
37648
|
+
{ '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') },
|
|
37649
|
+
{ },
|
|
37650
|
+
{ },
|
|
37651
|
+
null,
|
|
37652
|
+
['PureCloud OAuth'],
|
|
37653
|
+
['application/json'],
|
|
37654
|
+
['application/json']
|
|
37655
|
+
);
|
|
37656
|
+
}
|
|
37657
|
+
|
|
37658
|
+
/**
|
|
37659
|
+
* Get a Development Activity
|
|
37660
|
+
*
|
|
37661
|
+
* @param {String} activityId Specifies the activity ID, maps to either assignment or appointment ID
|
|
37662
|
+
* @param {Object} type Specifies the activity type.
|
|
37663
|
+
*/
|
|
37664
|
+
getUsersDevelopmentActivity(activityId, type) {
|
|
37665
|
+
// verify the required parameter 'activityId' is set
|
|
37666
|
+
if (activityId === undefined || activityId === null) {
|
|
37667
|
+
throw 'Missing the required parameter "activityId" when calling getUsersDevelopmentActivity';
|
|
37668
|
+
}
|
|
37669
|
+
// verify the required parameter 'type' is set
|
|
37670
|
+
if (type === undefined || type === null) {
|
|
37671
|
+
throw 'Missing the required parameter "type" when calling getUsersDevelopmentActivity';
|
|
37672
|
+
}
|
|
37673
|
+
|
|
37674
|
+
return this.apiClient.callApi(
|
|
37675
|
+
'/api/v2/users/development/activities/{activityId}',
|
|
37676
|
+
'GET',
|
|
37677
|
+
{ 'activityId': activityId },
|
|
37678
|
+
{ 'type': type },
|
|
37679
|
+
{ },
|
|
37680
|
+
{ },
|
|
37681
|
+
null,
|
|
37682
|
+
['PureCloud OAuth'],
|
|
37683
|
+
['application/json'],
|
|
37684
|
+
['application/json']
|
|
37685
|
+
);
|
|
37686
|
+
}
|
|
37687
|
+
|
|
37713
37688
|
/**
|
|
37714
37689
|
* Get current user details.
|
|
37715
37690
|
* This request is not valid when using the Client Credentials OAuth grant.
|
|
@@ -38396,6 +38371,31 @@ class UsersApi {
|
|
|
38396
38371
|
);
|
|
38397
38372
|
}
|
|
38398
38373
|
|
|
38374
|
+
/**
|
|
38375
|
+
* Retrieve aggregated development activity data
|
|
38376
|
+
* Results are filtered based on the applicable permissions.
|
|
38377
|
+
* @param {Object} body Aggregate Request
|
|
38378
|
+
*/
|
|
38379
|
+
postUsersDevelopmentActivitiesAggregatesQuery(body) {
|
|
38380
|
+
// verify the required parameter 'body' is set
|
|
38381
|
+
if (body === undefined || body === null) {
|
|
38382
|
+
throw 'Missing the required parameter "body" when calling postUsersDevelopmentActivitiesAggregatesQuery';
|
|
38383
|
+
}
|
|
38384
|
+
|
|
38385
|
+
return this.apiClient.callApi(
|
|
38386
|
+
'/api/v2/users/development/activities/aggregates/query',
|
|
38387
|
+
'POST',
|
|
38388
|
+
{ },
|
|
38389
|
+
{ },
|
|
38390
|
+
{ },
|
|
38391
|
+
{ },
|
|
38392
|
+
body,
|
|
38393
|
+
['PureCloud OAuth'],
|
|
38394
|
+
['application/json'],
|
|
38395
|
+
['application/json']
|
|
38396
|
+
);
|
|
38397
|
+
}
|
|
38398
|
+
|
|
38399
38399
|
/**
|
|
38400
38400
|
* Change your password
|
|
38401
38401
|
*
|
|
@@ -38757,7 +38757,7 @@ class UtilitiesApi {
|
|
|
38757
38757
|
/**
|
|
38758
38758
|
* Utilities service.
|
|
38759
38759
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
38760
|
-
* @version
|
|
38760
|
+
* @version 98.0.0
|
|
38761
38761
|
*/
|
|
38762
38762
|
|
|
38763
38763
|
/**
|
|
@@ -38868,7 +38868,7 @@ class VoicemailApi {
|
|
|
38868
38868
|
/**
|
|
38869
38869
|
* Voicemail service.
|
|
38870
38870
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
38871
|
-
* @version
|
|
38871
|
+
* @version 98.0.0
|
|
38872
38872
|
*/
|
|
38873
38873
|
|
|
38874
38874
|
/**
|
|
@@ -39505,7 +39505,7 @@ class WebChatApi {
|
|
|
39505
39505
|
/**
|
|
39506
39506
|
* WebChat service.
|
|
39507
39507
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
39508
|
-
* @version
|
|
39508
|
+
* @version 98.0.0
|
|
39509
39509
|
*/
|
|
39510
39510
|
|
|
39511
39511
|
/**
|
|
@@ -40049,7 +40049,7 @@ class WidgetsApi {
|
|
|
40049
40049
|
/**
|
|
40050
40050
|
* Widgets service.
|
|
40051
40051
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
40052
|
-
* @version
|
|
40052
|
+
* @version 98.0.0
|
|
40053
40053
|
*/
|
|
40054
40054
|
|
|
40055
40055
|
/**
|
|
@@ -40195,7 +40195,7 @@ class WorkforceManagementApi {
|
|
|
40195
40195
|
/**
|
|
40196
40196
|
* WorkforceManagement service.
|
|
40197
40197
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
40198
|
-
* @version
|
|
40198
|
+
* @version 98.0.0
|
|
40199
40199
|
*/
|
|
40200
40200
|
|
|
40201
40201
|
/**
|
|
@@ -40451,155 +40451,25 @@ class WorkforceManagementApi {
|
|
|
40451
40451
|
}
|
|
40452
40452
|
|
|
40453
40453
|
/**
|
|
40454
|
-
*
|
|
40455
|
-
*
|
|
40456
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
40457
|
-
* @param {String} acId The ID of the activity code to delete
|
|
40458
|
-
*/
|
|
40459
|
-
deleteWorkforcemanagementManagementunitActivitycode(muId, acId) {
|
|
40460
|
-
// verify the required parameter 'muId' is set
|
|
40461
|
-
if (muId === undefined || muId === null) {
|
|
40462
|
-
throw 'Missing the required parameter "muId" when calling deleteWorkforcemanagementManagementunitActivitycode';
|
|
40463
|
-
}
|
|
40464
|
-
// verify the required parameter 'acId' is set
|
|
40465
|
-
if (acId === undefined || acId === null) {
|
|
40466
|
-
throw 'Missing the required parameter "acId" when calling deleteWorkforcemanagementManagementunitActivitycode';
|
|
40467
|
-
}
|
|
40468
|
-
|
|
40469
|
-
return this.apiClient.callApi(
|
|
40470
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}',
|
|
40471
|
-
'DELETE',
|
|
40472
|
-
{ 'muId': muId,'acId': acId },
|
|
40473
|
-
{ },
|
|
40474
|
-
{ },
|
|
40475
|
-
{ },
|
|
40476
|
-
null,
|
|
40477
|
-
['PureCloud OAuth'],
|
|
40478
|
-
['application/json'],
|
|
40479
|
-
['application/json']
|
|
40480
|
-
);
|
|
40481
|
-
}
|
|
40482
|
-
|
|
40483
|
-
/**
|
|
40484
|
-
* Gone. Scheduling has moved under business units
|
|
40485
|
-
*
|
|
40486
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
|
|
40487
|
-
* @param {String} runId The ID of the schedule run
|
|
40488
|
-
*/
|
|
40489
|
-
deleteWorkforcemanagementManagementunitSchedulingRun(managementUnitId, runId) {
|
|
40490
|
-
// verify the required parameter 'managementUnitId' is set
|
|
40491
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
40492
|
-
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitSchedulingRun';
|
|
40493
|
-
}
|
|
40494
|
-
// verify the required parameter 'runId' is set
|
|
40495
|
-
if (runId === undefined || runId === null) {
|
|
40496
|
-
throw 'Missing the required parameter "runId" when calling deleteWorkforcemanagementManagementunitSchedulingRun';
|
|
40497
|
-
}
|
|
40498
|
-
|
|
40499
|
-
return this.apiClient.callApi(
|
|
40500
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}',
|
|
40501
|
-
'DELETE',
|
|
40502
|
-
{ 'managementUnitId': managementUnitId,'runId': runId },
|
|
40503
|
-
{ },
|
|
40504
|
-
{ },
|
|
40505
|
-
{ },
|
|
40506
|
-
null,
|
|
40507
|
-
['PureCloud OAuth'],
|
|
40508
|
-
['application/json'],
|
|
40509
|
-
['application/json']
|
|
40510
|
-
);
|
|
40511
|
-
}
|
|
40512
|
-
|
|
40513
|
-
/**
|
|
40514
|
-
* Gone. Replaced with service goal templates and planning groups under business units
|
|
40515
|
-
*
|
|
40516
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
40517
|
-
* @param {String} serviceGoalGroupId Gone. The ID of the service goal group to delete
|
|
40518
|
-
*/
|
|
40519
|
-
deleteWorkforcemanagementManagementunitServicegoalgroup(managementUnitId, serviceGoalGroupId) {
|
|
40520
|
-
// verify the required parameter 'managementUnitId' is set
|
|
40521
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
40522
|
-
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitServicegoalgroup';
|
|
40523
|
-
}
|
|
40524
|
-
// verify the required parameter 'serviceGoalGroupId' is set
|
|
40525
|
-
if (serviceGoalGroupId === undefined || serviceGoalGroupId === null) {
|
|
40526
|
-
throw 'Missing the required parameter "serviceGoalGroupId" when calling deleteWorkforcemanagementManagementunitServicegoalgroup';
|
|
40527
|
-
}
|
|
40528
|
-
|
|
40529
|
-
return this.apiClient.callApi(
|
|
40530
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}',
|
|
40531
|
-
'DELETE',
|
|
40532
|
-
{ 'managementUnitId': managementUnitId,'serviceGoalGroupId': serviceGoalGroupId },
|
|
40533
|
-
{ },
|
|
40534
|
-
{ },
|
|
40535
|
-
{ },
|
|
40536
|
-
null,
|
|
40537
|
-
['PureCloud OAuth'],
|
|
40538
|
-
['application/json'],
|
|
40539
|
-
['application/json']
|
|
40540
|
-
);
|
|
40541
|
-
}
|
|
40542
|
-
|
|
40543
|
-
/**
|
|
40544
|
-
* Gone. Scheduling has moved under business units
|
|
40454
|
+
* Delete a work plan
|
|
40545
40455
|
*
|
|
40546
40456
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
40547
|
-
* @param {String}
|
|
40548
|
-
* @param {String} scheduleId Gone/deprecated. The ID of the schedule to delete
|
|
40549
|
-
*/
|
|
40550
|
-
deleteWorkforcemanagementManagementunitWeekSchedule(managementUnitId, weekId, scheduleId) {
|
|
40551
|
-
// verify the required parameter 'managementUnitId' is set
|
|
40552
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
40553
|
-
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWeekSchedule';
|
|
40554
|
-
}
|
|
40555
|
-
// verify the required parameter 'weekId' is set
|
|
40556
|
-
if (weekId === undefined || weekId === null) {
|
|
40557
|
-
throw 'Missing the required parameter "weekId" when calling deleteWorkforcemanagementManagementunitWeekSchedule';
|
|
40558
|
-
}
|
|
40559
|
-
// verify the required parameter 'scheduleId' is set
|
|
40560
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
40561
|
-
throw 'Missing the required parameter "scheduleId" when calling deleteWorkforcemanagementManagementunitWeekSchedule';
|
|
40562
|
-
}
|
|
40563
|
-
|
|
40564
|
-
return this.apiClient.callApi(
|
|
40565
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}',
|
|
40566
|
-
'DELETE',
|
|
40567
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
40568
|
-
{ },
|
|
40569
|
-
{ },
|
|
40570
|
-
{ },
|
|
40571
|
-
null,
|
|
40572
|
-
['PureCloud OAuth'],
|
|
40573
|
-
['application/json'],
|
|
40574
|
-
['application/json']
|
|
40575
|
-
);
|
|
40576
|
-
}
|
|
40577
|
-
|
|
40578
|
-
/**
|
|
40579
|
-
* Gone. Use equivalent business unit resource instead
|
|
40580
|
-
*
|
|
40581
|
-
* @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
|
|
40582
|
-
* @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
|
|
40583
|
-
* @param {String} forecastId (Gone/Deprecated): The ID of the forecast
|
|
40457
|
+
* @param {String} workPlanId The ID of the work plan to delete
|
|
40584
40458
|
*/
|
|
40585
|
-
|
|
40459
|
+
deleteWorkforcemanagementManagementunitWorkplan(managementUnitId, workPlanId) {
|
|
40586
40460
|
// verify the required parameter 'managementUnitId' is set
|
|
40587
40461
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
40588
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
40589
|
-
}
|
|
40590
|
-
// verify the required parameter 'weekDateId' is set
|
|
40591
|
-
if (weekDateId === undefined || weekDateId === null) {
|
|
40592
|
-
throw 'Missing the required parameter "weekDateId" when calling deleteWorkforcemanagementManagementunitWeekShorttermforecast';
|
|
40462
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWorkplan';
|
|
40593
40463
|
}
|
|
40594
|
-
// verify the required parameter '
|
|
40595
|
-
if (
|
|
40596
|
-
throw 'Missing the required parameter "
|
|
40464
|
+
// verify the required parameter 'workPlanId' is set
|
|
40465
|
+
if (workPlanId === undefined || workPlanId === null) {
|
|
40466
|
+
throw 'Missing the required parameter "workPlanId" when calling deleteWorkforcemanagementManagementunitWorkplan';
|
|
40597
40467
|
}
|
|
40598
40468
|
|
|
40599
40469
|
return this.apiClient.callApi(
|
|
40600
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
40470
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}',
|
|
40601
40471
|
'DELETE',
|
|
40602
|
-
{ 'managementUnitId': managementUnitId,'
|
|
40472
|
+
{ 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
|
|
40603
40473
|
{ },
|
|
40604
40474
|
{ },
|
|
40605
40475
|
{ },
|
|
@@ -40611,25 +40481,25 @@ class WorkforceManagementApi {
|
|
|
40611
40481
|
}
|
|
40612
40482
|
|
|
40613
40483
|
/**
|
|
40614
|
-
* Delete a work plan
|
|
40484
|
+
* Delete a work plan rotation
|
|
40615
40485
|
*
|
|
40616
40486
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
40617
|
-
* @param {String}
|
|
40487
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to be deleted
|
|
40618
40488
|
*/
|
|
40619
|
-
|
|
40489
|
+
deleteWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId) {
|
|
40620
40490
|
// verify the required parameter 'managementUnitId' is set
|
|
40621
40491
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
40622
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
40492
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitWorkplanrotation';
|
|
40623
40493
|
}
|
|
40624
|
-
// verify the required parameter '
|
|
40625
|
-
if (
|
|
40626
|
-
throw 'Missing the required parameter "
|
|
40494
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
40495
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
40496
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling deleteWorkforcemanagementManagementunitWorkplanrotation';
|
|
40627
40497
|
}
|
|
40628
40498
|
|
|
40629
40499
|
return this.apiClient.callApi(
|
|
40630
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
40500
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
|
|
40631
40501
|
'DELETE',
|
|
40632
|
-
{ 'managementUnitId': managementUnitId,'
|
|
40502
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
40633
40503
|
{ },
|
|
40634
40504
|
{ },
|
|
40635
40505
|
{ },
|
|
@@ -41444,36 +41314,6 @@ class WorkforceManagementApi {
|
|
|
41444
41314
|
);
|
|
41445
41315
|
}
|
|
41446
41316
|
|
|
41447
|
-
/**
|
|
41448
|
-
* Get an activity code
|
|
41449
|
-
*
|
|
41450
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
41451
|
-
* @param {String} acId The ID of the activity code to fetch
|
|
41452
|
-
*/
|
|
41453
|
-
getWorkforcemanagementManagementunitActivitycode(muId, acId) {
|
|
41454
|
-
// verify the required parameter 'muId' is set
|
|
41455
|
-
if (muId === undefined || muId === null) {
|
|
41456
|
-
throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitActivitycode';
|
|
41457
|
-
}
|
|
41458
|
-
// verify the required parameter 'acId' is set
|
|
41459
|
-
if (acId === undefined || acId === null) {
|
|
41460
|
-
throw 'Missing the required parameter "acId" when calling getWorkforcemanagementManagementunitActivitycode';
|
|
41461
|
-
}
|
|
41462
|
-
|
|
41463
|
-
return this.apiClient.callApi(
|
|
41464
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}',
|
|
41465
|
-
'GET',
|
|
41466
|
-
{ 'muId': muId,'acId': acId },
|
|
41467
|
-
{ },
|
|
41468
|
-
{ },
|
|
41469
|
-
{ },
|
|
41470
|
-
null,
|
|
41471
|
-
['PureCloud OAuth'],
|
|
41472
|
-
['application/json'],
|
|
41473
|
-
['application/json']
|
|
41474
|
-
);
|
|
41475
|
-
}
|
|
41476
|
-
|
|
41477
41317
|
/**
|
|
41478
41318
|
* Get activity codes
|
|
41479
41319
|
*
|
|
@@ -41592,196 +41432,6 @@ class WorkforceManagementApi {
|
|
|
41592
41432
|
);
|
|
41593
41433
|
}
|
|
41594
41434
|
|
|
41595
|
-
/**
|
|
41596
|
-
* Gone. Moved under business units
|
|
41597
|
-
*
|
|
41598
|
-
* @param {String} muId The management unit ID of the management unit
|
|
41599
|
-
*/
|
|
41600
|
-
getWorkforcemanagementManagementunitIntradayQueues(muId) {
|
|
41601
|
-
// verify the required parameter 'muId' is set
|
|
41602
|
-
if (muId === undefined || muId === null) {
|
|
41603
|
-
throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitIntradayQueues';
|
|
41604
|
-
}
|
|
41605
|
-
|
|
41606
|
-
return this.apiClient.callApi(
|
|
41607
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/intraday/queues',
|
|
41608
|
-
'GET',
|
|
41609
|
-
{ 'muId': muId },
|
|
41610
|
-
{ },
|
|
41611
|
-
{ },
|
|
41612
|
-
{ },
|
|
41613
|
-
null,
|
|
41614
|
-
['PureCloud OAuth'],
|
|
41615
|
-
['application/json'],
|
|
41616
|
-
['application/json']
|
|
41617
|
-
);
|
|
41618
|
-
}
|
|
41619
|
-
|
|
41620
|
-
/**
|
|
41621
|
-
* Gone. Scheduling has moved under business units
|
|
41622
|
-
*
|
|
41623
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
|
|
41624
|
-
* @param {String} runId The ID of the schedule run
|
|
41625
|
-
*/
|
|
41626
|
-
getWorkforcemanagementManagementunitSchedulingRun(managementUnitId, runId) {
|
|
41627
|
-
// verify the required parameter 'managementUnitId' is set
|
|
41628
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
41629
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitSchedulingRun';
|
|
41630
|
-
}
|
|
41631
|
-
// verify the required parameter 'runId' is set
|
|
41632
|
-
if (runId === undefined || runId === null) {
|
|
41633
|
-
throw 'Missing the required parameter "runId" when calling getWorkforcemanagementManagementunitSchedulingRun';
|
|
41634
|
-
}
|
|
41635
|
-
|
|
41636
|
-
return this.apiClient.callApi(
|
|
41637
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}',
|
|
41638
|
-
'GET',
|
|
41639
|
-
{ 'managementUnitId': managementUnitId,'runId': runId },
|
|
41640
|
-
{ },
|
|
41641
|
-
{ },
|
|
41642
|
-
{ },
|
|
41643
|
-
null,
|
|
41644
|
-
['PureCloud OAuth'],
|
|
41645
|
-
['application/json'],
|
|
41646
|
-
['application/json']
|
|
41647
|
-
);
|
|
41648
|
-
}
|
|
41649
|
-
|
|
41650
|
-
/**
|
|
41651
|
-
* Gone. Scheduling has moved under business units
|
|
41652
|
-
*
|
|
41653
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
|
|
41654
|
-
* @param {String} runId The ID of the schedule run
|
|
41655
|
-
*/
|
|
41656
|
-
getWorkforcemanagementManagementunitSchedulingRunResult(managementUnitId, runId) {
|
|
41657
|
-
// verify the required parameter 'managementUnitId' is set
|
|
41658
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
41659
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitSchedulingRunResult';
|
|
41660
|
-
}
|
|
41661
|
-
// verify the required parameter 'runId' is set
|
|
41662
|
-
if (runId === undefined || runId === null) {
|
|
41663
|
-
throw 'Missing the required parameter "runId" when calling getWorkforcemanagementManagementunitSchedulingRunResult';
|
|
41664
|
-
}
|
|
41665
|
-
|
|
41666
|
-
return this.apiClient.callApi(
|
|
41667
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}/result',
|
|
41668
|
-
'GET',
|
|
41669
|
-
{ 'managementUnitId': managementUnitId,'runId': runId },
|
|
41670
|
-
{ },
|
|
41671
|
-
{ },
|
|
41672
|
-
{ },
|
|
41673
|
-
null,
|
|
41674
|
-
['PureCloud OAuth'],
|
|
41675
|
-
['application/json'],
|
|
41676
|
-
['application/json']
|
|
41677
|
-
);
|
|
41678
|
-
}
|
|
41679
|
-
|
|
41680
|
-
/**
|
|
41681
|
-
* Gone. Scheduling has moved under business units
|
|
41682
|
-
*
|
|
41683
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
|
|
41684
|
-
*/
|
|
41685
|
-
getWorkforcemanagementManagementunitSchedulingRuns(managementUnitId) {
|
|
41686
|
-
// verify the required parameter 'managementUnitId' is set
|
|
41687
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
41688
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitSchedulingRuns';
|
|
41689
|
-
}
|
|
41690
|
-
|
|
41691
|
-
return this.apiClient.callApi(
|
|
41692
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs',
|
|
41693
|
-
'GET',
|
|
41694
|
-
{ 'managementUnitId': managementUnitId },
|
|
41695
|
-
{ },
|
|
41696
|
-
{ },
|
|
41697
|
-
{ },
|
|
41698
|
-
null,
|
|
41699
|
-
['PureCloud OAuth'],
|
|
41700
|
-
['application/json'],
|
|
41701
|
-
['application/json']
|
|
41702
|
-
);
|
|
41703
|
-
}
|
|
41704
|
-
|
|
41705
|
-
/**
|
|
41706
|
-
* Gone. Replaced with service goal templates and planning groups under business units
|
|
41707
|
-
*
|
|
41708
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
41709
|
-
* @param {String} serviceGoalGroupId Gone. The ID of the service goal group to fetch
|
|
41710
|
-
*/
|
|
41711
|
-
getWorkforcemanagementManagementunitServicegoalgroup(managementUnitId, serviceGoalGroupId) {
|
|
41712
|
-
// verify the required parameter 'managementUnitId' is set
|
|
41713
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
41714
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitServicegoalgroup';
|
|
41715
|
-
}
|
|
41716
|
-
// verify the required parameter 'serviceGoalGroupId' is set
|
|
41717
|
-
if (serviceGoalGroupId === undefined || serviceGoalGroupId === null) {
|
|
41718
|
-
throw 'Missing the required parameter "serviceGoalGroupId" when calling getWorkforcemanagementManagementunitServicegoalgroup';
|
|
41719
|
-
}
|
|
41720
|
-
|
|
41721
|
-
return this.apiClient.callApi(
|
|
41722
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}',
|
|
41723
|
-
'GET',
|
|
41724
|
-
{ 'managementUnitId': managementUnitId,'serviceGoalGroupId': serviceGoalGroupId },
|
|
41725
|
-
{ },
|
|
41726
|
-
{ },
|
|
41727
|
-
{ },
|
|
41728
|
-
null,
|
|
41729
|
-
['PureCloud OAuth'],
|
|
41730
|
-
['application/json'],
|
|
41731
|
-
['application/json']
|
|
41732
|
-
);
|
|
41733
|
-
}
|
|
41734
|
-
|
|
41735
|
-
/**
|
|
41736
|
-
* Gone. Replaced with service goal templates and planning groups under business units
|
|
41737
|
-
*
|
|
41738
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
41739
|
-
*/
|
|
41740
|
-
getWorkforcemanagementManagementunitServicegoalgroups(managementUnitId) {
|
|
41741
|
-
// verify the required parameter 'managementUnitId' is set
|
|
41742
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
41743
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitServicegoalgroups';
|
|
41744
|
-
}
|
|
41745
|
-
|
|
41746
|
-
return this.apiClient.callApi(
|
|
41747
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups',
|
|
41748
|
-
'GET',
|
|
41749
|
-
{ 'managementUnitId': managementUnitId },
|
|
41750
|
-
{ },
|
|
41751
|
-
{ },
|
|
41752
|
-
{ },
|
|
41753
|
-
null,
|
|
41754
|
-
['PureCloud OAuth'],
|
|
41755
|
-
['application/json'],
|
|
41756
|
-
['application/json']
|
|
41757
|
-
);
|
|
41758
|
-
}
|
|
41759
|
-
|
|
41760
|
-
/**
|
|
41761
|
-
* Gone. Get management unit settings via expand parameters on the GET management unit
|
|
41762
|
-
*
|
|
41763
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
41764
|
-
*/
|
|
41765
|
-
getWorkforcemanagementManagementunitSettings(muId) {
|
|
41766
|
-
// verify the required parameter 'muId' is set
|
|
41767
|
-
if (muId === undefined || muId === null) {
|
|
41768
|
-
throw 'Missing the required parameter "muId" when calling getWorkforcemanagementManagementunitSettings';
|
|
41769
|
-
}
|
|
41770
|
-
|
|
41771
|
-
return this.apiClient.callApi(
|
|
41772
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/settings',
|
|
41773
|
-
'GET',
|
|
41774
|
-
{ 'muId': muId },
|
|
41775
|
-
{ },
|
|
41776
|
-
{ },
|
|
41777
|
-
{ },
|
|
41778
|
-
null,
|
|
41779
|
-
['PureCloud OAuth'],
|
|
41780
|
-
['application/json'],
|
|
41781
|
-
['application/json']
|
|
41782
|
-
);
|
|
41783
|
-
}
|
|
41784
|
-
|
|
41785
41435
|
/**
|
|
41786
41436
|
* Gets a summary of all shift trades in the matched state
|
|
41787
41437
|
*
|
|
@@ -41966,41 +41616,6 @@ class WorkforceManagementApi {
|
|
|
41966
41616
|
);
|
|
41967
41617
|
}
|
|
41968
41618
|
|
|
41969
|
-
/**
|
|
41970
|
-
* Gone. Scheduling has moved under business units
|
|
41971
|
-
*
|
|
41972
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
41973
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
41974
|
-
* @param {String} scheduleId Gone/deprecated. The ID of the schedule to fetch generation results
|
|
41975
|
-
*/
|
|
41976
|
-
getWorkforcemanagementManagementunitWeekScheduleGenerationresults(managementUnitId, weekId, scheduleId) {
|
|
41977
|
-
// verify the required parameter 'managementUnitId' is set
|
|
41978
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
41979
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekScheduleGenerationresults';
|
|
41980
|
-
}
|
|
41981
|
-
// verify the required parameter 'weekId' is set
|
|
41982
|
-
if (weekId === undefined || weekId === null) {
|
|
41983
|
-
throw 'Missing the required parameter "weekId" when calling getWorkforcemanagementManagementunitWeekScheduleGenerationresults';
|
|
41984
|
-
}
|
|
41985
|
-
// verify the required parameter 'scheduleId' is set
|
|
41986
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
41987
|
-
throw 'Missing the required parameter "scheduleId" when calling getWorkforcemanagementManagementunitWeekScheduleGenerationresults';
|
|
41988
|
-
}
|
|
41989
|
-
|
|
41990
|
-
return this.apiClient.callApi(
|
|
41991
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/generationresults',
|
|
41992
|
-
'GET',
|
|
41993
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
41994
|
-
{ },
|
|
41995
|
-
{ },
|
|
41996
|
-
{ },
|
|
41997
|
-
null,
|
|
41998
|
-
['PureCloud OAuth'],
|
|
41999
|
-
['application/json'],
|
|
42000
|
-
['application/json']
|
|
42001
|
-
);
|
|
42002
|
-
}
|
|
42003
|
-
|
|
42004
41619
|
/**
|
|
42005
41620
|
* Deprecated. Use the equivalent business unit resource instead. Get the list of schedules in a week in management unit
|
|
42006
41621
|
*
|
|
@@ -42071,71 +41686,6 @@ class WorkforceManagementApi {
|
|
|
42071
41686
|
);
|
|
42072
41687
|
}
|
|
42073
41688
|
|
|
42074
|
-
/**
|
|
42075
|
-
* Gone. Use equivalent business unit resource instead
|
|
42076
|
-
*
|
|
42077
|
-
* @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
|
|
42078
|
-
* @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
|
|
42079
|
-
* @param {String} forecastId (Gone/Deprecated): The ID of the forecast
|
|
42080
|
-
*/
|
|
42081
|
-
getWorkforcemanagementManagementunitWeekShorttermforecastFinal(managementUnitId, weekDateId, forecastId) {
|
|
42082
|
-
// verify the required parameter 'managementUnitId' is set
|
|
42083
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
42084
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekShorttermforecastFinal';
|
|
42085
|
-
}
|
|
42086
|
-
// verify the required parameter 'weekDateId' is set
|
|
42087
|
-
if (weekDateId === undefined || weekDateId === null) {
|
|
42088
|
-
throw 'Missing the required parameter "weekDateId" when calling getWorkforcemanagementManagementunitWeekShorttermforecastFinal';
|
|
42089
|
-
}
|
|
42090
|
-
// verify the required parameter 'forecastId' is set
|
|
42091
|
-
if (forecastId === undefined || forecastId === null) {
|
|
42092
|
-
throw 'Missing the required parameter "forecastId" when calling getWorkforcemanagementManagementunitWeekShorttermforecastFinal';
|
|
42093
|
-
}
|
|
42094
|
-
|
|
42095
|
-
return this.apiClient.callApi(
|
|
42096
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/final',
|
|
42097
|
-
'GET',
|
|
42098
|
-
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
|
|
42099
|
-
{ },
|
|
42100
|
-
{ },
|
|
42101
|
-
{ },
|
|
42102
|
-
null,
|
|
42103
|
-
['PureCloud OAuth'],
|
|
42104
|
-
['application/json'],
|
|
42105
|
-
['application/json']
|
|
42106
|
-
);
|
|
42107
|
-
}
|
|
42108
|
-
|
|
42109
|
-
/**
|
|
42110
|
-
* Gone. Use equivalent business unit resource instead
|
|
42111
|
-
*
|
|
42112
|
-
* @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
|
|
42113
|
-
* @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
|
|
42114
|
-
*/
|
|
42115
|
-
getWorkforcemanagementManagementunitWeekShorttermforecasts(managementUnitId, weekDateId) {
|
|
42116
|
-
// verify the required parameter 'managementUnitId' is set
|
|
42117
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
42118
|
-
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWeekShorttermforecasts';
|
|
42119
|
-
}
|
|
42120
|
-
// verify the required parameter 'weekDateId' is set
|
|
42121
|
-
if (weekDateId === undefined || weekDateId === null) {
|
|
42122
|
-
throw 'Missing the required parameter "weekDateId" when calling getWorkforcemanagementManagementunitWeekShorttermforecasts';
|
|
42123
|
-
}
|
|
42124
|
-
|
|
42125
|
-
return this.apiClient.callApi(
|
|
42126
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts',
|
|
42127
|
-
'GET',
|
|
42128
|
-
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
|
|
42129
|
-
{ },
|
|
42130
|
-
{ },
|
|
42131
|
-
{ },
|
|
42132
|
-
null,
|
|
42133
|
-
['PureCloud OAuth'],
|
|
42134
|
-
['application/json'],
|
|
42135
|
-
['application/json']
|
|
42136
|
-
);
|
|
42137
|
-
}
|
|
42138
|
-
|
|
42139
41689
|
/**
|
|
42140
41690
|
* Get a work plan
|
|
42141
41691
|
*
|
|
@@ -42166,6 +41716,65 @@ class WorkforceManagementApi {
|
|
|
42166
41716
|
);
|
|
42167
41717
|
}
|
|
42168
41718
|
|
|
41719
|
+
/**
|
|
41720
|
+
* Get a work plan rotation
|
|
41721
|
+
*
|
|
41722
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
41723
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to fetch
|
|
41724
|
+
*/
|
|
41725
|
+
getWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId) {
|
|
41726
|
+
// verify the required parameter 'managementUnitId' is set
|
|
41727
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
41728
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplanrotation';
|
|
41729
|
+
}
|
|
41730
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
41731
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
41732
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling getWorkforcemanagementManagementunitWorkplanrotation';
|
|
41733
|
+
}
|
|
41734
|
+
|
|
41735
|
+
return this.apiClient.callApi(
|
|
41736
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
|
|
41737
|
+
'GET',
|
|
41738
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
41739
|
+
{ },
|
|
41740
|
+
{ },
|
|
41741
|
+
{ },
|
|
41742
|
+
null,
|
|
41743
|
+
['PureCloud OAuth'],
|
|
41744
|
+
['application/json'],
|
|
41745
|
+
['application/json']
|
|
41746
|
+
);
|
|
41747
|
+
}
|
|
41748
|
+
|
|
41749
|
+
/**
|
|
41750
|
+
* Get work plan rotations
|
|
41751
|
+
*
|
|
41752
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
41753
|
+
* @param {Object} opts Optional parameters
|
|
41754
|
+
* @param {Array.<String>} opts.expand
|
|
41755
|
+
*/
|
|
41756
|
+
getWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, opts) {
|
|
41757
|
+
opts = opts || {};
|
|
41758
|
+
|
|
41759
|
+
// verify the required parameter 'managementUnitId' is set
|
|
41760
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
41761
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitWorkplanrotations';
|
|
41762
|
+
}
|
|
41763
|
+
|
|
41764
|
+
return this.apiClient.callApi(
|
|
41765
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
|
|
41766
|
+
'GET',
|
|
41767
|
+
{ 'managementUnitId': managementUnitId },
|
|
41768
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
41769
|
+
{ },
|
|
41770
|
+
{ },
|
|
41771
|
+
null,
|
|
41772
|
+
['PureCloud OAuth'],
|
|
41773
|
+
['application/json'],
|
|
41774
|
+
['application/json']
|
|
41775
|
+
);
|
|
41776
|
+
}
|
|
41777
|
+
|
|
42169
41778
|
/**
|
|
42170
41779
|
* Get work plans
|
|
42171
41780
|
*
|
|
@@ -42555,129 +42164,6 @@ class WorkforceManagementApi {
|
|
|
42555
42164
|
);
|
|
42556
42165
|
}
|
|
42557
42166
|
|
|
42558
|
-
/**
|
|
42559
|
-
* Deprecated/Gone: Use the new business unit activity code resources
|
|
42560
|
-
*
|
|
42561
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
42562
|
-
* @param {String} acId The ID of the activity code to update
|
|
42563
|
-
* @param {Object} opts Optional parameters
|
|
42564
|
-
* @param {Object} opts.body body
|
|
42565
|
-
*/
|
|
42566
|
-
patchWorkforcemanagementManagementunitActivitycode(muId, acId, opts) {
|
|
42567
|
-
opts = opts || {};
|
|
42568
|
-
|
|
42569
|
-
// verify the required parameter 'muId' is set
|
|
42570
|
-
if (muId === undefined || muId === null) {
|
|
42571
|
-
throw 'Missing the required parameter "muId" when calling patchWorkforcemanagementManagementunitActivitycode';
|
|
42572
|
-
}
|
|
42573
|
-
// verify the required parameter 'acId' is set
|
|
42574
|
-
if (acId === undefined || acId === null) {
|
|
42575
|
-
throw 'Missing the required parameter "acId" when calling patchWorkforcemanagementManagementunitActivitycode';
|
|
42576
|
-
}
|
|
42577
|
-
|
|
42578
|
-
return this.apiClient.callApi(
|
|
42579
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/activitycodes/{acId}',
|
|
42580
|
-
'PATCH',
|
|
42581
|
-
{ 'muId': muId,'acId': acId },
|
|
42582
|
-
{ },
|
|
42583
|
-
{ },
|
|
42584
|
-
{ },
|
|
42585
|
-
opts['body'],
|
|
42586
|
-
['PureCloud OAuth'],
|
|
42587
|
-
['application/json'],
|
|
42588
|
-
['application/json']
|
|
42589
|
-
);
|
|
42590
|
-
}
|
|
42591
|
-
|
|
42592
|
-
/**
|
|
42593
|
-
* Gone. Scheduling has moved under business units
|
|
42594
|
-
*
|
|
42595
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit.
|
|
42596
|
-
* @param {String} runId The ID of the schedule run
|
|
42597
|
-
* @param {Object} opts Optional parameters
|
|
42598
|
-
* @param {Object} opts.body body
|
|
42599
|
-
*/
|
|
42600
|
-
patchWorkforcemanagementManagementunitSchedulingRun(managementUnitId, runId, opts) {
|
|
42601
|
-
opts = opts || {};
|
|
42602
|
-
|
|
42603
|
-
// verify the required parameter 'managementUnitId' is set
|
|
42604
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
42605
|
-
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitSchedulingRun';
|
|
42606
|
-
}
|
|
42607
|
-
// verify the required parameter 'runId' is set
|
|
42608
|
-
if (runId === undefined || runId === null) {
|
|
42609
|
-
throw 'Missing the required parameter "runId" when calling patchWorkforcemanagementManagementunitSchedulingRun';
|
|
42610
|
-
}
|
|
42611
|
-
|
|
42612
|
-
return this.apiClient.callApi(
|
|
42613
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/scheduling/runs/{runId}',
|
|
42614
|
-
'PATCH',
|
|
42615
|
-
{ 'managementUnitId': managementUnitId,'runId': runId },
|
|
42616
|
-
{ },
|
|
42617
|
-
{ },
|
|
42618
|
-
{ },
|
|
42619
|
-
opts['body'],
|
|
42620
|
-
['PureCloud OAuth'],
|
|
42621
|
-
['application/json'],
|
|
42622
|
-
['application/json']
|
|
42623
|
-
);
|
|
42624
|
-
}
|
|
42625
|
-
|
|
42626
|
-
/**
|
|
42627
|
-
* Gone. Replaced with service goal templates and planning groups under business units
|
|
42628
|
-
*
|
|
42629
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
42630
|
-
* @param {String} serviceGoalGroupId Gone. The ID of the service goal group to update
|
|
42631
|
-
*/
|
|
42632
|
-
patchWorkforcemanagementManagementunitServicegoalgroup(managementUnitId, serviceGoalGroupId) {
|
|
42633
|
-
// verify the required parameter 'managementUnitId' is set
|
|
42634
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
42635
|
-
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitServicegoalgroup';
|
|
42636
|
-
}
|
|
42637
|
-
// verify the required parameter 'serviceGoalGroupId' is set
|
|
42638
|
-
if (serviceGoalGroupId === undefined || serviceGoalGroupId === null) {
|
|
42639
|
-
throw 'Missing the required parameter "serviceGoalGroupId" when calling patchWorkforcemanagementManagementunitServicegoalgroup';
|
|
42640
|
-
}
|
|
42641
|
-
|
|
42642
|
-
return this.apiClient.callApi(
|
|
42643
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups/{serviceGoalGroupId}',
|
|
42644
|
-
'PATCH',
|
|
42645
|
-
{ 'managementUnitId': managementUnitId,'serviceGoalGroupId': serviceGoalGroupId },
|
|
42646
|
-
{ },
|
|
42647
|
-
{ },
|
|
42648
|
-
{ },
|
|
42649
|
-
null,
|
|
42650
|
-
['PureCloud OAuth'],
|
|
42651
|
-
['application/json'],
|
|
42652
|
-
['application/json']
|
|
42653
|
-
);
|
|
42654
|
-
}
|
|
42655
|
-
|
|
42656
|
-
/**
|
|
42657
|
-
* Gone. Update settings by PATCHing the management unit
|
|
42658
|
-
*
|
|
42659
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
42660
|
-
*/
|
|
42661
|
-
patchWorkforcemanagementManagementunitSettings(muId) {
|
|
42662
|
-
// verify the required parameter 'muId' is set
|
|
42663
|
-
if (muId === undefined || muId === null) {
|
|
42664
|
-
throw 'Missing the required parameter "muId" when calling patchWorkforcemanagementManagementunitSettings';
|
|
42665
|
-
}
|
|
42666
|
-
|
|
42667
|
-
return this.apiClient.callApi(
|
|
42668
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/settings',
|
|
42669
|
-
'PATCH',
|
|
42670
|
-
{ 'muId': muId },
|
|
42671
|
-
{ },
|
|
42672
|
-
{ },
|
|
42673
|
-
{ },
|
|
42674
|
-
null,
|
|
42675
|
-
['PureCloud OAuth'],
|
|
42676
|
-
['application/json'],
|
|
42677
|
-
['application/json']
|
|
42678
|
-
);
|
|
42679
|
-
}
|
|
42680
|
-
|
|
42681
42167
|
/**
|
|
42682
42168
|
* Update a time off request
|
|
42683
42169
|
*
|
|
@@ -42717,41 +42203,6 @@ class WorkforceManagementApi {
|
|
|
42717
42203
|
);
|
|
42718
42204
|
}
|
|
42719
42205
|
|
|
42720
|
-
/**
|
|
42721
|
-
* Gone. Scheduling has moved under business units
|
|
42722
|
-
*
|
|
42723
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
42724
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
42725
|
-
* @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
|
|
42726
|
-
*/
|
|
42727
|
-
patchWorkforcemanagementManagementunitWeekSchedule(managementUnitId, weekId, scheduleId) {
|
|
42728
|
-
// verify the required parameter 'managementUnitId' is set
|
|
42729
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
42730
|
-
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWeekSchedule';
|
|
42731
|
-
}
|
|
42732
|
-
// verify the required parameter 'weekId' is set
|
|
42733
|
-
if (weekId === undefined || weekId === null) {
|
|
42734
|
-
throw 'Missing the required parameter "weekId" when calling patchWorkforcemanagementManagementunitWeekSchedule';
|
|
42735
|
-
}
|
|
42736
|
-
// verify the required parameter 'scheduleId' is set
|
|
42737
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
42738
|
-
throw 'Missing the required parameter "scheduleId" when calling patchWorkforcemanagementManagementunitWeekSchedule';
|
|
42739
|
-
}
|
|
42740
|
-
|
|
42741
|
-
return this.apiClient.callApi(
|
|
42742
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}',
|
|
42743
|
-
'PATCH',
|
|
42744
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
42745
|
-
{ },
|
|
42746
|
-
{ },
|
|
42747
|
-
{ },
|
|
42748
|
-
null,
|
|
42749
|
-
['PureCloud OAuth'],
|
|
42750
|
-
['application/json'],
|
|
42751
|
-
['application/json']
|
|
42752
|
-
);
|
|
42753
|
-
}
|
|
42754
|
-
|
|
42755
42206
|
/**
|
|
42756
42207
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
42757
42208
|
*
|
|
@@ -42799,6 +42250,7 @@ class WorkforceManagementApi {
|
|
|
42799
42250
|
* @param {String} workPlanId The ID of the work plan to update
|
|
42800
42251
|
* @param {Object} opts Optional parameters
|
|
42801
42252
|
* @param {Object} opts.body body
|
|
42253
|
+
* @param {Object} opts.validationMode Allows to update work plan even if validation result is invalid
|
|
42802
42254
|
*/
|
|
42803
42255
|
patchWorkforcemanagementManagementunitWorkplan(managementUnitId, workPlanId, opts) {
|
|
42804
42256
|
opts = opts || {};
|
|
@@ -42816,6 +42268,40 @@ class WorkforceManagementApi {
|
|
|
42816
42268
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}',
|
|
42817
42269
|
'PATCH',
|
|
42818
42270
|
{ 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
|
|
42271
|
+
{ 'validationMode': opts['validationMode'] },
|
|
42272
|
+
{ },
|
|
42273
|
+
{ },
|
|
42274
|
+
opts['body'],
|
|
42275
|
+
['PureCloud OAuth'],
|
|
42276
|
+
['application/json'],
|
|
42277
|
+
['application/json']
|
|
42278
|
+
);
|
|
42279
|
+
}
|
|
42280
|
+
|
|
42281
|
+
/**
|
|
42282
|
+
* Update a work plan rotation
|
|
42283
|
+
*
|
|
42284
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
42285
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to update
|
|
42286
|
+
* @param {Object} opts Optional parameters
|
|
42287
|
+
* @param {Object} opts.body body
|
|
42288
|
+
*/
|
|
42289
|
+
patchWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId, opts) {
|
|
42290
|
+
opts = opts || {};
|
|
42291
|
+
|
|
42292
|
+
// verify the required parameter 'managementUnitId' is set
|
|
42293
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
42294
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
|
|
42295
|
+
}
|
|
42296
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
42297
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
42298
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
|
|
42299
|
+
}
|
|
42300
|
+
|
|
42301
|
+
return this.apiClient.callApi(
|
|
42302
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
|
|
42303
|
+
'PATCH',
|
|
42304
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
42819
42305
|
{ },
|
|
42820
42306
|
{ },
|
|
42821
42307
|
{ },
|
|
@@ -43353,31 +42839,6 @@ class WorkforceManagementApi {
|
|
|
43353
42839
|
);
|
|
43354
42840
|
}
|
|
43355
42841
|
|
|
43356
|
-
/**
|
|
43357
|
-
* Deprecated/Gone: Use the new business unit activity code resources
|
|
43358
|
-
*
|
|
43359
|
-
* @param {String} muId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
43360
|
-
*/
|
|
43361
|
-
postWorkforcemanagementManagementunitActivitycodes(muId) {
|
|
43362
|
-
// verify the required parameter 'muId' is set
|
|
43363
|
-
if (muId === undefined || muId === null) {
|
|
43364
|
-
throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitActivitycodes';
|
|
43365
|
-
}
|
|
43366
|
-
|
|
43367
|
-
return this.apiClient.callApi(
|
|
43368
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/activitycodes',
|
|
43369
|
-
'POST',
|
|
43370
|
-
{ 'muId': muId },
|
|
43371
|
-
{ },
|
|
43372
|
-
{ },
|
|
43373
|
-
{ },
|
|
43374
|
-
null,
|
|
43375
|
-
['PureCloud OAuth'],
|
|
43376
|
-
['application/json'],
|
|
43377
|
-
['application/json']
|
|
43378
|
-
);
|
|
43379
|
-
}
|
|
43380
|
-
|
|
43381
42842
|
/**
|
|
43382
42843
|
* Query published schedules for given given time range for set of users
|
|
43383
42844
|
*
|
|
@@ -43438,31 +42899,6 @@ class WorkforceManagementApi {
|
|
|
43438
42899
|
);
|
|
43439
42900
|
}
|
|
43440
42901
|
|
|
43441
|
-
/**
|
|
43442
|
-
* Gone. Moved under business units
|
|
43443
|
-
*
|
|
43444
|
-
* @param {String} muId The management unit ID of the management unit
|
|
43445
|
-
*/
|
|
43446
|
-
postWorkforcemanagementManagementunitIntraday(muId) {
|
|
43447
|
-
// verify the required parameter 'muId' is set
|
|
43448
|
-
if (muId === undefined || muId === null) {
|
|
43449
|
-
throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitIntraday';
|
|
43450
|
-
}
|
|
43451
|
-
|
|
43452
|
-
return this.apiClient.callApi(
|
|
43453
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/intraday',
|
|
43454
|
-
'POST',
|
|
43455
|
-
{ 'muId': muId },
|
|
43456
|
-
{ },
|
|
43457
|
-
{ },
|
|
43458
|
-
{ },
|
|
43459
|
-
null,
|
|
43460
|
-
['PureCloud OAuth'],
|
|
43461
|
-
['application/json'],
|
|
43462
|
-
['application/json']
|
|
43463
|
-
);
|
|
43464
|
-
}
|
|
43465
|
-
|
|
43466
42902
|
/**
|
|
43467
42903
|
* Move the requested management unit to a new business unit
|
|
43468
42904
|
* Returns status 200 if the management unit is already in the requested business unit
|
|
@@ -43521,31 +42957,6 @@ class WorkforceManagementApi {
|
|
|
43521
42957
|
);
|
|
43522
42958
|
}
|
|
43523
42959
|
|
|
43524
|
-
/**
|
|
43525
|
-
* Gone. Replaced with service goal templates and planning groups under business units
|
|
43526
|
-
*
|
|
43527
|
-
* @param {String} managementUnitId (Deprecated/gone): The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
43528
|
-
*/
|
|
43529
|
-
postWorkforcemanagementManagementunitServicegoalgroups(managementUnitId) {
|
|
43530
|
-
// verify the required parameter 'managementUnitId' is set
|
|
43531
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
43532
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitServicegoalgroups';
|
|
43533
|
-
}
|
|
43534
|
-
|
|
43535
|
-
return this.apiClient.callApi(
|
|
43536
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/servicegoalgroups',
|
|
43537
|
-
'POST',
|
|
43538
|
-
{ 'managementUnitId': managementUnitId },
|
|
43539
|
-
{ },
|
|
43540
|
-
{ },
|
|
43541
|
-
{ },
|
|
43542
|
-
null,
|
|
43543
|
-
['PureCloud OAuth'],
|
|
43544
|
-
['application/json'],
|
|
43545
|
-
['application/json']
|
|
43546
|
-
);
|
|
43547
|
-
}
|
|
43548
|
-
|
|
43549
42960
|
/**
|
|
43550
42961
|
* Create a new time off request
|
|
43551
42962
|
*
|
|
@@ -43575,35 +42986,6 @@ class WorkforceManagementApi {
|
|
|
43575
42986
|
);
|
|
43576
42987
|
}
|
|
43577
42988
|
|
|
43578
|
-
/**
|
|
43579
|
-
* Gone. All data is now returned in the query route
|
|
43580
|
-
*
|
|
43581
|
-
* @param {String} muId The muId of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
43582
|
-
* @param {Object} opts Optional parameters
|
|
43583
|
-
* @param {Object} opts.body body
|
|
43584
|
-
*/
|
|
43585
|
-
postWorkforcemanagementManagementunitTimeoffrequestsFetchdetails(muId, opts) {
|
|
43586
|
-
opts = opts || {};
|
|
43587
|
-
|
|
43588
|
-
// verify the required parameter 'muId' is set
|
|
43589
|
-
if (muId === undefined || muId === null) {
|
|
43590
|
-
throw 'Missing the required parameter "muId" when calling postWorkforcemanagementManagementunitTimeoffrequestsFetchdetails';
|
|
43591
|
-
}
|
|
43592
|
-
|
|
43593
|
-
return this.apiClient.callApi(
|
|
43594
|
-
'/api/v2/workforcemanagement/managementunits/{muId}/timeoffrequests/fetchdetails',
|
|
43595
|
-
'POST',
|
|
43596
|
-
{ 'muId': muId },
|
|
43597
|
-
{ },
|
|
43598
|
-
{ },
|
|
43599
|
-
{ },
|
|
43600
|
-
opts['body'],
|
|
43601
|
-
['PureCloud OAuth'],
|
|
43602
|
-
['application/json'],
|
|
43603
|
-
['application/json']
|
|
43604
|
-
);
|
|
43605
|
-
}
|
|
43606
|
-
|
|
43607
42989
|
/**
|
|
43608
42990
|
* Gets the lookup ids to fetch the specified set of requests
|
|
43609
42991
|
*
|
|
@@ -43633,166 +43015,6 @@ class WorkforceManagementApi {
|
|
|
43633
43015
|
);
|
|
43634
43016
|
}
|
|
43635
43017
|
|
|
43636
|
-
/**
|
|
43637
|
-
* Gone. Scheduling has moved under business units
|
|
43638
|
-
*
|
|
43639
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
43640
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
43641
|
-
* @param {String} scheduleId Gone/deprecated. The ID of the schedule to copy from
|
|
43642
|
-
*/
|
|
43643
|
-
postWorkforcemanagementManagementunitWeekScheduleCopy(managementUnitId, weekId, scheduleId) {
|
|
43644
|
-
// verify the required parameter 'managementUnitId' is set
|
|
43645
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
43646
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekScheduleCopy';
|
|
43647
|
-
}
|
|
43648
|
-
// verify the required parameter 'weekId' is set
|
|
43649
|
-
if (weekId === undefined || weekId === null) {
|
|
43650
|
-
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekScheduleCopy';
|
|
43651
|
-
}
|
|
43652
|
-
// verify the required parameter 'scheduleId' is set
|
|
43653
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
43654
|
-
throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementManagementunitWeekScheduleCopy';
|
|
43655
|
-
}
|
|
43656
|
-
|
|
43657
|
-
return this.apiClient.callApi(
|
|
43658
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy',
|
|
43659
|
-
'POST',
|
|
43660
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
43661
|
-
{ },
|
|
43662
|
-
{ },
|
|
43663
|
-
{ },
|
|
43664
|
-
null,
|
|
43665
|
-
['PureCloud OAuth'],
|
|
43666
|
-
['application/json'],
|
|
43667
|
-
['application/json']
|
|
43668
|
-
);
|
|
43669
|
-
}
|
|
43670
|
-
|
|
43671
|
-
/**
|
|
43672
|
-
* Gone. Scheduling has moved under business units
|
|
43673
|
-
*
|
|
43674
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
43675
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
43676
|
-
* @param {String} scheduleId Gone/deprecated. The ID of the schedule to re-optimize
|
|
43677
|
-
*/
|
|
43678
|
-
postWorkforcemanagementManagementunitWeekScheduleReschedule(managementUnitId, weekId, scheduleId) {
|
|
43679
|
-
// verify the required parameter 'managementUnitId' is set
|
|
43680
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
43681
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekScheduleReschedule';
|
|
43682
|
-
}
|
|
43683
|
-
// verify the required parameter 'weekId' is set
|
|
43684
|
-
if (weekId === undefined || weekId === null) {
|
|
43685
|
-
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekScheduleReschedule';
|
|
43686
|
-
}
|
|
43687
|
-
// verify the required parameter 'scheduleId' is set
|
|
43688
|
-
if (scheduleId === undefined || scheduleId === null) {
|
|
43689
|
-
throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementManagementunitWeekScheduleReschedule';
|
|
43690
|
-
}
|
|
43691
|
-
|
|
43692
|
-
return this.apiClient.callApi(
|
|
43693
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/{scheduleId}/reschedule',
|
|
43694
|
-
'POST',
|
|
43695
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
43696
|
-
{ },
|
|
43697
|
-
{ },
|
|
43698
|
-
{ },
|
|
43699
|
-
null,
|
|
43700
|
-
['PureCloud OAuth'],
|
|
43701
|
-
['application/json'],
|
|
43702
|
-
['application/json']
|
|
43703
|
-
);
|
|
43704
|
-
}
|
|
43705
|
-
|
|
43706
|
-
/**
|
|
43707
|
-
* Gone. Scheduling has moved under business units
|
|
43708
|
-
*
|
|
43709
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
43710
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
43711
|
-
*/
|
|
43712
|
-
postWorkforcemanagementManagementunitWeekSchedules(managementUnitId, weekId) {
|
|
43713
|
-
// verify the required parameter 'managementUnitId' is set
|
|
43714
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
43715
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekSchedules';
|
|
43716
|
-
}
|
|
43717
|
-
// verify the required parameter 'weekId' is set
|
|
43718
|
-
if (weekId === undefined || weekId === null) {
|
|
43719
|
-
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekSchedules';
|
|
43720
|
-
}
|
|
43721
|
-
|
|
43722
|
-
return this.apiClient.callApi(
|
|
43723
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules',
|
|
43724
|
-
'POST',
|
|
43725
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId },
|
|
43726
|
-
{ },
|
|
43727
|
-
{ },
|
|
43728
|
-
{ },
|
|
43729
|
-
null,
|
|
43730
|
-
['PureCloud OAuth'],
|
|
43731
|
-
['application/json'],
|
|
43732
|
-
['application/json']
|
|
43733
|
-
);
|
|
43734
|
-
}
|
|
43735
|
-
|
|
43736
|
-
/**
|
|
43737
|
-
* Gone. Scheduling has moved under business units
|
|
43738
|
-
*
|
|
43739
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
43740
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
43741
|
-
*/
|
|
43742
|
-
postWorkforcemanagementManagementunitWeekSchedulesGenerate(managementUnitId, weekId) {
|
|
43743
|
-
// verify the required parameter 'managementUnitId' is set
|
|
43744
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
43745
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekSchedulesGenerate';
|
|
43746
|
-
}
|
|
43747
|
-
// verify the required parameter 'weekId' is set
|
|
43748
|
-
if (weekId === undefined || weekId === null) {
|
|
43749
|
-
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekSchedulesGenerate';
|
|
43750
|
-
}
|
|
43751
|
-
|
|
43752
|
-
return this.apiClient.callApi(
|
|
43753
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/generate',
|
|
43754
|
-
'POST',
|
|
43755
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId },
|
|
43756
|
-
{ },
|
|
43757
|
-
{ },
|
|
43758
|
-
{ },
|
|
43759
|
-
null,
|
|
43760
|
-
['PureCloud OAuth'],
|
|
43761
|
-
['application/json'],
|
|
43762
|
-
['application/json']
|
|
43763
|
-
);
|
|
43764
|
-
}
|
|
43765
|
-
|
|
43766
|
-
/**
|
|
43767
|
-
* Gone. Scheduling has moved under business units
|
|
43768
|
-
*
|
|
43769
|
-
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
43770
|
-
* @param {String} weekId First day of schedule week in yyyy-MM-dd format.
|
|
43771
|
-
*/
|
|
43772
|
-
postWorkforcemanagementManagementunitWeekSchedulesPartialupload(managementUnitId, weekId) {
|
|
43773
|
-
// verify the required parameter 'managementUnitId' is set
|
|
43774
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
43775
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekSchedulesPartialupload';
|
|
43776
|
-
}
|
|
43777
|
-
// verify the required parameter 'weekId' is set
|
|
43778
|
-
if (weekId === undefined || weekId === null) {
|
|
43779
|
-
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementManagementunitWeekSchedulesPartialupload';
|
|
43780
|
-
}
|
|
43781
|
-
|
|
43782
|
-
return this.apiClient.callApi(
|
|
43783
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekId}/schedules/partialupload',
|
|
43784
|
-
'POST',
|
|
43785
|
-
{ 'managementUnitId': managementUnitId,'weekId': weekId },
|
|
43786
|
-
{ },
|
|
43787
|
-
{ },
|
|
43788
|
-
{ },
|
|
43789
|
-
null,
|
|
43790
|
-
['PureCloud OAuth'],
|
|
43791
|
-
['application/json'],
|
|
43792
|
-
['application/json']
|
|
43793
|
-
);
|
|
43794
|
-
}
|
|
43795
|
-
|
|
43796
43018
|
/**
|
|
43797
43019
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
43798
43020
|
*
|
|
@@ -43943,94 +43165,33 @@ class WorkforceManagementApi {
|
|
|
43943
43165
|
}
|
|
43944
43166
|
|
|
43945
43167
|
/**
|
|
43946
|
-
*
|
|
43947
|
-
*
|
|
43948
|
-
* @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
|
|
43949
|
-
* @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
|
|
43950
|
-
* @param {String} forecastId (Gone/Deprecated): The ID of the forecast
|
|
43951
|
-
*/
|
|
43952
|
-
postWorkforcemanagementManagementunitWeekShorttermforecastCopy(managementUnitId, weekDateId, forecastId) {
|
|
43953
|
-
// verify the required parameter 'managementUnitId' is set
|
|
43954
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
43955
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastCopy';
|
|
43956
|
-
}
|
|
43957
|
-
// verify the required parameter 'weekDateId' is set
|
|
43958
|
-
if (weekDateId === undefined || weekDateId === null) {
|
|
43959
|
-
throw 'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastCopy';
|
|
43960
|
-
}
|
|
43961
|
-
// verify the required parameter 'forecastId' is set
|
|
43962
|
-
if (forecastId === undefined || forecastId === null) {
|
|
43963
|
-
throw 'Missing the required parameter "forecastId" when calling postWorkforcemanagementManagementunitWeekShorttermforecastCopy';
|
|
43964
|
-
}
|
|
43965
|
-
|
|
43966
|
-
return this.apiClient.callApi(
|
|
43967
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/copy',
|
|
43968
|
-
'POST',
|
|
43969
|
-
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
|
|
43970
|
-
{ },
|
|
43971
|
-
{ },
|
|
43972
|
-
{ },
|
|
43973
|
-
null,
|
|
43974
|
-
['PureCloud OAuth'],
|
|
43975
|
-
['application/json'],
|
|
43976
|
-
['application/json']
|
|
43977
|
-
);
|
|
43978
|
-
}
|
|
43979
|
-
|
|
43980
|
-
/**
|
|
43981
|
-
* Gone. Use equivalent business unit resource instead
|
|
43982
|
-
*
|
|
43983
|
-
* @param {String} managementUnitId (Deprecated/gone): The id of the management unit.
|
|
43984
|
-
* @param {String} weekDateId (Deprecated/gone): The week start date of the forecast in yyyy-MM-dd format
|
|
43985
|
-
*/
|
|
43986
|
-
postWorkforcemanagementManagementunitWeekShorttermforecasts(managementUnitId, weekDateId) {
|
|
43987
|
-
// verify the required parameter 'managementUnitId' is set
|
|
43988
|
-
if (managementUnitId === undefined || managementUnitId === null) {
|
|
43989
|
-
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWeekShorttermforecasts';
|
|
43990
|
-
}
|
|
43991
|
-
// verify the required parameter 'weekDateId' is set
|
|
43992
|
-
if (weekDateId === undefined || weekDateId === null) {
|
|
43993
|
-
throw 'Missing the required parameter "weekDateId" when calling postWorkforcemanagementManagementunitWeekShorttermforecasts';
|
|
43994
|
-
}
|
|
43995
|
-
|
|
43996
|
-
return this.apiClient.callApi(
|
|
43997
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shorttermforecasts',
|
|
43998
|
-
'POST',
|
|
43999
|
-
{ 'managementUnitId': managementUnitId,'weekDateId': weekDateId },
|
|
44000
|
-
{ },
|
|
44001
|
-
{ },
|
|
44002
|
-
{ },
|
|
44003
|
-
null,
|
|
44004
|
-
['PureCloud OAuth'],
|
|
44005
|
-
['application/json'],
|
|
44006
|
-
['application/json']
|
|
44007
|
-
);
|
|
44008
|
-
}
|
|
44009
|
-
|
|
44010
|
-
/**
|
|
44011
|
-
* Gone. Use equivalent business unit resource instead
|
|
43168
|
+
* Create a copy of work plan
|
|
44012
43169
|
*
|
|
44013
|
-
* @param {String} managementUnitId
|
|
44014
|
-
* @param {String}
|
|
43170
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
43171
|
+
* @param {String} workPlanId The ID of the work plan to create a copy
|
|
43172
|
+
* @param {Object} opts Optional parameters
|
|
43173
|
+
* @param {Object} opts.body body
|
|
44015
43174
|
*/
|
|
44016
|
-
|
|
43175
|
+
postWorkforcemanagementManagementunitWorkplanCopy(managementUnitId, workPlanId, opts) {
|
|
43176
|
+
opts = opts || {};
|
|
43177
|
+
|
|
44017
43178
|
// verify the required parameter 'managementUnitId' is set
|
|
44018
43179
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
44019
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
43180
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
|
|
44020
43181
|
}
|
|
44021
|
-
// verify the required parameter '
|
|
44022
|
-
if (
|
|
44023
|
-
throw 'Missing the required parameter "
|
|
43182
|
+
// verify the required parameter 'workPlanId' is set
|
|
43183
|
+
if (workPlanId === undefined || workPlanId === null) {
|
|
43184
|
+
throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
|
|
44024
43185
|
}
|
|
44025
43186
|
|
|
44026
43187
|
return this.apiClient.callApi(
|
|
44027
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
43188
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy',
|
|
44028
43189
|
'POST',
|
|
44029
|
-
{ 'managementUnitId': managementUnitId,'
|
|
43190
|
+
{ 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
|
|
44030
43191
|
{ },
|
|
44031
43192
|
{ },
|
|
44032
43193
|
{ },
|
|
44033
|
-
|
|
43194
|
+
opts['body'],
|
|
44034
43195
|
['PureCloud OAuth'],
|
|
44035
43196
|
['application/json'],
|
|
44036
43197
|
['application/json']
|
|
@@ -44038,29 +43199,34 @@ class WorkforceManagementApi {
|
|
|
44038
43199
|
}
|
|
44039
43200
|
|
|
44040
43201
|
/**
|
|
44041
|
-
*
|
|
43202
|
+
* Validate Work Plan
|
|
44042
43203
|
*
|
|
44043
|
-
* @param {String} managementUnitId
|
|
44044
|
-
* @param {String}
|
|
43204
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
43205
|
+
* @param {String} workPlanId The ID of the work plan to validate. For new work plan, use the word 'new' for the ID.
|
|
43206
|
+
* @param {Object} opts Optional parameters
|
|
43207
|
+
* @param {Object} opts.body body
|
|
43208
|
+
* @param {Array.<String>} opts.expand
|
|
44045
43209
|
*/
|
|
44046
|
-
|
|
43210
|
+
postWorkforcemanagementManagementunitWorkplanValidate(managementUnitId, workPlanId, opts) {
|
|
43211
|
+
opts = opts || {};
|
|
43212
|
+
|
|
44047
43213
|
// verify the required parameter 'managementUnitId' is set
|
|
44048
43214
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
44049
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
43215
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
|
|
44050
43216
|
}
|
|
44051
|
-
// verify the required parameter '
|
|
44052
|
-
if (
|
|
44053
|
-
throw 'Missing the required parameter "
|
|
43217
|
+
// verify the required parameter 'workPlanId' is set
|
|
43218
|
+
if (workPlanId === undefined || workPlanId === null) {
|
|
43219
|
+
throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
|
|
44054
43220
|
}
|
|
44055
43221
|
|
|
44056
43222
|
return this.apiClient.callApi(
|
|
44057
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
43223
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate',
|
|
44058
43224
|
'POST',
|
|
44059
|
-
{ 'managementUnitId': managementUnitId,'
|
|
44060
|
-
{
|
|
43225
|
+
{ 'managementUnitId': managementUnitId,'workPlanId': workPlanId },
|
|
43226
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
44061
43227
|
{ },
|
|
44062
43228
|
{ },
|
|
44063
|
-
|
|
43229
|
+
opts['body'],
|
|
44064
43230
|
['PureCloud OAuth'],
|
|
44065
43231
|
['application/json'],
|
|
44066
43232
|
['application/json']
|
|
@@ -44068,29 +43234,29 @@ class WorkforceManagementApi {
|
|
|
44068
43234
|
}
|
|
44069
43235
|
|
|
44070
43236
|
/**
|
|
44071
|
-
* Create a copy of work plan
|
|
43237
|
+
* Create a copy of work plan rotation
|
|
44072
43238
|
*
|
|
44073
43239
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
44074
|
-
* @param {String}
|
|
43240
|
+
* @param {String} workPlanRotationId The ID of the work plan rotation to create a copy
|
|
44075
43241
|
* @param {Object} opts Optional parameters
|
|
44076
43242
|
* @param {Object} opts.body body
|
|
44077
43243
|
*/
|
|
44078
|
-
|
|
43244
|
+
postWorkforcemanagementManagementunitWorkplanrotationCopy(managementUnitId, workPlanRotationId, opts) {
|
|
44079
43245
|
opts = opts || {};
|
|
44080
43246
|
|
|
44081
43247
|
// verify the required parameter 'managementUnitId' is set
|
|
44082
43248
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
44083
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
43249
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
|
|
44084
43250
|
}
|
|
44085
|
-
// verify the required parameter '
|
|
44086
|
-
if (
|
|
44087
|
-
throw 'Missing the required parameter "
|
|
43251
|
+
// verify the required parameter 'workPlanRotationId' is set
|
|
43252
|
+
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
43253
|
+
throw 'Missing the required parameter "workPlanRotationId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
|
|
44088
43254
|
}
|
|
44089
43255
|
|
|
44090
43256
|
return this.apiClient.callApi(
|
|
44091
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
43257
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy',
|
|
44092
43258
|
'POST',
|
|
44093
|
-
{ 'managementUnitId': managementUnitId,'
|
|
43259
|
+
{ 'managementUnitId': managementUnitId,'workPlanRotationId': workPlanRotationId },
|
|
44094
43260
|
{ },
|
|
44095
43261
|
{ },
|
|
44096
43262
|
{ },
|
|
@@ -44102,31 +43268,25 @@ class WorkforceManagementApi {
|
|
|
44102
43268
|
}
|
|
44103
43269
|
|
|
44104
43270
|
/**
|
|
44105
|
-
*
|
|
43271
|
+
* Create a new work plan rotation
|
|
44106
43272
|
*
|
|
44107
43273
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
44108
|
-
* @param {String} workPlanId The ID of the work plan to validate. For new work plan, use the word 'new' for the ID.
|
|
44109
43274
|
* @param {Object} opts Optional parameters
|
|
44110
43275
|
* @param {Object} opts.body body
|
|
44111
|
-
* @param {Array.<String>} opts.expand
|
|
44112
43276
|
*/
|
|
44113
|
-
|
|
43277
|
+
postWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, opts) {
|
|
44114
43278
|
opts = opts || {};
|
|
44115
43279
|
|
|
44116
43280
|
// verify the required parameter 'managementUnitId' is set
|
|
44117
43281
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
44118
|
-
throw 'Missing the required parameter "managementUnitId" when calling
|
|
44119
|
-
}
|
|
44120
|
-
// verify the required parameter 'workPlanId' is set
|
|
44121
|
-
if (workPlanId === undefined || workPlanId === null) {
|
|
44122
|
-
throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
|
|
43282
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotations';
|
|
44123
43283
|
}
|
|
44124
43284
|
|
|
44125
43285
|
return this.apiClient.callApi(
|
|
44126
|
-
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/
|
|
43286
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
|
|
44127
43287
|
'POST',
|
|
44128
|
-
{ 'managementUnitId': managementUnitId
|
|
44129
|
-
{
|
|
43288
|
+
{ 'managementUnitId': managementUnitId },
|
|
43289
|
+
{ },
|
|
44130
43290
|
{ },
|
|
44131
43291
|
{ },
|
|
44132
43292
|
opts['body'],
|
|
@@ -44142,6 +43302,7 @@ class WorkforceManagementApi {
|
|
|
44142
43302
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
44143
43303
|
* @param {Object} opts Optional parameters
|
|
44144
43304
|
* @param {Object} opts.body body
|
|
43305
|
+
* @param {Object} opts.validationMode Allows to create work plan even if the validation result is invalid
|
|
44145
43306
|
*/
|
|
44146
43307
|
postWorkforcemanagementManagementunitWorkplans(managementUnitId, opts) {
|
|
44147
43308
|
opts = opts || {};
|
|
@@ -44155,7 +43316,7 @@ class WorkforceManagementApi {
|
|
|
44155
43316
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans',
|
|
44156
43317
|
'POST',
|
|
44157
43318
|
{ 'managementUnitId': managementUnitId },
|
|
44158
|
-
{
|
|
43319
|
+
{ 'validationMode': opts['validationMode'] },
|
|
44159
43320
|
{ },
|
|
44160
43321
|
{ },
|
|
44161
43322
|
opts['body'],
|
|
@@ -44292,7 +43453,7 @@ class WorkforceManagementApi {
|
|
|
44292
43453
|
* </pre>
|
|
44293
43454
|
* </p>
|
|
44294
43455
|
* @module purecloud-platform-client-v2/index
|
|
44295
|
-
* @version
|
|
43456
|
+
* @version 98.0.0
|
|
44296
43457
|
*/
|
|
44297
43458
|
class platformClient {
|
|
44298
43459
|
constructor() {
|
|
@@ -44551,11 +43712,6 @@ class platformClient {
|
|
|
44551
43712
|
* @property {module:purecloud-platform-client-v2/api/UsageApi}
|
|
44552
43713
|
*/
|
|
44553
43714
|
this.UsageApi = UsageApi;
|
|
44554
|
-
/**
|
|
44555
|
-
* The UserDevelopmentApi service constructor.
|
|
44556
|
-
* @property {module:purecloud-platform-client-v2/api/UserDevelopmentApi}
|
|
44557
|
-
*/
|
|
44558
|
-
this.UserDevelopmentApi = UserDevelopmentApi;
|
|
44559
43715
|
/**
|
|
44560
43716
|
* The UserRecordingsApi service constructor.
|
|
44561
43717
|
* @property {module:purecloud-platform-client-v2/api/UserRecordingsApi}
|