purecloud-platform-client-v2 134.0.1 → 135.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 +215 -172
- package/dist/web-amd/purecloud-platform-client-v2.js +215 -172
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +215 -172
- package/dist/web-cjs/purecloud-platform-client-v2.js +215 -172
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +395 -207
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +3 -3
- 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/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +26 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -51
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +5 -3
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +69 -3
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +51 -51
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -395,7 +395,7 @@ class Configuration {
|
|
|
395
395
|
|
|
396
396
|
/**
|
|
397
397
|
* @module purecloud-platform-client-v2/ApiClient
|
|
398
|
-
* @version
|
|
398
|
+
* @version 135.0.0
|
|
399
399
|
*/
|
|
400
400
|
class ApiClient {
|
|
401
401
|
/**
|
|
@@ -1342,7 +1342,7 @@ class ApiClient {
|
|
|
1342
1342
|
|
|
1343
1343
|
// set header parameters
|
|
1344
1344
|
request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
|
|
1345
|
-
//request.set({ 'purecloud-sdk': '
|
|
1345
|
+
//request.set({ 'purecloud-sdk': '135.0.0' });
|
|
1346
1346
|
|
|
1347
1347
|
// set request timeout
|
|
1348
1348
|
request.timeout(that.timeout);
|
|
@@ -1442,7 +1442,7 @@ class AlertingApi {
|
|
|
1442
1442
|
/**
|
|
1443
1443
|
* Alerting service.
|
|
1444
1444
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1445
|
-
* @version
|
|
1445
|
+
* @version 135.0.0
|
|
1446
1446
|
*/
|
|
1447
1447
|
|
|
1448
1448
|
/**
|
|
@@ -1756,7 +1756,7 @@ class AnalyticsApi {
|
|
|
1756
1756
|
/**
|
|
1757
1757
|
* Analytics service.
|
|
1758
1758
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1759
|
-
* @version
|
|
1759
|
+
* @version 135.0.0
|
|
1760
1760
|
*/
|
|
1761
1761
|
|
|
1762
1762
|
/**
|
|
@@ -2938,7 +2938,7 @@ class ArchitectApi {
|
|
|
2938
2938
|
/**
|
|
2939
2939
|
* Architect service.
|
|
2940
2940
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2941
|
-
* @version
|
|
2941
|
+
* @version 135.0.0
|
|
2942
2942
|
*/
|
|
2943
2943
|
|
|
2944
2944
|
/**
|
|
@@ -5934,7 +5934,7 @@ class AuditApi {
|
|
|
5934
5934
|
/**
|
|
5935
5935
|
* Audit service.
|
|
5936
5936
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
5937
|
-
* @version
|
|
5937
|
+
* @version 135.0.0
|
|
5938
5938
|
*/
|
|
5939
5939
|
|
|
5940
5940
|
/**
|
|
@@ -6105,7 +6105,7 @@ class AuthorizationApi {
|
|
|
6105
6105
|
/**
|
|
6106
6106
|
* Authorization service.
|
|
6107
6107
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6108
|
-
* @version
|
|
6108
|
+
* @version 135.0.0
|
|
6109
6109
|
*/
|
|
6110
6110
|
|
|
6111
6111
|
/**
|
|
@@ -7288,7 +7288,7 @@ class BillingApi {
|
|
|
7288
7288
|
/**
|
|
7289
7289
|
* Billing service.
|
|
7290
7290
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7291
|
-
* @version
|
|
7291
|
+
* @version 135.0.0
|
|
7292
7292
|
*/
|
|
7293
7293
|
|
|
7294
7294
|
/**
|
|
@@ -7368,7 +7368,7 @@ class ChatApi {
|
|
|
7368
7368
|
/**
|
|
7369
7369
|
* Chat service.
|
|
7370
7370
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7371
|
-
* @version
|
|
7371
|
+
* @version 135.0.0
|
|
7372
7372
|
*/
|
|
7373
7373
|
|
|
7374
7374
|
/**
|
|
@@ -7459,7 +7459,7 @@ class CoachingApi {
|
|
|
7459
7459
|
/**
|
|
7460
7460
|
* Coaching service.
|
|
7461
7461
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7462
|
-
* @version
|
|
7462
|
+
* @version 135.0.0
|
|
7463
7463
|
*/
|
|
7464
7464
|
|
|
7465
7465
|
/**
|
|
@@ -8036,7 +8036,7 @@ class ContentManagementApi {
|
|
|
8036
8036
|
/**
|
|
8037
8037
|
* ContentManagement service.
|
|
8038
8038
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8039
|
-
* @version
|
|
8039
|
+
* @version 135.0.0
|
|
8040
8040
|
*/
|
|
8041
8041
|
|
|
8042
8042
|
/**
|
|
@@ -9176,7 +9176,7 @@ class ConversationsApi {
|
|
|
9176
9176
|
/**
|
|
9177
9177
|
* Conversations service.
|
|
9178
9178
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9179
|
-
* @version
|
|
9179
|
+
* @version 135.0.0
|
|
9180
9180
|
*/
|
|
9181
9181
|
|
|
9182
9182
|
/**
|
|
@@ -11081,7 +11081,7 @@ class ConversationsApi {
|
|
|
11081
11081
|
/**
|
|
11082
11082
|
* Get a list of Messaging Stickers
|
|
11083
11083
|
*
|
|
11084
|
-
* @param {
|
|
11084
|
+
* @param {Object} messengerType Messenger Type
|
|
11085
11085
|
* @param {Object} opts Optional parameters
|
|
11086
11086
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
11087
11087
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
@@ -11269,7 +11269,7 @@ class ConversationsApi {
|
|
|
11269
11269
|
}
|
|
11270
11270
|
|
|
11271
11271
|
/**
|
|
11272
|
-
* Update a conversation by setting
|
|
11272
|
+
* Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
11273
11273
|
*
|
|
11274
11274
|
* @param {String} conversationId conversationId
|
|
11275
11275
|
* @param {Object} body Conversation
|
|
@@ -13840,7 +13840,7 @@ class DataExtensionsApi {
|
|
|
13840
13840
|
/**
|
|
13841
13841
|
* DataExtensions service.
|
|
13842
13842
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
13843
|
-
* @version
|
|
13843
|
+
* @version 135.0.0
|
|
13844
13844
|
*/
|
|
13845
13845
|
|
|
13846
13846
|
/**
|
|
@@ -13926,7 +13926,7 @@ class ExternalContactsApi {
|
|
|
13926
13926
|
/**
|
|
13927
13927
|
* ExternalContacts service.
|
|
13928
13928
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
13929
|
-
* @version
|
|
13929
|
+
* @version 135.0.0
|
|
13930
13930
|
*/
|
|
13931
13931
|
|
|
13932
13932
|
/**
|
|
@@ -15669,7 +15669,7 @@ class FaxApi {
|
|
|
15669
15669
|
/**
|
|
15670
15670
|
* Fax service.
|
|
15671
15671
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
15672
|
-
* @version
|
|
15672
|
+
* @version 135.0.0
|
|
15673
15673
|
*/
|
|
15674
15674
|
|
|
15675
15675
|
/**
|
|
@@ -15840,7 +15840,7 @@ class FlowsApi {
|
|
|
15840
15840
|
/**
|
|
15841
15841
|
* Flows service.
|
|
15842
15842
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
15843
|
-
* @version
|
|
15843
|
+
* @version 135.0.0
|
|
15844
15844
|
*/
|
|
15845
15845
|
|
|
15846
15846
|
/**
|
|
@@ -15911,7 +15911,7 @@ class GamificationApi {
|
|
|
15911
15911
|
/**
|
|
15912
15912
|
* Gamification service.
|
|
15913
15913
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
15914
|
-
* @version
|
|
15914
|
+
* @version 135.0.0
|
|
15915
15915
|
*/
|
|
15916
15916
|
|
|
15917
15917
|
/**
|
|
@@ -17341,7 +17341,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
17341
17341
|
/**
|
|
17342
17342
|
* GeneralDataProtectionRegulation service.
|
|
17343
17343
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
17344
|
-
* @version
|
|
17344
|
+
* @version 135.0.0
|
|
17345
17345
|
*/
|
|
17346
17346
|
|
|
17347
17347
|
/**
|
|
@@ -17471,7 +17471,7 @@ class GeolocationApi {
|
|
|
17471
17471
|
/**
|
|
17472
17472
|
* Geolocation service.
|
|
17473
17473
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
17474
|
-
* @version
|
|
17474
|
+
* @version 135.0.0
|
|
17475
17475
|
*/
|
|
17476
17476
|
|
|
17477
17477
|
/**
|
|
@@ -17602,7 +17602,7 @@ class GreetingsApi {
|
|
|
17602
17602
|
/**
|
|
17603
17603
|
* Greetings service.
|
|
17604
17604
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
17605
|
-
* @version
|
|
17605
|
+
* @version 135.0.0
|
|
17606
17606
|
*/
|
|
17607
17607
|
|
|
17608
17608
|
/**
|
|
@@ -18057,7 +18057,7 @@ class GroupsApi {
|
|
|
18057
18057
|
/**
|
|
18058
18058
|
* Groups service.
|
|
18059
18059
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
18060
|
-
* @version
|
|
18060
|
+
* @version 135.0.0
|
|
18061
18061
|
*/
|
|
18062
18062
|
|
|
18063
18063
|
/**
|
|
@@ -18462,7 +18462,7 @@ class IdentityProviderApi {
|
|
|
18462
18462
|
/**
|
|
18463
18463
|
* IdentityProvider service.
|
|
18464
18464
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
18465
|
-
* @version
|
|
18465
|
+
* @version 135.0.0
|
|
18466
18466
|
*/
|
|
18467
18467
|
|
|
18468
18468
|
/**
|
|
@@ -19218,7 +19218,7 @@ class IntegrationsApi {
|
|
|
19218
19218
|
/**
|
|
19219
19219
|
* Integrations service.
|
|
19220
19220
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
19221
|
-
* @version
|
|
19221
|
+
* @version 135.0.0
|
|
19222
19222
|
*/
|
|
19223
19223
|
|
|
19224
19224
|
/**
|
|
@@ -20893,7 +20893,7 @@ class JourneyApi {
|
|
|
20893
20893
|
/**
|
|
20894
20894
|
* Journey service.
|
|
20895
20895
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
20896
|
-
* @version
|
|
20896
|
+
* @version 135.0.0
|
|
20897
20897
|
*/
|
|
20898
20898
|
|
|
20899
20899
|
/**
|
|
@@ -21604,7 +21604,7 @@ class KnowledgeApi {
|
|
|
21604
21604
|
/**
|
|
21605
21605
|
* Knowledge service.
|
|
21606
21606
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
21607
|
-
* @version
|
|
21607
|
+
* @version 135.0.0
|
|
21608
21608
|
*/
|
|
21609
21609
|
|
|
21610
21610
|
/**
|
|
@@ -22504,7 +22504,7 @@ class LanguageUnderstandingApi {
|
|
|
22504
22504
|
/**
|
|
22505
22505
|
* LanguageUnderstanding service.
|
|
22506
22506
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
22507
|
-
* @version
|
|
22507
|
+
* @version 135.0.0
|
|
22508
22508
|
*/
|
|
22509
22509
|
|
|
22510
22510
|
/**
|
|
@@ -23408,7 +23408,7 @@ class LanguagesApi {
|
|
|
23408
23408
|
/**
|
|
23409
23409
|
* Languages service.
|
|
23410
23410
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
23411
|
-
* @version
|
|
23411
|
+
* @version 135.0.0
|
|
23412
23412
|
*/
|
|
23413
23413
|
|
|
23414
23414
|
/**
|
|
@@ -23676,7 +23676,7 @@ class LearningApi {
|
|
|
23676
23676
|
/**
|
|
23677
23677
|
* Learning service.
|
|
23678
23678
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
23679
|
-
* @version
|
|
23679
|
+
* @version 135.0.0
|
|
23680
23680
|
*/
|
|
23681
23681
|
|
|
23682
23682
|
/**
|
|
@@ -24267,7 +24267,7 @@ class LicenseApi {
|
|
|
24267
24267
|
/**
|
|
24268
24268
|
* License service.
|
|
24269
24269
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
24270
|
-
* @version
|
|
24270
|
+
* @version 135.0.0
|
|
24271
24271
|
*/
|
|
24272
24272
|
|
|
24273
24273
|
/**
|
|
@@ -24505,7 +24505,7 @@ class LocationsApi {
|
|
|
24505
24505
|
/**
|
|
24506
24506
|
* Locations service.
|
|
24507
24507
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
24508
|
-
* @version
|
|
24508
|
+
* @version 135.0.0
|
|
24509
24509
|
*/
|
|
24510
24510
|
|
|
24511
24511
|
/**
|
|
@@ -24741,7 +24741,7 @@ class MessagingApi {
|
|
|
24741
24741
|
/**
|
|
24742
24742
|
* Messaging service.
|
|
24743
24743
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
24744
|
-
* @version
|
|
24744
|
+
* @version 135.0.0
|
|
24745
24745
|
*/
|
|
24746
24746
|
|
|
24747
24747
|
/**
|
|
@@ -24892,7 +24892,7 @@ class MobileDevicesApi {
|
|
|
24892
24892
|
/**
|
|
24893
24893
|
* MobileDevices service.
|
|
24894
24894
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
24895
|
-
* @version
|
|
24895
|
+
* @version 135.0.0
|
|
24896
24896
|
*/
|
|
24897
24897
|
|
|
24898
24898
|
/**
|
|
@@ -25043,7 +25043,7 @@ class NotificationsApi {
|
|
|
25043
25043
|
/**
|
|
25044
25044
|
* Notifications service.
|
|
25045
25045
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
25046
|
-
* @version
|
|
25046
|
+
* @version 135.0.0
|
|
25047
25047
|
*/
|
|
25048
25048
|
|
|
25049
25049
|
/**
|
|
@@ -25268,7 +25268,7 @@ class OAuthApi {
|
|
|
25268
25268
|
/**
|
|
25269
25269
|
* OAuth service.
|
|
25270
25270
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
25271
|
-
* @version
|
|
25271
|
+
* @version 135.0.0
|
|
25272
25272
|
*/
|
|
25273
25273
|
|
|
25274
25274
|
/**
|
|
@@ -25634,7 +25634,7 @@ class ObjectsApi {
|
|
|
25634
25634
|
/**
|
|
25635
25635
|
* Objects service.
|
|
25636
25636
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
25637
|
-
* @version
|
|
25637
|
+
* @version 135.0.0
|
|
25638
25638
|
*/
|
|
25639
25639
|
|
|
25640
25640
|
/**
|
|
@@ -25905,7 +25905,7 @@ class OrganizationApi {
|
|
|
25905
25905
|
/**
|
|
25906
25906
|
* Organization service.
|
|
25907
25907
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
25908
|
-
* @version
|
|
25908
|
+
* @version 135.0.0
|
|
25909
25909
|
*/
|
|
25910
25910
|
|
|
25911
25911
|
/**
|
|
@@ -26308,7 +26308,7 @@ class OrganizationAuthorizationApi {
|
|
|
26308
26308
|
/**
|
|
26309
26309
|
* OrganizationAuthorization service.
|
|
26310
26310
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
26311
|
-
* @version
|
|
26311
|
+
* @version 135.0.0
|
|
26312
26312
|
*/
|
|
26313
26313
|
|
|
26314
26314
|
/**
|
|
@@ -27233,7 +27233,7 @@ class OutboundApi {
|
|
|
27233
27233
|
/**
|
|
27234
27234
|
* Outbound service.
|
|
27235
27235
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
27236
|
-
* @version
|
|
27236
|
+
* @version 135.0.0
|
|
27237
27237
|
*/
|
|
27238
27238
|
|
|
27239
27239
|
/**
|
|
@@ -27583,6 +27583,31 @@ class OutboundApi {
|
|
|
27583
27583
|
);
|
|
27584
27584
|
}
|
|
27585
27585
|
|
|
27586
|
+
/**
|
|
27587
|
+
* Reset messaging campaign progress and recycle the messaging campaign
|
|
27588
|
+
*
|
|
27589
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
27590
|
+
*/
|
|
27591
|
+
deleteOutboundMessagingcampaignProgress(messagingCampaignId) {
|
|
27592
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
27593
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
27594
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling deleteOutboundMessagingcampaignProgress';
|
|
27595
|
+
}
|
|
27596
|
+
|
|
27597
|
+
return this.apiClient.callApi(
|
|
27598
|
+
'/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress',
|
|
27599
|
+
'DELETE',
|
|
27600
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
27601
|
+
{ },
|
|
27602
|
+
{ },
|
|
27603
|
+
{ },
|
|
27604
|
+
null,
|
|
27605
|
+
['PureCloud OAuth'],
|
|
27606
|
+
['application/json'],
|
|
27607
|
+
['application/json']
|
|
27608
|
+
);
|
|
27609
|
+
}
|
|
27610
|
+
|
|
27586
27611
|
/**
|
|
27587
27612
|
* Delete a Rule Set.
|
|
27588
27613
|
*
|
|
@@ -30263,7 +30288,7 @@ class PresenceApi {
|
|
|
30263
30288
|
/**
|
|
30264
30289
|
* Presence service.
|
|
30265
30290
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
30266
|
-
* @version
|
|
30291
|
+
* @version 135.0.0
|
|
30267
30292
|
*/
|
|
30268
30293
|
|
|
30269
30294
|
/**
|
|
@@ -30409,31 +30434,6 @@ class PresenceApi {
|
|
|
30409
30434
|
);
|
|
30410
30435
|
}
|
|
30411
30436
|
|
|
30412
|
-
/**
|
|
30413
|
-
* Get a user's Microsoft Teams presence.
|
|
30414
|
-
* Gets the presence for a Microsoft Teams user. This will return the Microsoft Teams presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.
|
|
30415
|
-
* @param {String} userId user Id
|
|
30416
|
-
*/
|
|
30417
|
-
getUserPresencesMicrosoftteams(userId) {
|
|
30418
|
-
// verify the required parameter 'userId' is set
|
|
30419
|
-
if (userId === undefined || userId === null) {
|
|
30420
|
-
throw 'Missing the required parameter "userId" when calling getUserPresencesMicrosoftteams';
|
|
30421
|
-
}
|
|
30422
|
-
|
|
30423
|
-
return this.apiClient.callApi(
|
|
30424
|
-
'/api/v2/users/{userId}/presences/microsoftteams',
|
|
30425
|
-
'GET',
|
|
30426
|
-
{ 'userId': userId },
|
|
30427
|
-
{ },
|
|
30428
|
-
{ },
|
|
30429
|
-
{ },
|
|
30430
|
-
null,
|
|
30431
|
-
['PureCloud OAuth'],
|
|
30432
|
-
['application/json'],
|
|
30433
|
-
['application/json']
|
|
30434
|
-
);
|
|
30435
|
-
}
|
|
30436
|
-
|
|
30437
30437
|
/**
|
|
30438
30438
|
* Get a user's Genesys Cloud presence.
|
|
30439
30439
|
* Get the default Genesys Cloud user presence source PURECLOUD
|
|
@@ -30459,31 +30459,6 @@ class PresenceApi {
|
|
|
30459
30459
|
);
|
|
30460
30460
|
}
|
|
30461
30461
|
|
|
30462
|
-
/**
|
|
30463
|
-
* Get a user's Zoom Phone presence.
|
|
30464
|
-
* Gets the presence for a Zoom user. This will return the Zoom Phone presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.
|
|
30465
|
-
* @param {String} userId user Id
|
|
30466
|
-
*/
|
|
30467
|
-
getUserPresencesZoomphone(userId) {
|
|
30468
|
-
// verify the required parameter 'userId' is set
|
|
30469
|
-
if (userId === undefined || userId === null) {
|
|
30470
|
-
throw 'Missing the required parameter "userId" when calling getUserPresencesZoomphone';
|
|
30471
|
-
}
|
|
30472
|
-
|
|
30473
|
-
return this.apiClient.callApi(
|
|
30474
|
-
'/api/v2/users/{userId}/presences/zoomphone',
|
|
30475
|
-
'GET',
|
|
30476
|
-
{ 'userId': userId },
|
|
30477
|
-
{ },
|
|
30478
|
-
{ },
|
|
30479
|
-
{ },
|
|
30480
|
-
null,
|
|
30481
|
-
['PureCloud OAuth'],
|
|
30482
|
-
['application/json'],
|
|
30483
|
-
['application/json']
|
|
30484
|
-
);
|
|
30485
|
-
}
|
|
30486
|
-
|
|
30487
30462
|
/**
|
|
30488
30463
|
* Patch a user's Presence
|
|
30489
30464
|
* Patch a user's presence for the specified source that is not specifically listed. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
|
|
@@ -30635,7 +30610,7 @@ class QualityApi {
|
|
|
30635
30610
|
/**
|
|
30636
30611
|
* Quality service.
|
|
30637
30612
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
30638
|
-
* @version
|
|
30613
|
+
* @version 135.0.0
|
|
30639
30614
|
*/
|
|
30640
30615
|
|
|
30641
30616
|
/**
|
|
@@ -32213,7 +32188,7 @@ class RecordingApi {
|
|
|
32213
32188
|
/**
|
|
32214
32189
|
* Recording service.
|
|
32215
32190
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
32216
|
-
* @version
|
|
32191
|
+
* @version 135.0.0
|
|
32217
32192
|
*/
|
|
32218
32193
|
|
|
32219
32194
|
/**
|
|
@@ -32736,6 +32711,7 @@ class RecordingApi {
|
|
|
32736
32711
|
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
32737
32712
|
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
32738
32713
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
32714
|
+
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
32739
32715
|
*/
|
|
32740
32716
|
getRecordingCrossplatformMediaretentionpolicies(opts) {
|
|
32741
32717
|
opts = opts || {};
|
|
@@ -32745,7 +32721,7 @@ class RecordingApi {
|
|
|
32745
32721
|
'/api/v2/recording/crossplatform/mediaretentionpolicies',
|
|
32746
32722
|
'GET',
|
|
32747
32723
|
{ },
|
|
32748
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'] },
|
|
32724
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'],'deleteDaysThreshold': opts['deleteDaysThreshold'] },
|
|
32749
32725
|
{ },
|
|
32750
32726
|
{ },
|
|
32751
32727
|
null,
|
|
@@ -32927,6 +32903,7 @@ class RecordingApi {
|
|
|
32927
32903
|
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
32928
32904
|
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
32929
32905
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
32906
|
+
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
32930
32907
|
*/
|
|
32931
32908
|
getRecordingMediaretentionpolicies(opts) {
|
|
32932
32909
|
opts = opts || {};
|
|
@@ -32936,7 +32913,7 @@ class RecordingApi {
|
|
|
32936
32913
|
'/api/v2/recording/mediaretentionpolicies',
|
|
32937
32914
|
'GET',
|
|
32938
32915
|
{ },
|
|
32939
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'] },
|
|
32916
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'],'deleteDaysThreshold': opts['deleteDaysThreshold'] },
|
|
32940
32917
|
{ },
|
|
32941
32918
|
{ },
|
|
32942
32919
|
null,
|
|
@@ -33739,7 +33716,7 @@ class ResponseManagementApi {
|
|
|
33739
33716
|
/**
|
|
33740
33717
|
* ResponseManagement service.
|
|
33741
33718
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
33742
|
-
* @version
|
|
33719
|
+
* @version 135.0.0
|
|
33743
33720
|
*/
|
|
33744
33721
|
|
|
33745
33722
|
/**
|
|
@@ -34223,7 +34200,7 @@ class RoutingApi {
|
|
|
34223
34200
|
/**
|
|
34224
34201
|
* Routing service.
|
|
34225
34202
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
34226
|
-
* @version
|
|
34203
|
+
* @version 135.0.0
|
|
34227
34204
|
*/
|
|
34228
34205
|
|
|
34229
34206
|
/**
|
|
@@ -37146,7 +37123,7 @@ class SCIMApi {
|
|
|
37146
37123
|
/**
|
|
37147
37124
|
* SCIM service.
|
|
37148
37125
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
37149
|
-
* @version
|
|
37126
|
+
* @version 135.0.0
|
|
37150
37127
|
*/
|
|
37151
37128
|
|
|
37152
37129
|
/**
|
|
@@ -38023,7 +38000,7 @@ class ScriptsApi {
|
|
|
38023
38000
|
/**
|
|
38024
38001
|
* Scripts service.
|
|
38025
38002
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
38026
|
-
* @version
|
|
38003
|
+
* @version 135.0.0
|
|
38027
38004
|
*/
|
|
38028
38005
|
|
|
38029
38006
|
/**
|
|
@@ -38139,6 +38116,7 @@ class ScriptsApi {
|
|
|
38139
38116
|
* @param {Object} opts.sortBy SortBy
|
|
38140
38117
|
* @param {Object} opts.sortOrder SortOrder
|
|
38141
38118
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
38119
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
38142
38120
|
*/
|
|
38143
38121
|
getScripts(opts) {
|
|
38144
38122
|
opts = opts || {};
|
|
@@ -38148,7 +38126,40 @@ class ScriptsApi {
|
|
|
38148
38126
|
'/api/v2/scripts',
|
|
38149
38127
|
'GET',
|
|
38150
38128
|
{ },
|
|
38151
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'scriptDataVersion': opts['scriptDataVersion'] },
|
|
38129
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
38130
|
+
{ },
|
|
38131
|
+
{ },
|
|
38132
|
+
null,
|
|
38133
|
+
['PureCloud OAuth'],
|
|
38134
|
+
['application/json'],
|
|
38135
|
+
['application/json']
|
|
38136
|
+
);
|
|
38137
|
+
}
|
|
38138
|
+
|
|
38139
|
+
/**
|
|
38140
|
+
* Get the metadata for a list of scripts
|
|
38141
|
+
*
|
|
38142
|
+
* @param {Object} opts Optional parameters
|
|
38143
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
38144
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
38145
|
+
* @param {String} opts.expand Expand
|
|
38146
|
+
* @param {String} opts.name Name filter
|
|
38147
|
+
* @param {String} opts.feature Feature filter
|
|
38148
|
+
* @param {String} opts.flowId Secure flow id filter
|
|
38149
|
+
* @param {Object} opts.sortBy SortBy
|
|
38150
|
+
* @param {Object} opts.sortOrder SortOrder
|
|
38151
|
+
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
38152
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
38153
|
+
*/
|
|
38154
|
+
getScriptsDivisionviews(opts) {
|
|
38155
|
+
opts = opts || {};
|
|
38156
|
+
|
|
38157
|
+
|
|
38158
|
+
return this.apiClient.callApi(
|
|
38159
|
+
'/api/v2/scripts/divisionviews',
|
|
38160
|
+
'GET',
|
|
38161
|
+
{ },
|
|
38162
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
38152
38163
|
{ },
|
|
38153
38164
|
{ },
|
|
38154
38165
|
null,
|
|
@@ -38169,6 +38180,7 @@ class ScriptsApi {
|
|
|
38169
38180
|
* @param {String} opts.feature Feature filter
|
|
38170
38181
|
* @param {String} opts.flowId Secure flow id filter
|
|
38171
38182
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
38183
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
38172
38184
|
*/
|
|
38173
38185
|
getScriptsPublished(opts) {
|
|
38174
38186
|
opts = opts || {};
|
|
@@ -38178,7 +38190,38 @@ class ScriptsApi {
|
|
|
38178
38190
|
'/api/v2/scripts/published',
|
|
38179
38191
|
'GET',
|
|
38180
38192
|
{ },
|
|
38181
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'] },
|
|
38193
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
38194
|
+
{ },
|
|
38195
|
+
{ },
|
|
38196
|
+
null,
|
|
38197
|
+
['PureCloud OAuth'],
|
|
38198
|
+
['application/json'],
|
|
38199
|
+
['application/json']
|
|
38200
|
+
);
|
|
38201
|
+
}
|
|
38202
|
+
|
|
38203
|
+
/**
|
|
38204
|
+
* Get the published scripts metadata.
|
|
38205
|
+
*
|
|
38206
|
+
* @param {Object} opts Optional parameters
|
|
38207
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
38208
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
38209
|
+
* @param {String} opts.expand Expand
|
|
38210
|
+
* @param {String} opts.name Name filter
|
|
38211
|
+
* @param {String} opts.feature Feature filter
|
|
38212
|
+
* @param {String} opts.flowId Secure flow id filter
|
|
38213
|
+
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
38214
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
38215
|
+
*/
|
|
38216
|
+
getScriptsPublishedDivisionviews(opts) {
|
|
38217
|
+
opts = opts || {};
|
|
38218
|
+
|
|
38219
|
+
|
|
38220
|
+
return this.apiClient.callApi(
|
|
38221
|
+
'/api/v2/scripts/published/divisionviews',
|
|
38222
|
+
'GET',
|
|
38223
|
+
{ },
|
|
38224
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
38182
38225
|
{ },
|
|
38183
38226
|
{ },
|
|
38184
38227
|
null,
|
|
@@ -38376,7 +38419,7 @@ class SearchApi {
|
|
|
38376
38419
|
/**
|
|
38377
38420
|
* Search service.
|
|
38378
38421
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
38379
|
-
* @version
|
|
38422
|
+
* @version 135.0.0
|
|
38380
38423
|
*/
|
|
38381
38424
|
|
|
38382
38425
|
/**
|
|
@@ -38911,7 +38954,7 @@ class SpeechTextAnalyticsApi {
|
|
|
38911
38954
|
/**
|
|
38912
38955
|
* SpeechTextAnalytics service.
|
|
38913
38956
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
38914
|
-
* @version
|
|
38957
|
+
* @version 135.0.0
|
|
38915
38958
|
*/
|
|
38916
38959
|
|
|
38917
38960
|
/**
|
|
@@ -39764,7 +39807,7 @@ class StationsApi {
|
|
|
39764
39807
|
/**
|
|
39765
39808
|
* Stations service.
|
|
39766
39809
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
39767
|
-
* @version
|
|
39810
|
+
* @version 135.0.0
|
|
39768
39811
|
*/
|
|
39769
39812
|
|
|
39770
39813
|
/**
|
|
@@ -39911,7 +39954,7 @@ class SuggestApi {
|
|
|
39911
39954
|
/**
|
|
39912
39955
|
* Suggest service.
|
|
39913
39956
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
39914
|
-
* @version
|
|
39957
|
+
* @version 135.0.0
|
|
39915
39958
|
*/
|
|
39916
39959
|
|
|
39917
39960
|
/**
|
|
@@ -40050,7 +40093,7 @@ class TelephonyApi {
|
|
|
40050
40093
|
/**
|
|
40051
40094
|
* Telephony service.
|
|
40052
40095
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
40053
|
-
* @version
|
|
40096
|
+
* @version 135.0.0
|
|
40054
40097
|
*/
|
|
40055
40098
|
|
|
40056
40099
|
/**
|
|
@@ -40158,7 +40201,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
40158
40201
|
/**
|
|
40159
40202
|
* TelephonyProvidersEdge service.
|
|
40160
40203
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
40161
|
-
* @version
|
|
40204
|
+
* @version 135.0.0
|
|
40162
40205
|
*/
|
|
40163
40206
|
|
|
40164
40207
|
/**
|
|
@@ -41573,7 +41616,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
41573
41616
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
41574
41617
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
41575
41618
|
* @param {String} opts.sortBy Sort by
|
|
41576
|
-
* @param {String} opts._number
|
|
41619
|
+
* @param {String} opts._number Deprecated, filtering by number not supported
|
|
41577
41620
|
*/
|
|
41578
41621
|
getTelephonyProvidersEdgesExtensionpools(opts) {
|
|
41579
41622
|
opts = opts || {};
|
|
@@ -43791,7 +43834,7 @@ class TextbotsApi {
|
|
|
43791
43834
|
/**
|
|
43792
43835
|
* Textbots service.
|
|
43793
43836
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
43794
|
-
* @version
|
|
43837
|
+
* @version 135.0.0
|
|
43795
43838
|
*/
|
|
43796
43839
|
|
|
43797
43840
|
/**
|
|
@@ -43919,7 +43962,7 @@ class TokensApi {
|
|
|
43919
43962
|
/**
|
|
43920
43963
|
* Tokens service.
|
|
43921
43964
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
43922
|
-
* @version
|
|
43965
|
+
* @version 135.0.0
|
|
43923
43966
|
*/
|
|
43924
43967
|
|
|
43925
43968
|
/**
|
|
@@ -44025,7 +44068,7 @@ class UploadsApi {
|
|
|
44025
44068
|
/**
|
|
44026
44069
|
* Uploads service.
|
|
44027
44070
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
44028
|
-
* @version
|
|
44071
|
+
* @version 135.0.0
|
|
44029
44072
|
*/
|
|
44030
44073
|
|
|
44031
44074
|
/**
|
|
@@ -44176,7 +44219,7 @@ class UsageApi {
|
|
|
44176
44219
|
/**
|
|
44177
44220
|
* Usage service.
|
|
44178
44221
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
44179
|
-
* @version
|
|
44222
|
+
* @version 135.0.0
|
|
44180
44223
|
*/
|
|
44181
44224
|
|
|
44182
44225
|
/**
|
|
@@ -44247,7 +44290,7 @@ class UserRecordingsApi {
|
|
|
44247
44290
|
/**
|
|
44248
44291
|
* UserRecordings service.
|
|
44249
44292
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
44250
|
-
* @version
|
|
44293
|
+
* @version 135.0.0
|
|
44251
44294
|
*/
|
|
44252
44295
|
|
|
44253
44296
|
/**
|
|
@@ -44431,7 +44474,7 @@ class UsersApi {
|
|
|
44431
44474
|
/**
|
|
44432
44475
|
* Users service.
|
|
44433
44476
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
44434
|
-
* @version
|
|
44477
|
+
* @version 135.0.0
|
|
44435
44478
|
*/
|
|
44436
44479
|
|
|
44437
44480
|
/**
|
|
@@ -46733,7 +46776,7 @@ class UtilitiesApi {
|
|
|
46733
46776
|
/**
|
|
46734
46777
|
* Utilities service.
|
|
46735
46778
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
46736
|
-
* @version
|
|
46779
|
+
* @version 135.0.0
|
|
46737
46780
|
*/
|
|
46738
46781
|
|
|
46739
46782
|
/**
|
|
@@ -46844,7 +46887,7 @@ class VoicemailApi {
|
|
|
46844
46887
|
/**
|
|
46845
46888
|
* Voicemail service.
|
|
46846
46889
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
46847
|
-
* @version
|
|
46890
|
+
* @version 135.0.0
|
|
46848
46891
|
*/
|
|
46849
46892
|
|
|
46850
46893
|
/**
|
|
@@ -47511,7 +47554,7 @@ class WebChatApi {
|
|
|
47511
47554
|
/**
|
|
47512
47555
|
* WebChat service.
|
|
47513
47556
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
47514
|
-
* @version
|
|
47557
|
+
* @version 135.0.0
|
|
47515
47558
|
*/
|
|
47516
47559
|
|
|
47517
47560
|
/**
|
|
@@ -48055,7 +48098,7 @@ class WebDeploymentsApi {
|
|
|
48055
48098
|
/**
|
|
48056
48099
|
* WebDeployments service.
|
|
48057
48100
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
48058
|
-
* @version
|
|
48101
|
+
* @version 135.0.0
|
|
48059
48102
|
*/
|
|
48060
48103
|
|
|
48061
48104
|
/**
|
|
@@ -48410,7 +48453,7 @@ class WebMessagingApi {
|
|
|
48410
48453
|
/**
|
|
48411
48454
|
* WebMessaging service.
|
|
48412
48455
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
48413
|
-
* @version
|
|
48456
|
+
* @version 135.0.0
|
|
48414
48457
|
*/
|
|
48415
48458
|
|
|
48416
48459
|
/**
|
|
@@ -48456,7 +48499,7 @@ class WidgetsApi {
|
|
|
48456
48499
|
/**
|
|
48457
48500
|
* Widgets service.
|
|
48458
48501
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
48459
|
-
* @version
|
|
48502
|
+
* @version 135.0.0
|
|
48460
48503
|
*/
|
|
48461
48504
|
|
|
48462
48505
|
/**
|
|
@@ -48602,7 +48645,7 @@ class WorkforceManagementApi {
|
|
|
48602
48645
|
/**
|
|
48603
48646
|
* WorkforceManagement service.
|
|
48604
48647
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
48605
|
-
* @version
|
|
48648
|
+
* @version 135.0.0
|
|
48606
48649
|
*/
|
|
48607
48650
|
|
|
48608
48651
|
/**
|
|
@@ -48800,7 +48843,7 @@ class WorkforceManagementApi {
|
|
|
48800
48843
|
/**
|
|
48801
48844
|
* Delete a short term forecast
|
|
48802
48845
|
* Must not be tied to any schedules
|
|
48803
|
-
* @param {String} businessUnitId The
|
|
48846
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
48804
48847
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
48805
48848
|
* @param {String} forecastId The ID of the forecast
|
|
48806
48849
|
*/
|
|
@@ -48880,7 +48923,7 @@ class WorkforceManagementApi {
|
|
|
48880
48923
|
/**
|
|
48881
48924
|
* Deletes a time off limit object
|
|
48882
48925
|
*
|
|
48883
|
-
* @param {String} managementUnitId The
|
|
48926
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
48884
48927
|
* @param {String} timeOffLimitId The ID of the time off limit object to delete
|
|
48885
48928
|
*/
|
|
48886
48929
|
deleteWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
@@ -48910,7 +48953,7 @@ class WorkforceManagementApi {
|
|
|
48910
48953
|
/**
|
|
48911
48954
|
* Deletes a time off plan
|
|
48912
48955
|
*
|
|
48913
|
-
* @param {String} managementUnitId The management unit
|
|
48956
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
48914
48957
|
* @param {String} timeOffPlanId The ID of the time off plan to delete
|
|
48915
48958
|
*/
|
|
48916
48959
|
deleteWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
@@ -49179,7 +49222,7 @@ class WorkforceManagementApi {
|
|
|
49179
49222
|
/**
|
|
49180
49223
|
* Get intraday planning groups for the given date
|
|
49181
49224
|
*
|
|
49182
|
-
* @param {String} businessUnitId The
|
|
49225
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
49183
49226
|
* @param {String} _date yyyy-MM-dd date string interpreted in the configured business unit time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
49184
49227
|
*/
|
|
49185
49228
|
getWorkforcemanagementBusinessunitIntradayPlanninggroups(businessUnitId, _date) {
|
|
@@ -49632,7 +49675,7 @@ class WorkforceManagementApi {
|
|
|
49632
49675
|
/**
|
|
49633
49676
|
* Get a short term forecast
|
|
49634
49677
|
*
|
|
49635
|
-
* @param {String} businessUnitId The
|
|
49678
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49636
49679
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
49637
49680
|
* @param {String} forecastId The ID of the forecast
|
|
49638
49681
|
* @param {Object} opts Optional parameters
|
|
@@ -49671,7 +49714,7 @@ class WorkforceManagementApi {
|
|
|
49671
49714
|
/**
|
|
49672
49715
|
* Get the result of a short term forecast calculation
|
|
49673
49716
|
* Includes modifications unless you pass the doNotApplyModifications query parameter
|
|
49674
|
-
* @param {String} businessUnitId The
|
|
49717
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49675
49718
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
49676
49719
|
* @param {String} forecastId The ID of the forecast
|
|
49677
49720
|
* @param {Object} opts Optional parameters
|
|
@@ -49711,7 +49754,7 @@ class WorkforceManagementApi {
|
|
|
49711
49754
|
/**
|
|
49712
49755
|
* Gets the forecast generation results
|
|
49713
49756
|
*
|
|
49714
|
-
* @param {String} businessUnitId The
|
|
49757
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49715
49758
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
49716
49759
|
* @param {String} forecastId The ID of the forecast
|
|
49717
49760
|
*/
|
|
@@ -49746,7 +49789,7 @@ class WorkforceManagementApi {
|
|
|
49746
49789
|
/**
|
|
49747
49790
|
* Get the result of a long term forecast calculation
|
|
49748
49791
|
* Includes modifications unless you pass the doNotApplyModifications query parameter
|
|
49749
|
-
* @param {String} businessUnitId The
|
|
49792
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49750
49793
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
49751
49794
|
* @param {String} forecastId The ID of the forecast
|
|
49752
49795
|
* @param {Object} opts Optional parameters
|
|
@@ -49785,7 +49828,7 @@ class WorkforceManagementApi {
|
|
|
49785
49828
|
/**
|
|
49786
49829
|
* Gets the forecast planning group snapshot
|
|
49787
49830
|
*
|
|
49788
|
-
* @param {String} businessUnitId The
|
|
49831
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49789
49832
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
49790
49833
|
* @param {String} forecastId The ID of the forecast
|
|
49791
49834
|
*/
|
|
@@ -49820,7 +49863,7 @@ class WorkforceManagementApi {
|
|
|
49820
49863
|
/**
|
|
49821
49864
|
* Get short term forecasts
|
|
49822
49865
|
* Use \"recent\" (without quotes) for the `weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any forecast which spans the specified week
|
|
49823
|
-
* @param {String} businessUnitId The
|
|
49866
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49824
49867
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format or 'recent' (without quotes) to fetch recent forecasts
|
|
49825
49868
|
*/
|
|
49826
49869
|
getWorkforcemanagementBusinessunitWeekShorttermforecasts(businessUnitId, weekDateId) {
|
|
@@ -50038,7 +50081,7 @@ class WorkforceManagementApi {
|
|
|
50038
50081
|
/**
|
|
50039
50082
|
* Get a list of user schedule adherence records for the requested management unit
|
|
50040
50083
|
*
|
|
50041
|
-
* @param {String} managementUnitId The
|
|
50084
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
50042
50085
|
* @param {Object} opts Optional parameters
|
|
50043
50086
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
50044
50087
|
*/
|
|
@@ -50067,7 +50110,7 @@ class WorkforceManagementApi {
|
|
|
50067
50110
|
/**
|
|
50068
50111
|
* Get data for agent in the management unit
|
|
50069
50112
|
*
|
|
50070
|
-
* @param {String} managementUnitId The
|
|
50113
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50071
50114
|
* @param {String} agentId The agent id
|
|
50072
50115
|
* @param {Object} opts Optional parameters
|
|
50073
50116
|
* @param {Boolean} opts.excludeCapabilities Excludes all capabilities of the agent such as queues, languages, and skills
|
|
@@ -50101,7 +50144,7 @@ class WorkforceManagementApi {
|
|
|
50101
50144
|
/**
|
|
50102
50145
|
* Gets all the shift trades for a given agent
|
|
50103
50146
|
*
|
|
50104
|
-
* @param {String} managementUnitId The
|
|
50147
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50105
50148
|
* @param {String} agentId The agent id
|
|
50106
50149
|
*/
|
|
50107
50150
|
getWorkforcemanagementManagementunitAgentShifttrades(managementUnitId, agentId) {
|
|
@@ -50131,7 +50174,7 @@ class WorkforceManagementApi {
|
|
|
50131
50174
|
/**
|
|
50132
50175
|
* Gets a summary of all shift trades in the matched state
|
|
50133
50176
|
*
|
|
50134
|
-
* @param {String} managementUnitId The
|
|
50177
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50135
50178
|
*/
|
|
50136
50179
|
getWorkforcemanagementManagementunitShifttradesMatched(managementUnitId) {
|
|
50137
50180
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50156,7 +50199,7 @@ class WorkforceManagementApi {
|
|
|
50156
50199
|
/**
|
|
50157
50200
|
* Gets list of users available for whom you can send direct shift trade requests
|
|
50158
50201
|
*
|
|
50159
|
-
* @param {String} managementUnitId The
|
|
50202
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50160
50203
|
*/
|
|
50161
50204
|
getWorkforcemanagementManagementunitShifttradesUsers(managementUnitId) {
|
|
50162
50205
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50181,7 +50224,7 @@ class WorkforceManagementApi {
|
|
|
50181
50224
|
/**
|
|
50182
50225
|
* Gets a time off limit object
|
|
50183
50226
|
* Returns properties of time off limit object, but not daily values.
|
|
50184
|
-
* @param {String} managementUnitId The
|
|
50227
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
50185
50228
|
* @param {String} timeOffLimitId The ID of the time off limit to fetch
|
|
50186
50229
|
*/
|
|
50187
50230
|
getWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
@@ -50211,7 +50254,7 @@ class WorkforceManagementApi {
|
|
|
50211
50254
|
/**
|
|
50212
50255
|
* Gets a list of time off limit objects under management unit.
|
|
50213
50256
|
* Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.
|
|
50214
|
-
* @param {String} managementUnitId The
|
|
50257
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
50215
50258
|
*/
|
|
50216
50259
|
getWorkforcemanagementManagementunitTimeofflimits(managementUnitId) {
|
|
50217
50260
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50236,7 +50279,7 @@ class WorkforceManagementApi {
|
|
|
50236
50279
|
/**
|
|
50237
50280
|
* Gets a time off plan
|
|
50238
50281
|
*
|
|
50239
|
-
* @param {String} managementUnitId The management unit
|
|
50282
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
50240
50283
|
* @param {String} timeOffPlanId The ID of the time off plan to fetch
|
|
50241
50284
|
*/
|
|
50242
50285
|
getWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
@@ -50266,7 +50309,7 @@ class WorkforceManagementApi {
|
|
|
50266
50309
|
/**
|
|
50267
50310
|
* Gets a list of time off plans
|
|
50268
50311
|
*
|
|
50269
|
-
* @param {String} managementUnitId The management unit
|
|
50312
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
50270
50313
|
*/
|
|
50271
50314
|
getWorkforcemanagementManagementunitTimeoffplans(managementUnitId) {
|
|
50272
50315
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50291,7 +50334,7 @@ class WorkforceManagementApi {
|
|
|
50291
50334
|
/**
|
|
50292
50335
|
* Get a time off request
|
|
50293
50336
|
*
|
|
50294
|
-
* @param {String} managementUnitId The
|
|
50337
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50295
50338
|
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
50296
50339
|
* @param {String} timeOffRequestId Time Off Request Id
|
|
50297
50340
|
*/
|
|
@@ -50326,7 +50369,7 @@ class WorkforceManagementApi {
|
|
|
50326
50369
|
/**
|
|
50327
50370
|
* Retrieves time off limit, allocated and waitlisted values according to specific time off request
|
|
50328
50371
|
*
|
|
50329
|
-
* @param {String} managementUnitId The
|
|
50372
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
50330
50373
|
* @param {String} userId The userId to whom the time off request applies.
|
|
50331
50374
|
* @param {String} timeOffRequestId The ID of the time off request, which dates and activityCodeId determine limit values to retrieve
|
|
50332
50375
|
*/
|
|
@@ -50361,7 +50404,7 @@ class WorkforceManagementApi {
|
|
|
50361
50404
|
/**
|
|
50362
50405
|
* Get a list of time off requests for a given user
|
|
50363
50406
|
*
|
|
50364
|
-
* @param {String} managementUnitId The
|
|
50407
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50365
50408
|
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
50366
50409
|
* @param {Object} opts Optional parameters
|
|
50367
50410
|
* @param {Boolean} opts.recentlyReviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
|
|
@@ -50395,7 +50438,7 @@ class WorkforceManagementApi {
|
|
|
50395
50438
|
/**
|
|
50396
50439
|
* Get users in the management unit
|
|
50397
50440
|
*
|
|
50398
|
-
* @param {String} managementUnitId The
|
|
50441
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50399
50442
|
*/
|
|
50400
50443
|
getWorkforcemanagementManagementunitUsers(managementUnitId) {
|
|
50401
50444
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50496,7 +50539,7 @@ class WorkforceManagementApi {
|
|
|
50496
50539
|
/**
|
|
50497
50540
|
* Gets all the shift trades for a given week
|
|
50498
50541
|
*
|
|
50499
|
-
* @param {String} managementUnitId The
|
|
50542
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50500
50543
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
50501
50544
|
* @param {Object} opts Optional parameters
|
|
50502
50545
|
* @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
|
|
@@ -50769,7 +50812,7 @@ class WorkforceManagementApi {
|
|
|
50769
50812
|
/**
|
|
50770
50813
|
* Get a time off request for the current user
|
|
50771
50814
|
*
|
|
50772
|
-
* @param {String} timeOffRequestId
|
|
50815
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
50773
50816
|
*/
|
|
50774
50817
|
getWorkforcemanagementTimeoffrequest(timeOffRequestId) {
|
|
50775
50818
|
// verify the required parameter 'timeOffRequestId' is set
|
|
@@ -50794,7 +50837,7 @@ class WorkforceManagementApi {
|
|
|
50794
50837
|
/**
|
|
50795
50838
|
* Get the daily waitlist positions of a time off request for the current user
|
|
50796
50839
|
*
|
|
50797
|
-
* @param {String} timeOffRequestId
|
|
50840
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
50798
50841
|
*/
|
|
50799
50842
|
getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId) {
|
|
50800
50843
|
// verify the required parameter 'timeOffRequestId' is set
|
|
@@ -51037,7 +51080,7 @@ class WorkforceManagementApi {
|
|
|
51037
51080
|
/**
|
|
51038
51081
|
* Updates a time off limit object.
|
|
51039
51082
|
* Updates time off limit object properties, but not daily values.
|
|
51040
|
-
* @param {String} managementUnitId The
|
|
51083
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
51041
51084
|
* @param {String} timeOffLimitId The id of time off limit object to update
|
|
51042
51085
|
* @param {Object} opts Optional parameters
|
|
51043
51086
|
* @param {Object} opts.body body
|
|
@@ -51071,7 +51114,7 @@ class WorkforceManagementApi {
|
|
|
51071
51114
|
/**
|
|
51072
51115
|
* Updates a time off plan
|
|
51073
51116
|
*
|
|
51074
|
-
* @param {String} managementUnitId The management unit
|
|
51117
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
51075
51118
|
* @param {String} timeOffPlanId The ID of the time off plan to update
|
|
51076
51119
|
* @param {Object} opts Optional parameters
|
|
51077
51120
|
* @param {Object} opts.body body
|
|
@@ -51105,7 +51148,7 @@ class WorkforceManagementApi {
|
|
|
51105
51148
|
/**
|
|
51106
51149
|
* Update a time off request
|
|
51107
51150
|
*
|
|
51108
|
-
* @param {String} managementUnitId The
|
|
51151
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
51109
51152
|
* @param {String} userId The id of the user the requested time off request belongs to
|
|
51110
51153
|
* @param {String} timeOffRequestId The id of the time off request to update
|
|
51111
51154
|
* @param {Object} opts Optional parameters
|
|
@@ -51144,7 +51187,7 @@ class WorkforceManagementApi {
|
|
|
51144
51187
|
/**
|
|
51145
51188
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
51146
51189
|
*
|
|
51147
|
-
* @param {String} managementUnitId The
|
|
51190
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
51148
51191
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51149
51192
|
* @param {Object} body body
|
|
51150
51193
|
* @param {String} tradeId The ID of the shift trade to update
|
|
@@ -51253,7 +51296,7 @@ class WorkforceManagementApi {
|
|
|
51253
51296
|
/**
|
|
51254
51297
|
* Update a time off request for the current user
|
|
51255
51298
|
*
|
|
51256
|
-
* @param {String} timeOffRequestId
|
|
51299
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
51257
51300
|
* @param {Object} opts Optional parameters
|
|
51258
51301
|
* @param {Object} opts.body body
|
|
51259
51302
|
*/
|
|
@@ -51390,7 +51433,7 @@ class WorkforceManagementApi {
|
|
|
51390
51433
|
/**
|
|
51391
51434
|
* Get intraday data for the given date for the requested planningGroupIds
|
|
51392
51435
|
*
|
|
51393
|
-
* @param {String} businessUnitId The
|
|
51436
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
51394
51437
|
* @param {Object} opts Optional parameters
|
|
51395
51438
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
51396
51439
|
* @param {Object} opts.body body
|
|
@@ -51823,7 +51866,7 @@ class WorkforceManagementApi {
|
|
|
51823
51866
|
/**
|
|
51824
51867
|
* Copy a short term forecast
|
|
51825
51868
|
*
|
|
51826
|
-
* @param {String} businessUnitId The
|
|
51869
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51827
51870
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51828
51871
|
* @param {String} forecastId The ID of the forecast to copy
|
|
51829
51872
|
* @param {Object} body body
|
|
@@ -51867,7 +51910,7 @@ class WorkforceManagementApi {
|
|
|
51867
51910
|
/**
|
|
51868
51911
|
* Generate a short term forecast
|
|
51869
51912
|
*
|
|
51870
|
-
* @param {String} businessUnitId The
|
|
51913
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51871
51914
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51872
51915
|
* @param {Object} body
|
|
51873
51916
|
* @param {Object} opts Optional parameters
|
|
@@ -51906,7 +51949,7 @@ class WorkforceManagementApi {
|
|
|
51906
51949
|
/**
|
|
51907
51950
|
* Starts importing the uploaded short term forecast
|
|
51908
51951
|
* Call after uploading the forecast data to the url supplied by the /import/uploadurl route
|
|
51909
|
-
* @param {String} businessUnitId The
|
|
51952
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51910
51953
|
* @param {String} weekDateId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51911
51954
|
* @param {Object} body
|
|
51912
51955
|
*/
|
|
@@ -51941,7 +51984,7 @@ class WorkforceManagementApi {
|
|
|
51941
51984
|
/**
|
|
51942
51985
|
* Creates a signed upload URL for importing a short term forecast
|
|
51943
51986
|
* Once the upload is complete, call the /import route to start the short term forecast import process
|
|
51944
|
-
* @param {String} businessUnitId The
|
|
51987
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51945
51988
|
* @param {String} weekDateId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51946
51989
|
* @param {Object} body body
|
|
51947
51990
|
*/
|
|
@@ -52068,7 +52111,7 @@ class WorkforceManagementApi {
|
|
|
52068
52111
|
/**
|
|
52069
52112
|
* Query published schedules for given given time range for set of users
|
|
52070
52113
|
*
|
|
52071
|
-
* @param {String} managementUnitId The
|
|
52114
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52072
52115
|
* @param {Object} opts Optional parameters
|
|
52073
52116
|
* @param {Object} opts.body body
|
|
52074
52117
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
@@ -52099,7 +52142,7 @@ class WorkforceManagementApi {
|
|
|
52099
52142
|
/**
|
|
52100
52143
|
* Request a historical adherence report
|
|
52101
52144
|
* The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
|
|
52102
|
-
* @param {String} managementUnitId The
|
|
52145
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
52103
52146
|
* @param {Object} opts Optional parameters
|
|
52104
52147
|
* @param {Object} opts.body body
|
|
52105
52148
|
*/
|
|
@@ -52157,7 +52200,7 @@ class WorkforceManagementApi {
|
|
|
52157
52200
|
/**
|
|
52158
52201
|
* Query published schedules for given given time range for set of users
|
|
52159
52202
|
*
|
|
52160
|
-
* @param {String} managementUnitId The
|
|
52203
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52161
52204
|
* @param {Object} opts Optional parameters
|
|
52162
52205
|
* @param {Object} opts.body body
|
|
52163
52206
|
*/
|
|
@@ -52186,7 +52229,7 @@ class WorkforceManagementApi {
|
|
|
52186
52229
|
/**
|
|
52187
52230
|
* Creates a new time off limit object under management unit.
|
|
52188
52231
|
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
52189
|
-
* @param {String} managementUnitId The
|
|
52232
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52190
52233
|
* @param {Object} opts Optional parameters
|
|
52191
52234
|
* @param {Object} opts.body body
|
|
52192
52235
|
*/
|
|
@@ -52215,7 +52258,7 @@ class WorkforceManagementApi {
|
|
|
52215
52258
|
/**
|
|
52216
52259
|
* Retrieves time off limit related values based on a given set of filters.
|
|
52217
52260
|
*
|
|
52218
|
-
* @param {String} managementUnitId The
|
|
52261
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52219
52262
|
* @param {Object} opts Optional parameters
|
|
52220
52263
|
* @param {Object} opts.body body
|
|
52221
52264
|
*/
|
|
@@ -52244,7 +52287,7 @@ class WorkforceManagementApi {
|
|
|
52244
52287
|
/**
|
|
52245
52288
|
* Creates a new time off plan
|
|
52246
52289
|
*
|
|
52247
|
-
* @param {String} managementUnitId The management unit
|
|
52290
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
52248
52291
|
* @param {Object} opts Optional parameters
|
|
52249
52292
|
* @param {Object} opts.body body
|
|
52250
52293
|
*/
|
|
@@ -52273,7 +52316,7 @@ class WorkforceManagementApi {
|
|
|
52273
52316
|
/**
|
|
52274
52317
|
* Create a new time off request
|
|
52275
52318
|
*
|
|
52276
|
-
* @param {String} managementUnitId The
|
|
52319
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52277
52320
|
* @param {Object} opts Optional parameters
|
|
52278
52321
|
* @param {Object} opts.body body
|
|
52279
52322
|
*/
|
|
@@ -52302,7 +52345,7 @@ class WorkforceManagementApi {
|
|
|
52302
52345
|
/**
|
|
52303
52346
|
* Fetches time off requests matching the conditions specified in the request body
|
|
52304
52347
|
* Request body requires one of the following: User ID is specified, statuses == [Pending] or date range to be specified and less than or equal to 33 days. All other fields are filters
|
|
52305
|
-
* @param {String} managementUnitId The
|
|
52348
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52306
52349
|
* @param {Object} opts Optional parameters
|
|
52307
52350
|
* @param {Object} opts.body body
|
|
52308
52351
|
*/
|
|
@@ -52331,7 +52374,7 @@ class WorkforceManagementApi {
|
|
|
52331
52374
|
/**
|
|
52332
52375
|
* Retrieves daily waitlist position for a list of time off requests
|
|
52333
52376
|
*
|
|
52334
|
-
* @param {String} managementUnitId The
|
|
52377
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52335
52378
|
* @param {Object} opts Optional parameters
|
|
52336
52379
|
* @param {Object} opts.body body
|
|
52337
52380
|
*/
|
|
@@ -52360,7 +52403,7 @@ class WorkforceManagementApi {
|
|
|
52360
52403
|
/**
|
|
52361
52404
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
52362
52405
|
*
|
|
52363
|
-
* @param {String} managementUnitId The
|
|
52406
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52364
52407
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
52365
52408
|
* @param {Object} body body
|
|
52366
52409
|
* @param {String} tradeId The ID of the shift trade to update
|
|
@@ -52400,7 +52443,7 @@ class WorkforceManagementApi {
|
|
|
52400
52443
|
/**
|
|
52401
52444
|
* Adds a shift trade
|
|
52402
52445
|
*
|
|
52403
|
-
* @param {String} managementUnitId The
|
|
52446
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52404
52447
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
52405
52448
|
* @param {Object} body body
|
|
52406
52449
|
*/
|
|
@@ -52435,7 +52478,7 @@ class WorkforceManagementApi {
|
|
|
52435
52478
|
/**
|
|
52436
52479
|
* Searches for potential shift trade matches for the current agent
|
|
52437
52480
|
*
|
|
52438
|
-
* @param {String} managementUnitId The
|
|
52481
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52439
52482
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
52440
52483
|
* @param {Object} body body
|
|
52441
52484
|
*/
|
|
@@ -52470,7 +52513,7 @@ class WorkforceManagementApi {
|
|
|
52470
52513
|
/**
|
|
52471
52514
|
* Updates the state of a batch of shift trades
|
|
52472
52515
|
* Admin functionality is not supported with \"mine\".
|
|
52473
|
-
* @param {String} managementUnitId The
|
|
52516
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52474
52517
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
52475
52518
|
* @param {Object} body body
|
|
52476
52519
|
* @param {Object} opts Optional parameters
|
|
@@ -52791,7 +52834,7 @@ class WorkforceManagementApi {
|
|
|
52791
52834
|
/**
|
|
52792
52835
|
* Sets daily values for a date range of time off limit object
|
|
52793
52836
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
52794
|
-
* @param {String} managementUnitId The
|
|
52837
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52795
52838
|
* @param {String} timeOffLimitId The ID of the time off limit object to set values for
|
|
52796
52839
|
* @param {Object} opts Optional parameters
|
|
52797
52840
|
* @param {Object} opts.body body
|
|
@@ -52853,7 +52896,7 @@ class WorkforceManagementApi {
|
|
|
52853
52896
|
* </pre>
|
|
52854
52897
|
* </p>
|
|
52855
52898
|
* @module purecloud-platform-client-v2/index
|
|
52856
|
-
* @version
|
|
52899
|
+
* @version 135.0.0
|
|
52857
52900
|
*/
|
|
52858
52901
|
class platformClient {
|
|
52859
52902
|
constructor() {
|