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
|
@@ -9675,7 +9675,7 @@ class Configuration {
|
|
|
9675
9675
|
|
|
9676
9676
|
/**
|
|
9677
9677
|
* @module purecloud-platform-client-v2/ApiClient
|
|
9678
|
-
* @version
|
|
9678
|
+
* @version 135.0.0
|
|
9679
9679
|
*/
|
|
9680
9680
|
class ApiClient {
|
|
9681
9681
|
/**
|
|
@@ -10615,7 +10615,7 @@ class ApiClient {
|
|
|
10615
10615
|
|
|
10616
10616
|
// set header parameters
|
|
10617
10617
|
request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
|
|
10618
|
-
//request.set({ 'purecloud-sdk': '
|
|
10618
|
+
//request.set({ 'purecloud-sdk': '135.0.0' });
|
|
10619
10619
|
|
|
10620
10620
|
// set request timeout
|
|
10621
10621
|
request.timeout(that.timeout);
|
|
@@ -10715,7 +10715,7 @@ class AlertingApi {
|
|
|
10715
10715
|
/**
|
|
10716
10716
|
* Alerting service.
|
|
10717
10717
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
10718
|
-
* @version
|
|
10718
|
+
* @version 135.0.0
|
|
10719
10719
|
*/
|
|
10720
10720
|
|
|
10721
10721
|
/**
|
|
@@ -11029,7 +11029,7 @@ class AnalyticsApi {
|
|
|
11029
11029
|
/**
|
|
11030
11030
|
* Analytics service.
|
|
11031
11031
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
11032
|
-
* @version
|
|
11032
|
+
* @version 135.0.0
|
|
11033
11033
|
*/
|
|
11034
11034
|
|
|
11035
11035
|
/**
|
|
@@ -12211,7 +12211,7 @@ class ArchitectApi {
|
|
|
12211
12211
|
/**
|
|
12212
12212
|
* Architect service.
|
|
12213
12213
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
12214
|
-
* @version
|
|
12214
|
+
* @version 135.0.0
|
|
12215
12215
|
*/
|
|
12216
12216
|
|
|
12217
12217
|
/**
|
|
@@ -15207,7 +15207,7 @@ class AuditApi {
|
|
|
15207
15207
|
/**
|
|
15208
15208
|
* Audit service.
|
|
15209
15209
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
15210
|
-
* @version
|
|
15210
|
+
* @version 135.0.0
|
|
15211
15211
|
*/
|
|
15212
15212
|
|
|
15213
15213
|
/**
|
|
@@ -15378,7 +15378,7 @@ class AuthorizationApi {
|
|
|
15378
15378
|
/**
|
|
15379
15379
|
* Authorization service.
|
|
15380
15380
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
15381
|
-
* @version
|
|
15381
|
+
* @version 135.0.0
|
|
15382
15382
|
*/
|
|
15383
15383
|
|
|
15384
15384
|
/**
|
|
@@ -16561,7 +16561,7 @@ class BillingApi {
|
|
|
16561
16561
|
/**
|
|
16562
16562
|
* Billing service.
|
|
16563
16563
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
16564
|
-
* @version
|
|
16564
|
+
* @version 135.0.0
|
|
16565
16565
|
*/
|
|
16566
16566
|
|
|
16567
16567
|
/**
|
|
@@ -16641,7 +16641,7 @@ class ChatApi {
|
|
|
16641
16641
|
/**
|
|
16642
16642
|
* Chat service.
|
|
16643
16643
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
16644
|
-
* @version
|
|
16644
|
+
* @version 135.0.0
|
|
16645
16645
|
*/
|
|
16646
16646
|
|
|
16647
16647
|
/**
|
|
@@ -16732,7 +16732,7 @@ class CoachingApi {
|
|
|
16732
16732
|
/**
|
|
16733
16733
|
* Coaching service.
|
|
16734
16734
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
16735
|
-
* @version
|
|
16735
|
+
* @version 135.0.0
|
|
16736
16736
|
*/
|
|
16737
16737
|
|
|
16738
16738
|
/**
|
|
@@ -17309,7 +17309,7 @@ class ContentManagementApi {
|
|
|
17309
17309
|
/**
|
|
17310
17310
|
* ContentManagement service.
|
|
17311
17311
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
17312
|
-
* @version
|
|
17312
|
+
* @version 135.0.0
|
|
17313
17313
|
*/
|
|
17314
17314
|
|
|
17315
17315
|
/**
|
|
@@ -18449,7 +18449,7 @@ class ConversationsApi {
|
|
|
18449
18449
|
/**
|
|
18450
18450
|
* Conversations service.
|
|
18451
18451
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
18452
|
-
* @version
|
|
18452
|
+
* @version 135.0.0
|
|
18453
18453
|
*/
|
|
18454
18454
|
|
|
18455
18455
|
/**
|
|
@@ -20354,7 +20354,7 @@ class ConversationsApi {
|
|
|
20354
20354
|
/**
|
|
20355
20355
|
* Get a list of Messaging Stickers
|
|
20356
20356
|
*
|
|
20357
|
-
* @param {
|
|
20357
|
+
* @param {Object} messengerType Messenger Type
|
|
20358
20358
|
* @param {Object} opts Optional parameters
|
|
20359
20359
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
20360
20360
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
@@ -20542,7 +20542,7 @@ class ConversationsApi {
|
|
|
20542
20542
|
}
|
|
20543
20543
|
|
|
20544
20544
|
/**
|
|
20545
|
-
* Update a conversation by setting
|
|
20545
|
+
* Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
20546
20546
|
*
|
|
20547
20547
|
* @param {String} conversationId conversationId
|
|
20548
20548
|
* @param {Object} body Conversation
|
|
@@ -23113,7 +23113,7 @@ class DataExtensionsApi {
|
|
|
23113
23113
|
/**
|
|
23114
23114
|
* DataExtensions service.
|
|
23115
23115
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
23116
|
-
* @version
|
|
23116
|
+
* @version 135.0.0
|
|
23117
23117
|
*/
|
|
23118
23118
|
|
|
23119
23119
|
/**
|
|
@@ -23199,7 +23199,7 @@ class ExternalContactsApi {
|
|
|
23199
23199
|
/**
|
|
23200
23200
|
* ExternalContacts service.
|
|
23201
23201
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
23202
|
-
* @version
|
|
23202
|
+
* @version 135.0.0
|
|
23203
23203
|
*/
|
|
23204
23204
|
|
|
23205
23205
|
/**
|
|
@@ -24942,7 +24942,7 @@ class FaxApi {
|
|
|
24942
24942
|
/**
|
|
24943
24943
|
* Fax service.
|
|
24944
24944
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
24945
|
-
* @version
|
|
24945
|
+
* @version 135.0.0
|
|
24946
24946
|
*/
|
|
24947
24947
|
|
|
24948
24948
|
/**
|
|
@@ -25113,7 +25113,7 @@ class FlowsApi {
|
|
|
25113
25113
|
/**
|
|
25114
25114
|
* Flows service.
|
|
25115
25115
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
25116
|
-
* @version
|
|
25116
|
+
* @version 135.0.0
|
|
25117
25117
|
*/
|
|
25118
25118
|
|
|
25119
25119
|
/**
|
|
@@ -25184,7 +25184,7 @@ class GamificationApi {
|
|
|
25184
25184
|
/**
|
|
25185
25185
|
* Gamification service.
|
|
25186
25186
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
25187
|
-
* @version
|
|
25187
|
+
* @version 135.0.0
|
|
25188
25188
|
*/
|
|
25189
25189
|
|
|
25190
25190
|
/**
|
|
@@ -26614,7 +26614,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
26614
26614
|
/**
|
|
26615
26615
|
* GeneralDataProtectionRegulation service.
|
|
26616
26616
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
26617
|
-
* @version
|
|
26617
|
+
* @version 135.0.0
|
|
26618
26618
|
*/
|
|
26619
26619
|
|
|
26620
26620
|
/**
|
|
@@ -26744,7 +26744,7 @@ class GeolocationApi {
|
|
|
26744
26744
|
/**
|
|
26745
26745
|
* Geolocation service.
|
|
26746
26746
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
26747
|
-
* @version
|
|
26747
|
+
* @version 135.0.0
|
|
26748
26748
|
*/
|
|
26749
26749
|
|
|
26750
26750
|
/**
|
|
@@ -26875,7 +26875,7 @@ class GreetingsApi {
|
|
|
26875
26875
|
/**
|
|
26876
26876
|
* Greetings service.
|
|
26877
26877
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
26878
|
-
* @version
|
|
26878
|
+
* @version 135.0.0
|
|
26879
26879
|
*/
|
|
26880
26880
|
|
|
26881
26881
|
/**
|
|
@@ -27330,7 +27330,7 @@ class GroupsApi {
|
|
|
27330
27330
|
/**
|
|
27331
27331
|
* Groups service.
|
|
27332
27332
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
27333
|
-
* @version
|
|
27333
|
+
* @version 135.0.0
|
|
27334
27334
|
*/
|
|
27335
27335
|
|
|
27336
27336
|
/**
|
|
@@ -27735,7 +27735,7 @@ class IdentityProviderApi {
|
|
|
27735
27735
|
/**
|
|
27736
27736
|
* IdentityProvider service.
|
|
27737
27737
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
27738
|
-
* @version
|
|
27738
|
+
* @version 135.0.0
|
|
27739
27739
|
*/
|
|
27740
27740
|
|
|
27741
27741
|
/**
|
|
@@ -28491,7 +28491,7 @@ class IntegrationsApi {
|
|
|
28491
28491
|
/**
|
|
28492
28492
|
* Integrations service.
|
|
28493
28493
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
28494
|
-
* @version
|
|
28494
|
+
* @version 135.0.0
|
|
28495
28495
|
*/
|
|
28496
28496
|
|
|
28497
28497
|
/**
|
|
@@ -30166,7 +30166,7 @@ class JourneyApi {
|
|
|
30166
30166
|
/**
|
|
30167
30167
|
* Journey service.
|
|
30168
30168
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
30169
|
-
* @version
|
|
30169
|
+
* @version 135.0.0
|
|
30170
30170
|
*/
|
|
30171
30171
|
|
|
30172
30172
|
/**
|
|
@@ -30877,7 +30877,7 @@ class KnowledgeApi {
|
|
|
30877
30877
|
/**
|
|
30878
30878
|
* Knowledge service.
|
|
30879
30879
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
30880
|
-
* @version
|
|
30880
|
+
* @version 135.0.0
|
|
30881
30881
|
*/
|
|
30882
30882
|
|
|
30883
30883
|
/**
|
|
@@ -31777,7 +31777,7 @@ class LanguageUnderstandingApi {
|
|
|
31777
31777
|
/**
|
|
31778
31778
|
* LanguageUnderstanding service.
|
|
31779
31779
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
31780
|
-
* @version
|
|
31780
|
+
* @version 135.0.0
|
|
31781
31781
|
*/
|
|
31782
31782
|
|
|
31783
31783
|
/**
|
|
@@ -32681,7 +32681,7 @@ class LanguagesApi {
|
|
|
32681
32681
|
/**
|
|
32682
32682
|
* Languages service.
|
|
32683
32683
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
32684
|
-
* @version
|
|
32684
|
+
* @version 135.0.0
|
|
32685
32685
|
*/
|
|
32686
32686
|
|
|
32687
32687
|
/**
|
|
@@ -32949,7 +32949,7 @@ class LearningApi {
|
|
|
32949
32949
|
/**
|
|
32950
32950
|
* Learning service.
|
|
32951
32951
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
32952
|
-
* @version
|
|
32952
|
+
* @version 135.0.0
|
|
32953
32953
|
*/
|
|
32954
32954
|
|
|
32955
32955
|
/**
|
|
@@ -33540,7 +33540,7 @@ class LicenseApi {
|
|
|
33540
33540
|
/**
|
|
33541
33541
|
* License service.
|
|
33542
33542
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
33543
|
-
* @version
|
|
33543
|
+
* @version 135.0.0
|
|
33544
33544
|
*/
|
|
33545
33545
|
|
|
33546
33546
|
/**
|
|
@@ -33778,7 +33778,7 @@ class LocationsApi {
|
|
|
33778
33778
|
/**
|
|
33779
33779
|
* Locations service.
|
|
33780
33780
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
33781
|
-
* @version
|
|
33781
|
+
* @version 135.0.0
|
|
33782
33782
|
*/
|
|
33783
33783
|
|
|
33784
33784
|
/**
|
|
@@ -34014,7 +34014,7 @@ class MessagingApi {
|
|
|
34014
34014
|
/**
|
|
34015
34015
|
* Messaging service.
|
|
34016
34016
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
34017
|
-
* @version
|
|
34017
|
+
* @version 135.0.0
|
|
34018
34018
|
*/
|
|
34019
34019
|
|
|
34020
34020
|
/**
|
|
@@ -34165,7 +34165,7 @@ class MobileDevicesApi {
|
|
|
34165
34165
|
/**
|
|
34166
34166
|
* MobileDevices service.
|
|
34167
34167
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
34168
|
-
* @version
|
|
34168
|
+
* @version 135.0.0
|
|
34169
34169
|
*/
|
|
34170
34170
|
|
|
34171
34171
|
/**
|
|
@@ -34316,7 +34316,7 @@ class NotificationsApi {
|
|
|
34316
34316
|
/**
|
|
34317
34317
|
* Notifications service.
|
|
34318
34318
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
34319
|
-
* @version
|
|
34319
|
+
* @version 135.0.0
|
|
34320
34320
|
*/
|
|
34321
34321
|
|
|
34322
34322
|
/**
|
|
@@ -34541,7 +34541,7 @@ class OAuthApi {
|
|
|
34541
34541
|
/**
|
|
34542
34542
|
* OAuth service.
|
|
34543
34543
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
34544
|
-
* @version
|
|
34544
|
+
* @version 135.0.0
|
|
34545
34545
|
*/
|
|
34546
34546
|
|
|
34547
34547
|
/**
|
|
@@ -34907,7 +34907,7 @@ class ObjectsApi {
|
|
|
34907
34907
|
/**
|
|
34908
34908
|
* Objects service.
|
|
34909
34909
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
34910
|
-
* @version
|
|
34910
|
+
* @version 135.0.0
|
|
34911
34911
|
*/
|
|
34912
34912
|
|
|
34913
34913
|
/**
|
|
@@ -35178,7 +35178,7 @@ class OrganizationApi {
|
|
|
35178
35178
|
/**
|
|
35179
35179
|
* Organization service.
|
|
35180
35180
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
35181
|
-
* @version
|
|
35181
|
+
* @version 135.0.0
|
|
35182
35182
|
*/
|
|
35183
35183
|
|
|
35184
35184
|
/**
|
|
@@ -35581,7 +35581,7 @@ class OrganizationAuthorizationApi {
|
|
|
35581
35581
|
/**
|
|
35582
35582
|
* OrganizationAuthorization service.
|
|
35583
35583
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
35584
|
-
* @version
|
|
35584
|
+
* @version 135.0.0
|
|
35585
35585
|
*/
|
|
35586
35586
|
|
|
35587
35587
|
/**
|
|
@@ -36506,7 +36506,7 @@ class OutboundApi {
|
|
|
36506
36506
|
/**
|
|
36507
36507
|
* Outbound service.
|
|
36508
36508
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
36509
|
-
* @version
|
|
36509
|
+
* @version 135.0.0
|
|
36510
36510
|
*/
|
|
36511
36511
|
|
|
36512
36512
|
/**
|
|
@@ -36856,6 +36856,31 @@ class OutboundApi {
|
|
|
36856
36856
|
);
|
|
36857
36857
|
}
|
|
36858
36858
|
|
|
36859
|
+
/**
|
|
36860
|
+
* Reset messaging campaign progress and recycle the messaging campaign
|
|
36861
|
+
*
|
|
36862
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
36863
|
+
*/
|
|
36864
|
+
deleteOutboundMessagingcampaignProgress(messagingCampaignId) {
|
|
36865
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
36866
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
36867
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling deleteOutboundMessagingcampaignProgress';
|
|
36868
|
+
}
|
|
36869
|
+
|
|
36870
|
+
return this.apiClient.callApi(
|
|
36871
|
+
'/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress',
|
|
36872
|
+
'DELETE',
|
|
36873
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
36874
|
+
{ },
|
|
36875
|
+
{ },
|
|
36876
|
+
{ },
|
|
36877
|
+
null,
|
|
36878
|
+
['PureCloud OAuth'],
|
|
36879
|
+
['application/json'],
|
|
36880
|
+
['application/json']
|
|
36881
|
+
);
|
|
36882
|
+
}
|
|
36883
|
+
|
|
36859
36884
|
/**
|
|
36860
36885
|
* Delete a Rule Set.
|
|
36861
36886
|
*
|
|
@@ -39536,7 +39561,7 @@ class PresenceApi {
|
|
|
39536
39561
|
/**
|
|
39537
39562
|
* Presence service.
|
|
39538
39563
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
39539
|
-
* @version
|
|
39564
|
+
* @version 135.0.0
|
|
39540
39565
|
*/
|
|
39541
39566
|
|
|
39542
39567
|
/**
|
|
@@ -39682,31 +39707,6 @@ class PresenceApi {
|
|
|
39682
39707
|
);
|
|
39683
39708
|
}
|
|
39684
39709
|
|
|
39685
|
-
/**
|
|
39686
|
-
* Get a user's Microsoft Teams presence.
|
|
39687
|
-
* 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.
|
|
39688
|
-
* @param {String} userId user Id
|
|
39689
|
-
*/
|
|
39690
|
-
getUserPresencesMicrosoftteams(userId) {
|
|
39691
|
-
// verify the required parameter 'userId' is set
|
|
39692
|
-
if (userId === undefined || userId === null) {
|
|
39693
|
-
throw 'Missing the required parameter "userId" when calling getUserPresencesMicrosoftteams';
|
|
39694
|
-
}
|
|
39695
|
-
|
|
39696
|
-
return this.apiClient.callApi(
|
|
39697
|
-
'/api/v2/users/{userId}/presences/microsoftteams',
|
|
39698
|
-
'GET',
|
|
39699
|
-
{ 'userId': userId },
|
|
39700
|
-
{ },
|
|
39701
|
-
{ },
|
|
39702
|
-
{ },
|
|
39703
|
-
null,
|
|
39704
|
-
['PureCloud OAuth'],
|
|
39705
|
-
['application/json'],
|
|
39706
|
-
['application/json']
|
|
39707
|
-
);
|
|
39708
|
-
}
|
|
39709
|
-
|
|
39710
39710
|
/**
|
|
39711
39711
|
* Get a user's Genesys Cloud presence.
|
|
39712
39712
|
* Get the default Genesys Cloud user presence source PURECLOUD
|
|
@@ -39732,31 +39732,6 @@ class PresenceApi {
|
|
|
39732
39732
|
);
|
|
39733
39733
|
}
|
|
39734
39734
|
|
|
39735
|
-
/**
|
|
39736
|
-
* Get a user's Zoom Phone presence.
|
|
39737
|
-
* 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.
|
|
39738
|
-
* @param {String} userId user Id
|
|
39739
|
-
*/
|
|
39740
|
-
getUserPresencesZoomphone(userId) {
|
|
39741
|
-
// verify the required parameter 'userId' is set
|
|
39742
|
-
if (userId === undefined || userId === null) {
|
|
39743
|
-
throw 'Missing the required parameter "userId" when calling getUserPresencesZoomphone';
|
|
39744
|
-
}
|
|
39745
|
-
|
|
39746
|
-
return this.apiClient.callApi(
|
|
39747
|
-
'/api/v2/users/{userId}/presences/zoomphone',
|
|
39748
|
-
'GET',
|
|
39749
|
-
{ 'userId': userId },
|
|
39750
|
-
{ },
|
|
39751
|
-
{ },
|
|
39752
|
-
{ },
|
|
39753
|
-
null,
|
|
39754
|
-
['PureCloud OAuth'],
|
|
39755
|
-
['application/json'],
|
|
39756
|
-
['application/json']
|
|
39757
|
-
);
|
|
39758
|
-
}
|
|
39759
|
-
|
|
39760
39735
|
/**
|
|
39761
39736
|
* Patch a user's Presence
|
|
39762
39737
|
* 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.
|
|
@@ -39908,7 +39883,7 @@ class QualityApi {
|
|
|
39908
39883
|
/**
|
|
39909
39884
|
* Quality service.
|
|
39910
39885
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
39911
|
-
* @version
|
|
39886
|
+
* @version 135.0.0
|
|
39912
39887
|
*/
|
|
39913
39888
|
|
|
39914
39889
|
/**
|
|
@@ -41486,7 +41461,7 @@ class RecordingApi {
|
|
|
41486
41461
|
/**
|
|
41487
41462
|
* Recording service.
|
|
41488
41463
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
41489
|
-
* @version
|
|
41464
|
+
* @version 135.0.0
|
|
41490
41465
|
*/
|
|
41491
41466
|
|
|
41492
41467
|
/**
|
|
@@ -42009,6 +41984,7 @@ class RecordingApi {
|
|
|
42009
41984
|
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
42010
41985
|
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
42011
41986
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
41987
|
+
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
42012
41988
|
*/
|
|
42013
41989
|
getRecordingCrossplatformMediaretentionpolicies(opts) {
|
|
42014
41990
|
opts = opts || {};
|
|
@@ -42018,7 +41994,7 @@ class RecordingApi {
|
|
|
42018
41994
|
'/api/v2/recording/crossplatform/mediaretentionpolicies',
|
|
42019
41995
|
'GET',
|
|
42020
41996
|
{ },
|
|
42021
|
-
{ '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'] },
|
|
41997
|
+
{ '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'] },
|
|
42022
41998
|
{ },
|
|
42023
41999
|
{ },
|
|
42024
42000
|
null,
|
|
@@ -42200,6 +42176,7 @@ class RecordingApi {
|
|
|
42200
42176
|
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
42201
42177
|
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
42202
42178
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
42179
|
+
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
42203
42180
|
*/
|
|
42204
42181
|
getRecordingMediaretentionpolicies(opts) {
|
|
42205
42182
|
opts = opts || {};
|
|
@@ -42209,7 +42186,7 @@ class RecordingApi {
|
|
|
42209
42186
|
'/api/v2/recording/mediaretentionpolicies',
|
|
42210
42187
|
'GET',
|
|
42211
42188
|
{ },
|
|
42212
|
-
{ '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'] },
|
|
42189
|
+
{ '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'] },
|
|
42213
42190
|
{ },
|
|
42214
42191
|
{ },
|
|
42215
42192
|
null,
|
|
@@ -43012,7 +42989,7 @@ class ResponseManagementApi {
|
|
|
43012
42989
|
/**
|
|
43013
42990
|
* ResponseManagement service.
|
|
43014
42991
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
43015
|
-
* @version
|
|
42992
|
+
* @version 135.0.0
|
|
43016
42993
|
*/
|
|
43017
42994
|
|
|
43018
42995
|
/**
|
|
@@ -43496,7 +43473,7 @@ class RoutingApi {
|
|
|
43496
43473
|
/**
|
|
43497
43474
|
* Routing service.
|
|
43498
43475
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
43499
|
-
* @version
|
|
43476
|
+
* @version 135.0.0
|
|
43500
43477
|
*/
|
|
43501
43478
|
|
|
43502
43479
|
/**
|
|
@@ -46419,7 +46396,7 @@ class SCIMApi {
|
|
|
46419
46396
|
/**
|
|
46420
46397
|
* SCIM service.
|
|
46421
46398
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
46422
|
-
* @version
|
|
46399
|
+
* @version 135.0.0
|
|
46423
46400
|
*/
|
|
46424
46401
|
|
|
46425
46402
|
/**
|
|
@@ -47296,7 +47273,7 @@ class ScriptsApi {
|
|
|
47296
47273
|
/**
|
|
47297
47274
|
* Scripts service.
|
|
47298
47275
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
47299
|
-
* @version
|
|
47276
|
+
* @version 135.0.0
|
|
47300
47277
|
*/
|
|
47301
47278
|
|
|
47302
47279
|
/**
|
|
@@ -47412,6 +47389,7 @@ class ScriptsApi {
|
|
|
47412
47389
|
* @param {Object} opts.sortBy SortBy
|
|
47413
47390
|
* @param {Object} opts.sortOrder SortOrder
|
|
47414
47391
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
47392
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
47415
47393
|
*/
|
|
47416
47394
|
getScripts(opts) {
|
|
47417
47395
|
opts = opts || {};
|
|
@@ -47421,7 +47399,40 @@ class ScriptsApi {
|
|
|
47421
47399
|
'/api/v2/scripts',
|
|
47422
47400
|
'GET',
|
|
47423
47401
|
{ },
|
|
47424
|
-
{ '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'] },
|
|
47402
|
+
{ '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'] },
|
|
47403
|
+
{ },
|
|
47404
|
+
{ },
|
|
47405
|
+
null,
|
|
47406
|
+
['PureCloud OAuth'],
|
|
47407
|
+
['application/json'],
|
|
47408
|
+
['application/json']
|
|
47409
|
+
);
|
|
47410
|
+
}
|
|
47411
|
+
|
|
47412
|
+
/**
|
|
47413
|
+
* Get the metadata for a list of scripts
|
|
47414
|
+
*
|
|
47415
|
+
* @param {Object} opts Optional parameters
|
|
47416
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
47417
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
47418
|
+
* @param {String} opts.expand Expand
|
|
47419
|
+
* @param {String} opts.name Name filter
|
|
47420
|
+
* @param {String} opts.feature Feature filter
|
|
47421
|
+
* @param {String} opts.flowId Secure flow id filter
|
|
47422
|
+
* @param {Object} opts.sortBy SortBy
|
|
47423
|
+
* @param {Object} opts.sortOrder SortOrder
|
|
47424
|
+
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
47425
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
47426
|
+
*/
|
|
47427
|
+
getScriptsDivisionviews(opts) {
|
|
47428
|
+
opts = opts || {};
|
|
47429
|
+
|
|
47430
|
+
|
|
47431
|
+
return this.apiClient.callApi(
|
|
47432
|
+
'/api/v2/scripts/divisionviews',
|
|
47433
|
+
'GET',
|
|
47434
|
+
{ },
|
|
47435
|
+
{ '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'] },
|
|
47425
47436
|
{ },
|
|
47426
47437
|
{ },
|
|
47427
47438
|
null,
|
|
@@ -47442,6 +47453,7 @@ class ScriptsApi {
|
|
|
47442
47453
|
* @param {String} opts.feature Feature filter
|
|
47443
47454
|
* @param {String} opts.flowId Secure flow id filter
|
|
47444
47455
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
47456
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
47445
47457
|
*/
|
|
47446
47458
|
getScriptsPublished(opts) {
|
|
47447
47459
|
opts = opts || {};
|
|
@@ -47451,7 +47463,38 @@ class ScriptsApi {
|
|
|
47451
47463
|
'/api/v2/scripts/published',
|
|
47452
47464
|
'GET',
|
|
47453
47465
|
{ },
|
|
47454
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'] },
|
|
47466
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
47467
|
+
{ },
|
|
47468
|
+
{ },
|
|
47469
|
+
null,
|
|
47470
|
+
['PureCloud OAuth'],
|
|
47471
|
+
['application/json'],
|
|
47472
|
+
['application/json']
|
|
47473
|
+
);
|
|
47474
|
+
}
|
|
47475
|
+
|
|
47476
|
+
/**
|
|
47477
|
+
* Get the published scripts metadata.
|
|
47478
|
+
*
|
|
47479
|
+
* @param {Object} opts Optional parameters
|
|
47480
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
47481
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
47482
|
+
* @param {String} opts.expand Expand
|
|
47483
|
+
* @param {String} opts.name Name filter
|
|
47484
|
+
* @param {String} opts.feature Feature filter
|
|
47485
|
+
* @param {String} opts.flowId Secure flow id filter
|
|
47486
|
+
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
47487
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
47488
|
+
*/
|
|
47489
|
+
getScriptsPublishedDivisionviews(opts) {
|
|
47490
|
+
opts = opts || {};
|
|
47491
|
+
|
|
47492
|
+
|
|
47493
|
+
return this.apiClient.callApi(
|
|
47494
|
+
'/api/v2/scripts/published/divisionviews',
|
|
47495
|
+
'GET',
|
|
47496
|
+
{ },
|
|
47497
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
47455
47498
|
{ },
|
|
47456
47499
|
{ },
|
|
47457
47500
|
null,
|
|
@@ -47649,7 +47692,7 @@ class SearchApi {
|
|
|
47649
47692
|
/**
|
|
47650
47693
|
* Search service.
|
|
47651
47694
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
47652
|
-
* @version
|
|
47695
|
+
* @version 135.0.0
|
|
47653
47696
|
*/
|
|
47654
47697
|
|
|
47655
47698
|
/**
|
|
@@ -48184,7 +48227,7 @@ class SpeechTextAnalyticsApi {
|
|
|
48184
48227
|
/**
|
|
48185
48228
|
* SpeechTextAnalytics service.
|
|
48186
48229
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
48187
|
-
* @version
|
|
48230
|
+
* @version 135.0.0
|
|
48188
48231
|
*/
|
|
48189
48232
|
|
|
48190
48233
|
/**
|
|
@@ -49037,7 +49080,7 @@ class StationsApi {
|
|
|
49037
49080
|
/**
|
|
49038
49081
|
* Stations service.
|
|
49039
49082
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
49040
|
-
* @version
|
|
49083
|
+
* @version 135.0.0
|
|
49041
49084
|
*/
|
|
49042
49085
|
|
|
49043
49086
|
/**
|
|
@@ -49184,7 +49227,7 @@ class SuggestApi {
|
|
|
49184
49227
|
/**
|
|
49185
49228
|
* Suggest service.
|
|
49186
49229
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
49187
|
-
* @version
|
|
49230
|
+
* @version 135.0.0
|
|
49188
49231
|
*/
|
|
49189
49232
|
|
|
49190
49233
|
/**
|
|
@@ -49323,7 +49366,7 @@ class TelephonyApi {
|
|
|
49323
49366
|
/**
|
|
49324
49367
|
* Telephony service.
|
|
49325
49368
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
49326
|
-
* @version
|
|
49369
|
+
* @version 135.0.0
|
|
49327
49370
|
*/
|
|
49328
49371
|
|
|
49329
49372
|
/**
|
|
@@ -49431,7 +49474,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
49431
49474
|
/**
|
|
49432
49475
|
* TelephonyProvidersEdge service.
|
|
49433
49476
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
49434
|
-
* @version
|
|
49477
|
+
* @version 135.0.0
|
|
49435
49478
|
*/
|
|
49436
49479
|
|
|
49437
49480
|
/**
|
|
@@ -50846,7 +50889,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
50846
50889
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
50847
50890
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
50848
50891
|
* @param {String} opts.sortBy Sort by
|
|
50849
|
-
* @param {String} opts._number
|
|
50892
|
+
* @param {String} opts._number Deprecated, filtering by number not supported
|
|
50850
50893
|
*/
|
|
50851
50894
|
getTelephonyProvidersEdgesExtensionpools(opts) {
|
|
50852
50895
|
opts = opts || {};
|
|
@@ -53064,7 +53107,7 @@ class TextbotsApi {
|
|
|
53064
53107
|
/**
|
|
53065
53108
|
* Textbots service.
|
|
53066
53109
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
53067
|
-
* @version
|
|
53110
|
+
* @version 135.0.0
|
|
53068
53111
|
*/
|
|
53069
53112
|
|
|
53070
53113
|
/**
|
|
@@ -53192,7 +53235,7 @@ class TokensApi {
|
|
|
53192
53235
|
/**
|
|
53193
53236
|
* Tokens service.
|
|
53194
53237
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
53195
|
-
* @version
|
|
53238
|
+
* @version 135.0.0
|
|
53196
53239
|
*/
|
|
53197
53240
|
|
|
53198
53241
|
/**
|
|
@@ -53298,7 +53341,7 @@ class UploadsApi {
|
|
|
53298
53341
|
/**
|
|
53299
53342
|
* Uploads service.
|
|
53300
53343
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
53301
|
-
* @version
|
|
53344
|
+
* @version 135.0.0
|
|
53302
53345
|
*/
|
|
53303
53346
|
|
|
53304
53347
|
/**
|
|
@@ -53449,7 +53492,7 @@ class UsageApi {
|
|
|
53449
53492
|
/**
|
|
53450
53493
|
* Usage service.
|
|
53451
53494
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
53452
|
-
* @version
|
|
53495
|
+
* @version 135.0.0
|
|
53453
53496
|
*/
|
|
53454
53497
|
|
|
53455
53498
|
/**
|
|
@@ -53520,7 +53563,7 @@ class UserRecordingsApi {
|
|
|
53520
53563
|
/**
|
|
53521
53564
|
* UserRecordings service.
|
|
53522
53565
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
53523
|
-
* @version
|
|
53566
|
+
* @version 135.0.0
|
|
53524
53567
|
*/
|
|
53525
53568
|
|
|
53526
53569
|
/**
|
|
@@ -53704,7 +53747,7 @@ class UsersApi {
|
|
|
53704
53747
|
/**
|
|
53705
53748
|
* Users service.
|
|
53706
53749
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
53707
|
-
* @version
|
|
53750
|
+
* @version 135.0.0
|
|
53708
53751
|
*/
|
|
53709
53752
|
|
|
53710
53753
|
/**
|
|
@@ -56006,7 +56049,7 @@ class UtilitiesApi {
|
|
|
56006
56049
|
/**
|
|
56007
56050
|
* Utilities service.
|
|
56008
56051
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
56009
|
-
* @version
|
|
56052
|
+
* @version 135.0.0
|
|
56010
56053
|
*/
|
|
56011
56054
|
|
|
56012
56055
|
/**
|
|
@@ -56117,7 +56160,7 @@ class VoicemailApi {
|
|
|
56117
56160
|
/**
|
|
56118
56161
|
* Voicemail service.
|
|
56119
56162
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
56120
|
-
* @version
|
|
56163
|
+
* @version 135.0.0
|
|
56121
56164
|
*/
|
|
56122
56165
|
|
|
56123
56166
|
/**
|
|
@@ -56784,7 +56827,7 @@ class WebChatApi {
|
|
|
56784
56827
|
/**
|
|
56785
56828
|
* WebChat service.
|
|
56786
56829
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
56787
|
-
* @version
|
|
56830
|
+
* @version 135.0.0
|
|
56788
56831
|
*/
|
|
56789
56832
|
|
|
56790
56833
|
/**
|
|
@@ -57328,7 +57371,7 @@ class WebDeploymentsApi {
|
|
|
57328
57371
|
/**
|
|
57329
57372
|
* WebDeployments service.
|
|
57330
57373
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
57331
|
-
* @version
|
|
57374
|
+
* @version 135.0.0
|
|
57332
57375
|
*/
|
|
57333
57376
|
|
|
57334
57377
|
/**
|
|
@@ -57683,7 +57726,7 @@ class WebMessagingApi {
|
|
|
57683
57726
|
/**
|
|
57684
57727
|
* WebMessaging service.
|
|
57685
57728
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
57686
|
-
* @version
|
|
57729
|
+
* @version 135.0.0
|
|
57687
57730
|
*/
|
|
57688
57731
|
|
|
57689
57732
|
/**
|
|
@@ -57729,7 +57772,7 @@ class WidgetsApi {
|
|
|
57729
57772
|
/**
|
|
57730
57773
|
* Widgets service.
|
|
57731
57774
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
57732
|
-
* @version
|
|
57775
|
+
* @version 135.0.0
|
|
57733
57776
|
*/
|
|
57734
57777
|
|
|
57735
57778
|
/**
|
|
@@ -57875,7 +57918,7 @@ class WorkforceManagementApi {
|
|
|
57875
57918
|
/**
|
|
57876
57919
|
* WorkforceManagement service.
|
|
57877
57920
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
57878
|
-
* @version
|
|
57921
|
+
* @version 135.0.0
|
|
57879
57922
|
*/
|
|
57880
57923
|
|
|
57881
57924
|
/**
|
|
@@ -58073,7 +58116,7 @@ class WorkforceManagementApi {
|
|
|
58073
58116
|
/**
|
|
58074
58117
|
* Delete a short term forecast
|
|
58075
58118
|
* Must not be tied to any schedules
|
|
58076
|
-
* @param {String} businessUnitId The
|
|
58119
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
58077
58120
|
* @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
|
|
58078
58121
|
* @param {String} forecastId The ID of the forecast
|
|
58079
58122
|
*/
|
|
@@ -58153,7 +58196,7 @@ class WorkforceManagementApi {
|
|
|
58153
58196
|
/**
|
|
58154
58197
|
* Deletes a time off limit object
|
|
58155
58198
|
*
|
|
58156
|
-
* @param {String} managementUnitId The
|
|
58199
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
58157
58200
|
* @param {String} timeOffLimitId The ID of the time off limit object to delete
|
|
58158
58201
|
*/
|
|
58159
58202
|
deleteWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
@@ -58183,7 +58226,7 @@ class WorkforceManagementApi {
|
|
|
58183
58226
|
/**
|
|
58184
58227
|
* Deletes a time off plan
|
|
58185
58228
|
*
|
|
58186
|
-
* @param {String} managementUnitId The management unit
|
|
58229
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
58187
58230
|
* @param {String} timeOffPlanId The ID of the time off plan to delete
|
|
58188
58231
|
*/
|
|
58189
58232
|
deleteWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
@@ -58452,7 +58495,7 @@ class WorkforceManagementApi {
|
|
|
58452
58495
|
/**
|
|
58453
58496
|
* Get intraday planning groups for the given date
|
|
58454
58497
|
*
|
|
58455
|
-
* @param {String} businessUnitId The
|
|
58498
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
58456
58499
|
* @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
|
|
58457
58500
|
*/
|
|
58458
58501
|
getWorkforcemanagementBusinessunitIntradayPlanninggroups(businessUnitId, _date) {
|
|
@@ -58905,7 +58948,7 @@ class WorkforceManagementApi {
|
|
|
58905
58948
|
/**
|
|
58906
58949
|
* Get a short term forecast
|
|
58907
58950
|
*
|
|
58908
|
-
* @param {String} businessUnitId The
|
|
58951
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
58909
58952
|
* @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
|
|
58910
58953
|
* @param {String} forecastId The ID of the forecast
|
|
58911
58954
|
* @param {Object} opts Optional parameters
|
|
@@ -58944,7 +58987,7 @@ class WorkforceManagementApi {
|
|
|
58944
58987
|
/**
|
|
58945
58988
|
* Get the result of a short term forecast calculation
|
|
58946
58989
|
* Includes modifications unless you pass the doNotApplyModifications query parameter
|
|
58947
|
-
* @param {String} businessUnitId The
|
|
58990
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
58948
58991
|
* @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
|
|
58949
58992
|
* @param {String} forecastId The ID of the forecast
|
|
58950
58993
|
* @param {Object} opts Optional parameters
|
|
@@ -58984,7 +59027,7 @@ class WorkforceManagementApi {
|
|
|
58984
59027
|
/**
|
|
58985
59028
|
* Gets the forecast generation results
|
|
58986
59029
|
*
|
|
58987
|
-
* @param {String} businessUnitId The
|
|
59030
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
58988
59031
|
* @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
|
|
58989
59032
|
* @param {String} forecastId The ID of the forecast
|
|
58990
59033
|
*/
|
|
@@ -59019,7 +59062,7 @@ class WorkforceManagementApi {
|
|
|
59019
59062
|
/**
|
|
59020
59063
|
* Get the result of a long term forecast calculation
|
|
59021
59064
|
* Includes modifications unless you pass the doNotApplyModifications query parameter
|
|
59022
|
-
* @param {String} businessUnitId The
|
|
59065
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
59023
59066
|
* @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
|
|
59024
59067
|
* @param {String} forecastId The ID of the forecast
|
|
59025
59068
|
* @param {Object} opts Optional parameters
|
|
@@ -59058,7 +59101,7 @@ class WorkforceManagementApi {
|
|
|
59058
59101
|
/**
|
|
59059
59102
|
* Gets the forecast planning group snapshot
|
|
59060
59103
|
*
|
|
59061
|
-
* @param {String} businessUnitId The
|
|
59104
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
59062
59105
|
* @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
|
|
59063
59106
|
* @param {String} forecastId The ID of the forecast
|
|
59064
59107
|
*/
|
|
@@ -59093,7 +59136,7 @@ class WorkforceManagementApi {
|
|
|
59093
59136
|
/**
|
|
59094
59137
|
* Get short term forecasts
|
|
59095
59138
|
* 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
|
|
59096
|
-
* @param {String} businessUnitId The
|
|
59139
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
59097
59140
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format or 'recent' (without quotes) to fetch recent forecasts
|
|
59098
59141
|
*/
|
|
59099
59142
|
getWorkforcemanagementBusinessunitWeekShorttermforecasts(businessUnitId, weekDateId) {
|
|
@@ -59311,7 +59354,7 @@ class WorkforceManagementApi {
|
|
|
59311
59354
|
/**
|
|
59312
59355
|
* Get a list of user schedule adherence records for the requested management unit
|
|
59313
59356
|
*
|
|
59314
|
-
* @param {String} managementUnitId The
|
|
59357
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
59315
59358
|
* @param {Object} opts Optional parameters
|
|
59316
59359
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
59317
59360
|
*/
|
|
@@ -59340,7 +59383,7 @@ class WorkforceManagementApi {
|
|
|
59340
59383
|
/**
|
|
59341
59384
|
* Get data for agent in the management unit
|
|
59342
59385
|
*
|
|
59343
|
-
* @param {String} managementUnitId The
|
|
59386
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
59344
59387
|
* @param {String} agentId The agent id
|
|
59345
59388
|
* @param {Object} opts Optional parameters
|
|
59346
59389
|
* @param {Boolean} opts.excludeCapabilities Excludes all capabilities of the agent such as queues, languages, and skills
|
|
@@ -59374,7 +59417,7 @@ class WorkforceManagementApi {
|
|
|
59374
59417
|
/**
|
|
59375
59418
|
* Gets all the shift trades for a given agent
|
|
59376
59419
|
*
|
|
59377
|
-
* @param {String} managementUnitId The
|
|
59420
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
59378
59421
|
* @param {String} agentId The agent id
|
|
59379
59422
|
*/
|
|
59380
59423
|
getWorkforcemanagementManagementunitAgentShifttrades(managementUnitId, agentId) {
|
|
@@ -59404,7 +59447,7 @@ class WorkforceManagementApi {
|
|
|
59404
59447
|
/**
|
|
59405
59448
|
* Gets a summary of all shift trades in the matched state
|
|
59406
59449
|
*
|
|
59407
|
-
* @param {String} managementUnitId The
|
|
59450
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
59408
59451
|
*/
|
|
59409
59452
|
getWorkforcemanagementManagementunitShifttradesMatched(managementUnitId) {
|
|
59410
59453
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -59429,7 +59472,7 @@ class WorkforceManagementApi {
|
|
|
59429
59472
|
/**
|
|
59430
59473
|
* Gets list of users available for whom you can send direct shift trade requests
|
|
59431
59474
|
*
|
|
59432
|
-
* @param {String} managementUnitId The
|
|
59475
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
59433
59476
|
*/
|
|
59434
59477
|
getWorkforcemanagementManagementunitShifttradesUsers(managementUnitId) {
|
|
59435
59478
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -59454,7 +59497,7 @@ class WorkforceManagementApi {
|
|
|
59454
59497
|
/**
|
|
59455
59498
|
* Gets a time off limit object
|
|
59456
59499
|
* Returns properties of time off limit object, but not daily values.
|
|
59457
|
-
* @param {String} managementUnitId The
|
|
59500
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
59458
59501
|
* @param {String} timeOffLimitId The ID of the time off limit to fetch
|
|
59459
59502
|
*/
|
|
59460
59503
|
getWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
@@ -59484,7 +59527,7 @@ class WorkforceManagementApi {
|
|
|
59484
59527
|
/**
|
|
59485
59528
|
* Gets a list of time off limit objects under management unit.
|
|
59486
59529
|
* Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.
|
|
59487
|
-
* @param {String} managementUnitId The
|
|
59530
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
59488
59531
|
*/
|
|
59489
59532
|
getWorkforcemanagementManagementunitTimeofflimits(managementUnitId) {
|
|
59490
59533
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -59509,7 +59552,7 @@ class WorkforceManagementApi {
|
|
|
59509
59552
|
/**
|
|
59510
59553
|
* Gets a time off plan
|
|
59511
59554
|
*
|
|
59512
|
-
* @param {String} managementUnitId The management unit
|
|
59555
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
59513
59556
|
* @param {String} timeOffPlanId The ID of the time off plan to fetch
|
|
59514
59557
|
*/
|
|
59515
59558
|
getWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
@@ -59539,7 +59582,7 @@ class WorkforceManagementApi {
|
|
|
59539
59582
|
/**
|
|
59540
59583
|
* Gets a list of time off plans
|
|
59541
59584
|
*
|
|
59542
|
-
* @param {String} managementUnitId The management unit
|
|
59585
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
59543
59586
|
*/
|
|
59544
59587
|
getWorkforcemanagementManagementunitTimeoffplans(managementUnitId) {
|
|
59545
59588
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -59564,7 +59607,7 @@ class WorkforceManagementApi {
|
|
|
59564
59607
|
/**
|
|
59565
59608
|
* Get a time off request
|
|
59566
59609
|
*
|
|
59567
|
-
* @param {String} managementUnitId The
|
|
59610
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
59568
59611
|
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
59569
59612
|
* @param {String} timeOffRequestId Time Off Request Id
|
|
59570
59613
|
*/
|
|
@@ -59599,7 +59642,7 @@ class WorkforceManagementApi {
|
|
|
59599
59642
|
/**
|
|
59600
59643
|
* Retrieves time off limit, allocated and waitlisted values according to specific time off request
|
|
59601
59644
|
*
|
|
59602
|
-
* @param {String} managementUnitId The
|
|
59645
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
59603
59646
|
* @param {String} userId The userId to whom the time off request applies.
|
|
59604
59647
|
* @param {String} timeOffRequestId The ID of the time off request, which dates and activityCodeId determine limit values to retrieve
|
|
59605
59648
|
*/
|
|
@@ -59634,7 +59677,7 @@ class WorkforceManagementApi {
|
|
|
59634
59677
|
/**
|
|
59635
59678
|
* Get a list of time off requests for a given user
|
|
59636
59679
|
*
|
|
59637
|
-
* @param {String} managementUnitId The
|
|
59680
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
59638
59681
|
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
59639
59682
|
* @param {Object} opts Optional parameters
|
|
59640
59683
|
* @param {Boolean} opts.recentlyReviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
|
|
@@ -59668,7 +59711,7 @@ class WorkforceManagementApi {
|
|
|
59668
59711
|
/**
|
|
59669
59712
|
* Get users in the management unit
|
|
59670
59713
|
*
|
|
59671
|
-
* @param {String} managementUnitId The
|
|
59714
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
59672
59715
|
*/
|
|
59673
59716
|
getWorkforcemanagementManagementunitUsers(managementUnitId) {
|
|
59674
59717
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -59769,7 +59812,7 @@ class WorkforceManagementApi {
|
|
|
59769
59812
|
/**
|
|
59770
59813
|
* Gets all the shift trades for a given week
|
|
59771
59814
|
*
|
|
59772
|
-
* @param {String} managementUnitId The
|
|
59815
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
59773
59816
|
* @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
|
|
59774
59817
|
* @param {Object} opts Optional parameters
|
|
59775
59818
|
* @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
|
|
@@ -60042,7 +60085,7 @@ class WorkforceManagementApi {
|
|
|
60042
60085
|
/**
|
|
60043
60086
|
* Get a time off request for the current user
|
|
60044
60087
|
*
|
|
60045
|
-
* @param {String} timeOffRequestId
|
|
60088
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
60046
60089
|
*/
|
|
60047
60090
|
getWorkforcemanagementTimeoffrequest(timeOffRequestId) {
|
|
60048
60091
|
// verify the required parameter 'timeOffRequestId' is set
|
|
@@ -60067,7 +60110,7 @@ class WorkforceManagementApi {
|
|
|
60067
60110
|
/**
|
|
60068
60111
|
* Get the daily waitlist positions of a time off request for the current user
|
|
60069
60112
|
*
|
|
60070
|
-
* @param {String} timeOffRequestId
|
|
60113
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
60071
60114
|
*/
|
|
60072
60115
|
getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId) {
|
|
60073
60116
|
// verify the required parameter 'timeOffRequestId' is set
|
|
@@ -60310,7 +60353,7 @@ class WorkforceManagementApi {
|
|
|
60310
60353
|
/**
|
|
60311
60354
|
* Updates a time off limit object.
|
|
60312
60355
|
* Updates time off limit object properties, but not daily values.
|
|
60313
|
-
* @param {String} managementUnitId The
|
|
60356
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
60314
60357
|
* @param {String} timeOffLimitId The id of time off limit object to update
|
|
60315
60358
|
* @param {Object} opts Optional parameters
|
|
60316
60359
|
* @param {Object} opts.body body
|
|
@@ -60344,7 +60387,7 @@ class WorkforceManagementApi {
|
|
|
60344
60387
|
/**
|
|
60345
60388
|
* Updates a time off plan
|
|
60346
60389
|
*
|
|
60347
|
-
* @param {String} managementUnitId The management unit
|
|
60390
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
60348
60391
|
* @param {String} timeOffPlanId The ID of the time off plan to update
|
|
60349
60392
|
* @param {Object} opts Optional parameters
|
|
60350
60393
|
* @param {Object} opts.body body
|
|
@@ -60378,7 +60421,7 @@ class WorkforceManagementApi {
|
|
|
60378
60421
|
/**
|
|
60379
60422
|
* Update a time off request
|
|
60380
60423
|
*
|
|
60381
|
-
* @param {String} managementUnitId The
|
|
60424
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
60382
60425
|
* @param {String} userId The id of the user the requested time off request belongs to
|
|
60383
60426
|
* @param {String} timeOffRequestId The id of the time off request to update
|
|
60384
60427
|
* @param {Object} opts Optional parameters
|
|
@@ -60417,7 +60460,7 @@ class WorkforceManagementApi {
|
|
|
60417
60460
|
/**
|
|
60418
60461
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
60419
60462
|
*
|
|
60420
|
-
* @param {String} managementUnitId The
|
|
60463
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
60421
60464
|
* @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
|
|
60422
60465
|
* @param {Object} body body
|
|
60423
60466
|
* @param {String} tradeId The ID of the shift trade to update
|
|
@@ -60526,7 +60569,7 @@ class WorkforceManagementApi {
|
|
|
60526
60569
|
/**
|
|
60527
60570
|
* Update a time off request for the current user
|
|
60528
60571
|
*
|
|
60529
|
-
* @param {String} timeOffRequestId
|
|
60572
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
60530
60573
|
* @param {Object} opts Optional parameters
|
|
60531
60574
|
* @param {Object} opts.body body
|
|
60532
60575
|
*/
|
|
@@ -60663,7 +60706,7 @@ class WorkforceManagementApi {
|
|
|
60663
60706
|
/**
|
|
60664
60707
|
* Get intraday data for the given date for the requested planningGroupIds
|
|
60665
60708
|
*
|
|
60666
|
-
* @param {String} businessUnitId The
|
|
60709
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
60667
60710
|
* @param {Object} opts Optional parameters
|
|
60668
60711
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
60669
60712
|
* @param {Object} opts.body body
|
|
@@ -61096,7 +61139,7 @@ class WorkforceManagementApi {
|
|
|
61096
61139
|
/**
|
|
61097
61140
|
* Copy a short term forecast
|
|
61098
61141
|
*
|
|
61099
|
-
* @param {String} businessUnitId The
|
|
61142
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
61100
61143
|
* @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
|
|
61101
61144
|
* @param {String} forecastId The ID of the forecast to copy
|
|
61102
61145
|
* @param {Object} body body
|
|
@@ -61140,7 +61183,7 @@ class WorkforceManagementApi {
|
|
|
61140
61183
|
/**
|
|
61141
61184
|
* Generate a short term forecast
|
|
61142
61185
|
*
|
|
61143
|
-
* @param {String} businessUnitId The
|
|
61186
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
61144
61187
|
* @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
|
|
61145
61188
|
* @param {Object} body
|
|
61146
61189
|
* @param {Object} opts Optional parameters
|
|
@@ -61179,7 +61222,7 @@ class WorkforceManagementApi {
|
|
|
61179
61222
|
/**
|
|
61180
61223
|
* Starts importing the uploaded short term forecast
|
|
61181
61224
|
* Call after uploading the forecast data to the url supplied by the /import/uploadurl route
|
|
61182
|
-
* @param {String} businessUnitId The
|
|
61225
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
61183
61226
|
* @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
|
|
61184
61227
|
* @param {Object} body
|
|
61185
61228
|
*/
|
|
@@ -61214,7 +61257,7 @@ class WorkforceManagementApi {
|
|
|
61214
61257
|
/**
|
|
61215
61258
|
* Creates a signed upload URL for importing a short term forecast
|
|
61216
61259
|
* Once the upload is complete, call the /import route to start the short term forecast import process
|
|
61217
|
-
* @param {String} businessUnitId The
|
|
61260
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
61218
61261
|
* @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
|
|
61219
61262
|
* @param {Object} body body
|
|
61220
61263
|
*/
|
|
@@ -61341,7 +61384,7 @@ class WorkforceManagementApi {
|
|
|
61341
61384
|
/**
|
|
61342
61385
|
* Query published schedules for given given time range for set of users
|
|
61343
61386
|
*
|
|
61344
|
-
* @param {String} managementUnitId The
|
|
61387
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
61345
61388
|
* @param {Object} opts Optional parameters
|
|
61346
61389
|
* @param {Object} opts.body body
|
|
61347
61390
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
@@ -61372,7 +61415,7 @@ class WorkforceManagementApi {
|
|
|
61372
61415
|
/**
|
|
61373
61416
|
* Request a historical adherence report
|
|
61374
61417
|
* The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
|
|
61375
|
-
* @param {String} managementUnitId The
|
|
61418
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
61376
61419
|
* @param {Object} opts Optional parameters
|
|
61377
61420
|
* @param {Object} opts.body body
|
|
61378
61421
|
*/
|
|
@@ -61430,7 +61473,7 @@ class WorkforceManagementApi {
|
|
|
61430
61473
|
/**
|
|
61431
61474
|
* Query published schedules for given given time range for set of users
|
|
61432
61475
|
*
|
|
61433
|
-
* @param {String} managementUnitId The
|
|
61476
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
61434
61477
|
* @param {Object} opts Optional parameters
|
|
61435
61478
|
* @param {Object} opts.body body
|
|
61436
61479
|
*/
|
|
@@ -61459,7 +61502,7 @@ class WorkforceManagementApi {
|
|
|
61459
61502
|
/**
|
|
61460
61503
|
* Creates a new time off limit object under management unit.
|
|
61461
61504
|
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
61462
|
-
* @param {String} managementUnitId The
|
|
61505
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
61463
61506
|
* @param {Object} opts Optional parameters
|
|
61464
61507
|
* @param {Object} opts.body body
|
|
61465
61508
|
*/
|
|
@@ -61488,7 +61531,7 @@ class WorkforceManagementApi {
|
|
|
61488
61531
|
/**
|
|
61489
61532
|
* Retrieves time off limit related values based on a given set of filters.
|
|
61490
61533
|
*
|
|
61491
|
-
* @param {String} managementUnitId The
|
|
61534
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
61492
61535
|
* @param {Object} opts Optional parameters
|
|
61493
61536
|
* @param {Object} opts.body body
|
|
61494
61537
|
*/
|
|
@@ -61517,7 +61560,7 @@ class WorkforceManagementApi {
|
|
|
61517
61560
|
/**
|
|
61518
61561
|
* Creates a new time off plan
|
|
61519
61562
|
*
|
|
61520
|
-
* @param {String} managementUnitId The management unit
|
|
61563
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
61521
61564
|
* @param {Object} opts Optional parameters
|
|
61522
61565
|
* @param {Object} opts.body body
|
|
61523
61566
|
*/
|
|
@@ -61546,7 +61589,7 @@ class WorkforceManagementApi {
|
|
|
61546
61589
|
/**
|
|
61547
61590
|
* Create a new time off request
|
|
61548
61591
|
*
|
|
61549
|
-
* @param {String} managementUnitId The
|
|
61592
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
61550
61593
|
* @param {Object} opts Optional parameters
|
|
61551
61594
|
* @param {Object} opts.body body
|
|
61552
61595
|
*/
|
|
@@ -61575,7 +61618,7 @@ class WorkforceManagementApi {
|
|
|
61575
61618
|
/**
|
|
61576
61619
|
* Fetches time off requests matching the conditions specified in the request body
|
|
61577
61620
|
* 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
|
|
61578
|
-
* @param {String} managementUnitId The
|
|
61621
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
61579
61622
|
* @param {Object} opts Optional parameters
|
|
61580
61623
|
* @param {Object} opts.body body
|
|
61581
61624
|
*/
|
|
@@ -61604,7 +61647,7 @@ class WorkforceManagementApi {
|
|
|
61604
61647
|
/**
|
|
61605
61648
|
* Retrieves daily waitlist position for a list of time off requests
|
|
61606
61649
|
*
|
|
61607
|
-
* @param {String} managementUnitId The
|
|
61650
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
61608
61651
|
* @param {Object} opts Optional parameters
|
|
61609
61652
|
* @param {Object} opts.body body
|
|
61610
61653
|
*/
|
|
@@ -61633,7 +61676,7 @@ class WorkforceManagementApi {
|
|
|
61633
61676
|
/**
|
|
61634
61677
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
61635
61678
|
*
|
|
61636
|
-
* @param {String} managementUnitId The
|
|
61679
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
61637
61680
|
* @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
|
|
61638
61681
|
* @param {Object} body body
|
|
61639
61682
|
* @param {String} tradeId The ID of the shift trade to update
|
|
@@ -61673,7 +61716,7 @@ class WorkforceManagementApi {
|
|
|
61673
61716
|
/**
|
|
61674
61717
|
* Adds a shift trade
|
|
61675
61718
|
*
|
|
61676
|
-
* @param {String} managementUnitId The
|
|
61719
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
61677
61720
|
* @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
|
|
61678
61721
|
* @param {Object} body body
|
|
61679
61722
|
*/
|
|
@@ -61708,7 +61751,7 @@ class WorkforceManagementApi {
|
|
|
61708
61751
|
/**
|
|
61709
61752
|
* Searches for potential shift trade matches for the current agent
|
|
61710
61753
|
*
|
|
61711
|
-
* @param {String} managementUnitId The
|
|
61754
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
61712
61755
|
* @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
|
|
61713
61756
|
* @param {Object} body body
|
|
61714
61757
|
*/
|
|
@@ -61743,7 +61786,7 @@ class WorkforceManagementApi {
|
|
|
61743
61786
|
/**
|
|
61744
61787
|
* Updates the state of a batch of shift trades
|
|
61745
61788
|
* Admin functionality is not supported with \"mine\".
|
|
61746
|
-
* @param {String} managementUnitId The
|
|
61789
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
61747
61790
|
* @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
|
|
61748
61791
|
* @param {Object} body body
|
|
61749
61792
|
* @param {Object} opts Optional parameters
|
|
@@ -62064,7 +62107,7 @@ class WorkforceManagementApi {
|
|
|
62064
62107
|
/**
|
|
62065
62108
|
* Sets daily values for a date range of time off limit object
|
|
62066
62109
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
62067
|
-
* @param {String} managementUnitId The
|
|
62110
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
62068
62111
|
* @param {String} timeOffLimitId The ID of the time off limit object to set values for
|
|
62069
62112
|
* @param {Object} opts Optional parameters
|
|
62070
62113
|
* @param {Object} opts.body body
|
|
@@ -62126,7 +62169,7 @@ class WorkforceManagementApi {
|
|
|
62126
62169
|
* </pre>
|
|
62127
62170
|
* </p>
|
|
62128
62171
|
* @module purecloud-platform-client-v2/index
|
|
62129
|
-
* @version
|
|
62172
|
+
* @version 135.0.0
|
|
62130
62173
|
*/
|
|
62131
62174
|
class platformClient {
|
|
62132
62175
|
constructor() {
|