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
|
@@ -393,7 +393,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
393
393
|
|
|
394
394
|
/**
|
|
395
395
|
* @module purecloud-platform-client-v2/ApiClient
|
|
396
|
-
* @version
|
|
396
|
+
* @version 135.0.0
|
|
397
397
|
*/
|
|
398
398
|
class ApiClient {
|
|
399
399
|
/**
|
|
@@ -1340,7 +1340,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1340
1340
|
|
|
1341
1341
|
// set header parameters
|
|
1342
1342
|
request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
|
|
1343
|
-
//request.set({ 'purecloud-sdk': '
|
|
1343
|
+
//request.set({ 'purecloud-sdk': '135.0.0' });
|
|
1344
1344
|
|
|
1345
1345
|
// set request timeout
|
|
1346
1346
|
request.timeout(that.timeout);
|
|
@@ -1440,7 +1440,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1440
1440
|
/**
|
|
1441
1441
|
* Alerting service.
|
|
1442
1442
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1443
|
-
* @version
|
|
1443
|
+
* @version 135.0.0
|
|
1444
1444
|
*/
|
|
1445
1445
|
|
|
1446
1446
|
/**
|
|
@@ -1754,7 +1754,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1754
1754
|
/**
|
|
1755
1755
|
* Analytics service.
|
|
1756
1756
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1757
|
-
* @version
|
|
1757
|
+
* @version 135.0.0
|
|
1758
1758
|
*/
|
|
1759
1759
|
|
|
1760
1760
|
/**
|
|
@@ -2936,7 +2936,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2936
2936
|
/**
|
|
2937
2937
|
* Architect service.
|
|
2938
2938
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2939
|
-
* @version
|
|
2939
|
+
* @version 135.0.0
|
|
2940
2940
|
*/
|
|
2941
2941
|
|
|
2942
2942
|
/**
|
|
@@ -5932,7 +5932,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5932
5932
|
/**
|
|
5933
5933
|
* Audit service.
|
|
5934
5934
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
5935
|
-
* @version
|
|
5935
|
+
* @version 135.0.0
|
|
5936
5936
|
*/
|
|
5937
5937
|
|
|
5938
5938
|
/**
|
|
@@ -6103,7 +6103,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6103
6103
|
/**
|
|
6104
6104
|
* Authorization service.
|
|
6105
6105
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6106
|
-
* @version
|
|
6106
|
+
* @version 135.0.0
|
|
6107
6107
|
*/
|
|
6108
6108
|
|
|
6109
6109
|
/**
|
|
@@ -7286,7 +7286,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7286
7286
|
/**
|
|
7287
7287
|
* Billing service.
|
|
7288
7288
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7289
|
-
* @version
|
|
7289
|
+
* @version 135.0.0
|
|
7290
7290
|
*/
|
|
7291
7291
|
|
|
7292
7292
|
/**
|
|
@@ -7366,7 +7366,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7366
7366
|
/**
|
|
7367
7367
|
* Chat service.
|
|
7368
7368
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7369
|
-
* @version
|
|
7369
|
+
* @version 135.0.0
|
|
7370
7370
|
*/
|
|
7371
7371
|
|
|
7372
7372
|
/**
|
|
@@ -7457,7 +7457,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7457
7457
|
/**
|
|
7458
7458
|
* Coaching service.
|
|
7459
7459
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7460
|
-
* @version
|
|
7460
|
+
* @version 135.0.0
|
|
7461
7461
|
*/
|
|
7462
7462
|
|
|
7463
7463
|
/**
|
|
@@ -8034,7 +8034,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8034
8034
|
/**
|
|
8035
8035
|
* ContentManagement service.
|
|
8036
8036
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8037
|
-
* @version
|
|
8037
|
+
* @version 135.0.0
|
|
8038
8038
|
*/
|
|
8039
8039
|
|
|
8040
8040
|
/**
|
|
@@ -9174,7 +9174,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9174
9174
|
/**
|
|
9175
9175
|
* Conversations service.
|
|
9176
9176
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9177
|
-
* @version
|
|
9177
|
+
* @version 135.0.0
|
|
9178
9178
|
*/
|
|
9179
9179
|
|
|
9180
9180
|
/**
|
|
@@ -11079,7 +11079,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11079
11079
|
/**
|
|
11080
11080
|
* Get a list of Messaging Stickers
|
|
11081
11081
|
*
|
|
11082
|
-
* @param {
|
|
11082
|
+
* @param {Object} messengerType Messenger Type
|
|
11083
11083
|
* @param {Object} opts Optional parameters
|
|
11084
11084
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
11085
11085
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
@@ -11267,7 +11267,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11267
11267
|
}
|
|
11268
11268
|
|
|
11269
11269
|
/**
|
|
11270
|
-
* Update a conversation by setting
|
|
11270
|
+
* Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
11271
11271
|
*
|
|
11272
11272
|
* @param {String} conversationId conversationId
|
|
11273
11273
|
* @param {Object} body Conversation
|
|
@@ -13838,7 +13838,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13838
13838
|
/**
|
|
13839
13839
|
* DataExtensions service.
|
|
13840
13840
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
13841
|
-
* @version
|
|
13841
|
+
* @version 135.0.0
|
|
13842
13842
|
*/
|
|
13843
13843
|
|
|
13844
13844
|
/**
|
|
@@ -13924,7 +13924,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13924
13924
|
/**
|
|
13925
13925
|
* ExternalContacts service.
|
|
13926
13926
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
13927
|
-
* @version
|
|
13927
|
+
* @version 135.0.0
|
|
13928
13928
|
*/
|
|
13929
13929
|
|
|
13930
13930
|
/**
|
|
@@ -15667,7 +15667,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15667
15667
|
/**
|
|
15668
15668
|
* Fax service.
|
|
15669
15669
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
15670
|
-
* @version
|
|
15670
|
+
* @version 135.0.0
|
|
15671
15671
|
*/
|
|
15672
15672
|
|
|
15673
15673
|
/**
|
|
@@ -15838,7 +15838,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15838
15838
|
/**
|
|
15839
15839
|
* Flows service.
|
|
15840
15840
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
15841
|
-
* @version
|
|
15841
|
+
* @version 135.0.0
|
|
15842
15842
|
*/
|
|
15843
15843
|
|
|
15844
15844
|
/**
|
|
@@ -15909,7 +15909,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15909
15909
|
/**
|
|
15910
15910
|
* Gamification service.
|
|
15911
15911
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
15912
|
-
* @version
|
|
15912
|
+
* @version 135.0.0
|
|
15913
15913
|
*/
|
|
15914
15914
|
|
|
15915
15915
|
/**
|
|
@@ -17339,7 +17339,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17339
17339
|
/**
|
|
17340
17340
|
* GeneralDataProtectionRegulation service.
|
|
17341
17341
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
17342
|
-
* @version
|
|
17342
|
+
* @version 135.0.0
|
|
17343
17343
|
*/
|
|
17344
17344
|
|
|
17345
17345
|
/**
|
|
@@ -17469,7 +17469,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17469
17469
|
/**
|
|
17470
17470
|
* Geolocation service.
|
|
17471
17471
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
17472
|
-
* @version
|
|
17472
|
+
* @version 135.0.0
|
|
17473
17473
|
*/
|
|
17474
17474
|
|
|
17475
17475
|
/**
|
|
@@ -17600,7 +17600,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17600
17600
|
/**
|
|
17601
17601
|
* Greetings service.
|
|
17602
17602
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
17603
|
-
* @version
|
|
17603
|
+
* @version 135.0.0
|
|
17604
17604
|
*/
|
|
17605
17605
|
|
|
17606
17606
|
/**
|
|
@@ -18055,7 +18055,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18055
18055
|
/**
|
|
18056
18056
|
* Groups service.
|
|
18057
18057
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
18058
|
-
* @version
|
|
18058
|
+
* @version 135.0.0
|
|
18059
18059
|
*/
|
|
18060
18060
|
|
|
18061
18061
|
/**
|
|
@@ -18460,7 +18460,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18460
18460
|
/**
|
|
18461
18461
|
* IdentityProvider service.
|
|
18462
18462
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
18463
|
-
* @version
|
|
18463
|
+
* @version 135.0.0
|
|
18464
18464
|
*/
|
|
18465
18465
|
|
|
18466
18466
|
/**
|
|
@@ -19216,7 +19216,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19216
19216
|
/**
|
|
19217
19217
|
* Integrations service.
|
|
19218
19218
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
19219
|
-
* @version
|
|
19219
|
+
* @version 135.0.0
|
|
19220
19220
|
*/
|
|
19221
19221
|
|
|
19222
19222
|
/**
|
|
@@ -20891,7 +20891,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20891
20891
|
/**
|
|
20892
20892
|
* Journey service.
|
|
20893
20893
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
20894
|
-
* @version
|
|
20894
|
+
* @version 135.0.0
|
|
20895
20895
|
*/
|
|
20896
20896
|
|
|
20897
20897
|
/**
|
|
@@ -21602,7 +21602,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21602
21602
|
/**
|
|
21603
21603
|
* Knowledge service.
|
|
21604
21604
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
21605
|
-
* @version
|
|
21605
|
+
* @version 135.0.0
|
|
21606
21606
|
*/
|
|
21607
21607
|
|
|
21608
21608
|
/**
|
|
@@ -22502,7 +22502,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22502
22502
|
/**
|
|
22503
22503
|
* LanguageUnderstanding service.
|
|
22504
22504
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
22505
|
-
* @version
|
|
22505
|
+
* @version 135.0.0
|
|
22506
22506
|
*/
|
|
22507
22507
|
|
|
22508
22508
|
/**
|
|
@@ -23406,7 +23406,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23406
23406
|
/**
|
|
23407
23407
|
* Languages service.
|
|
23408
23408
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
23409
|
-
* @version
|
|
23409
|
+
* @version 135.0.0
|
|
23410
23410
|
*/
|
|
23411
23411
|
|
|
23412
23412
|
/**
|
|
@@ -23674,7 +23674,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23674
23674
|
/**
|
|
23675
23675
|
* Learning service.
|
|
23676
23676
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
23677
|
-
* @version
|
|
23677
|
+
* @version 135.0.0
|
|
23678
23678
|
*/
|
|
23679
23679
|
|
|
23680
23680
|
/**
|
|
@@ -24265,7 +24265,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24265
24265
|
/**
|
|
24266
24266
|
* License service.
|
|
24267
24267
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
24268
|
-
* @version
|
|
24268
|
+
* @version 135.0.0
|
|
24269
24269
|
*/
|
|
24270
24270
|
|
|
24271
24271
|
/**
|
|
@@ -24503,7 +24503,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24503
24503
|
/**
|
|
24504
24504
|
* Locations service.
|
|
24505
24505
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
24506
|
-
* @version
|
|
24506
|
+
* @version 135.0.0
|
|
24507
24507
|
*/
|
|
24508
24508
|
|
|
24509
24509
|
/**
|
|
@@ -24739,7 +24739,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24739
24739
|
/**
|
|
24740
24740
|
* Messaging service.
|
|
24741
24741
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
24742
|
-
* @version
|
|
24742
|
+
* @version 135.0.0
|
|
24743
24743
|
*/
|
|
24744
24744
|
|
|
24745
24745
|
/**
|
|
@@ -24890,7 +24890,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24890
24890
|
/**
|
|
24891
24891
|
* MobileDevices service.
|
|
24892
24892
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
24893
|
-
* @version
|
|
24893
|
+
* @version 135.0.0
|
|
24894
24894
|
*/
|
|
24895
24895
|
|
|
24896
24896
|
/**
|
|
@@ -25041,7 +25041,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25041
25041
|
/**
|
|
25042
25042
|
* Notifications service.
|
|
25043
25043
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
25044
|
-
* @version
|
|
25044
|
+
* @version 135.0.0
|
|
25045
25045
|
*/
|
|
25046
25046
|
|
|
25047
25047
|
/**
|
|
@@ -25266,7 +25266,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25266
25266
|
/**
|
|
25267
25267
|
* OAuth service.
|
|
25268
25268
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
25269
|
-
* @version
|
|
25269
|
+
* @version 135.0.0
|
|
25270
25270
|
*/
|
|
25271
25271
|
|
|
25272
25272
|
/**
|
|
@@ -25632,7 +25632,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25632
25632
|
/**
|
|
25633
25633
|
* Objects service.
|
|
25634
25634
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
25635
|
-
* @version
|
|
25635
|
+
* @version 135.0.0
|
|
25636
25636
|
*/
|
|
25637
25637
|
|
|
25638
25638
|
/**
|
|
@@ -25903,7 +25903,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25903
25903
|
/**
|
|
25904
25904
|
* Organization service.
|
|
25905
25905
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
25906
|
-
* @version
|
|
25906
|
+
* @version 135.0.0
|
|
25907
25907
|
*/
|
|
25908
25908
|
|
|
25909
25909
|
/**
|
|
@@ -26306,7 +26306,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26306
26306
|
/**
|
|
26307
26307
|
* OrganizationAuthorization service.
|
|
26308
26308
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
26309
|
-
* @version
|
|
26309
|
+
* @version 135.0.0
|
|
26310
26310
|
*/
|
|
26311
26311
|
|
|
26312
26312
|
/**
|
|
@@ -27231,7 +27231,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27231
27231
|
/**
|
|
27232
27232
|
* Outbound service.
|
|
27233
27233
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
27234
|
-
* @version
|
|
27234
|
+
* @version 135.0.0
|
|
27235
27235
|
*/
|
|
27236
27236
|
|
|
27237
27237
|
/**
|
|
@@ -27581,6 +27581,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27581
27581
|
);
|
|
27582
27582
|
}
|
|
27583
27583
|
|
|
27584
|
+
/**
|
|
27585
|
+
* Reset messaging campaign progress and recycle the messaging campaign
|
|
27586
|
+
*
|
|
27587
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
27588
|
+
*/
|
|
27589
|
+
deleteOutboundMessagingcampaignProgress(messagingCampaignId) {
|
|
27590
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
27591
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
27592
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling deleteOutboundMessagingcampaignProgress';
|
|
27593
|
+
}
|
|
27594
|
+
|
|
27595
|
+
return this.apiClient.callApi(
|
|
27596
|
+
'/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress',
|
|
27597
|
+
'DELETE',
|
|
27598
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
27599
|
+
{ },
|
|
27600
|
+
{ },
|
|
27601
|
+
{ },
|
|
27602
|
+
null,
|
|
27603
|
+
['PureCloud OAuth'],
|
|
27604
|
+
['application/json'],
|
|
27605
|
+
['application/json']
|
|
27606
|
+
);
|
|
27607
|
+
}
|
|
27608
|
+
|
|
27584
27609
|
/**
|
|
27585
27610
|
* Delete a Rule Set.
|
|
27586
27611
|
*
|
|
@@ -30261,7 +30286,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30261
30286
|
/**
|
|
30262
30287
|
* Presence service.
|
|
30263
30288
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
30264
|
-
* @version
|
|
30289
|
+
* @version 135.0.0
|
|
30265
30290
|
*/
|
|
30266
30291
|
|
|
30267
30292
|
/**
|
|
@@ -30407,31 +30432,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30407
30432
|
);
|
|
30408
30433
|
}
|
|
30409
30434
|
|
|
30410
|
-
/**
|
|
30411
|
-
* Get a user's Microsoft Teams presence.
|
|
30412
|
-
* 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.
|
|
30413
|
-
* @param {String} userId user Id
|
|
30414
|
-
*/
|
|
30415
|
-
getUserPresencesMicrosoftteams(userId) {
|
|
30416
|
-
// verify the required parameter 'userId' is set
|
|
30417
|
-
if (userId === undefined || userId === null) {
|
|
30418
|
-
throw 'Missing the required parameter "userId" when calling getUserPresencesMicrosoftteams';
|
|
30419
|
-
}
|
|
30420
|
-
|
|
30421
|
-
return this.apiClient.callApi(
|
|
30422
|
-
'/api/v2/users/{userId}/presences/microsoftteams',
|
|
30423
|
-
'GET',
|
|
30424
|
-
{ 'userId': userId },
|
|
30425
|
-
{ },
|
|
30426
|
-
{ },
|
|
30427
|
-
{ },
|
|
30428
|
-
null,
|
|
30429
|
-
['PureCloud OAuth'],
|
|
30430
|
-
['application/json'],
|
|
30431
|
-
['application/json']
|
|
30432
|
-
);
|
|
30433
|
-
}
|
|
30434
|
-
|
|
30435
30435
|
/**
|
|
30436
30436
|
* Get a user's Genesys Cloud presence.
|
|
30437
30437
|
* Get the default Genesys Cloud user presence source PURECLOUD
|
|
@@ -30457,31 +30457,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30457
30457
|
);
|
|
30458
30458
|
}
|
|
30459
30459
|
|
|
30460
|
-
/**
|
|
30461
|
-
* Get a user's Zoom Phone presence.
|
|
30462
|
-
* 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.
|
|
30463
|
-
* @param {String} userId user Id
|
|
30464
|
-
*/
|
|
30465
|
-
getUserPresencesZoomphone(userId) {
|
|
30466
|
-
// verify the required parameter 'userId' is set
|
|
30467
|
-
if (userId === undefined || userId === null) {
|
|
30468
|
-
throw 'Missing the required parameter "userId" when calling getUserPresencesZoomphone';
|
|
30469
|
-
}
|
|
30470
|
-
|
|
30471
|
-
return this.apiClient.callApi(
|
|
30472
|
-
'/api/v2/users/{userId}/presences/zoomphone',
|
|
30473
|
-
'GET',
|
|
30474
|
-
{ 'userId': userId },
|
|
30475
|
-
{ },
|
|
30476
|
-
{ },
|
|
30477
|
-
{ },
|
|
30478
|
-
null,
|
|
30479
|
-
['PureCloud OAuth'],
|
|
30480
|
-
['application/json'],
|
|
30481
|
-
['application/json']
|
|
30482
|
-
);
|
|
30483
|
-
}
|
|
30484
|
-
|
|
30485
30460
|
/**
|
|
30486
30461
|
* Patch a user's Presence
|
|
30487
30462
|
* 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.
|
|
@@ -30633,7 +30608,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30633
30608
|
/**
|
|
30634
30609
|
* Quality service.
|
|
30635
30610
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
30636
|
-
* @version
|
|
30611
|
+
* @version 135.0.0
|
|
30637
30612
|
*/
|
|
30638
30613
|
|
|
30639
30614
|
/**
|
|
@@ -32211,7 +32186,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32211
32186
|
/**
|
|
32212
32187
|
* Recording service.
|
|
32213
32188
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
32214
|
-
* @version
|
|
32189
|
+
* @version 135.0.0
|
|
32215
32190
|
*/
|
|
32216
32191
|
|
|
32217
32192
|
/**
|
|
@@ -32734,6 +32709,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32734
32709
|
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
32735
32710
|
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
32736
32711
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
32712
|
+
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
32737
32713
|
*/
|
|
32738
32714
|
getRecordingCrossplatformMediaretentionpolicies(opts) {
|
|
32739
32715
|
opts = opts || {};
|
|
@@ -32743,7 +32719,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32743
32719
|
'/api/v2/recording/crossplatform/mediaretentionpolicies',
|
|
32744
32720
|
'GET',
|
|
32745
32721
|
{ },
|
|
32746
|
-
{ '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'] },
|
|
32722
|
+
{ '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'] },
|
|
32747
32723
|
{ },
|
|
32748
32724
|
{ },
|
|
32749
32725
|
null,
|
|
@@ -32925,6 +32901,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32925
32901
|
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
32926
32902
|
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
32927
32903
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
32904
|
+
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
32928
32905
|
*/
|
|
32929
32906
|
getRecordingMediaretentionpolicies(opts) {
|
|
32930
32907
|
opts = opts || {};
|
|
@@ -32934,7 +32911,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32934
32911
|
'/api/v2/recording/mediaretentionpolicies',
|
|
32935
32912
|
'GET',
|
|
32936
32913
|
{ },
|
|
32937
|
-
{ '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'] },
|
|
32914
|
+
{ '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'] },
|
|
32938
32915
|
{ },
|
|
32939
32916
|
{ },
|
|
32940
32917
|
null,
|
|
@@ -33737,7 +33714,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33737
33714
|
/**
|
|
33738
33715
|
* ResponseManagement service.
|
|
33739
33716
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
33740
|
-
* @version
|
|
33717
|
+
* @version 135.0.0
|
|
33741
33718
|
*/
|
|
33742
33719
|
|
|
33743
33720
|
/**
|
|
@@ -34221,7 +34198,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34221
34198
|
/**
|
|
34222
34199
|
* Routing service.
|
|
34223
34200
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
34224
|
-
* @version
|
|
34201
|
+
* @version 135.0.0
|
|
34225
34202
|
*/
|
|
34226
34203
|
|
|
34227
34204
|
/**
|
|
@@ -37144,7 +37121,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37144
37121
|
/**
|
|
37145
37122
|
* SCIM service.
|
|
37146
37123
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
37147
|
-
* @version
|
|
37124
|
+
* @version 135.0.0
|
|
37148
37125
|
*/
|
|
37149
37126
|
|
|
37150
37127
|
/**
|
|
@@ -38021,7 +37998,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38021
37998
|
/**
|
|
38022
37999
|
* Scripts service.
|
|
38023
38000
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
38024
|
-
* @version
|
|
38001
|
+
* @version 135.0.0
|
|
38025
38002
|
*/
|
|
38026
38003
|
|
|
38027
38004
|
/**
|
|
@@ -38137,6 +38114,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38137
38114
|
* @param {Object} opts.sortBy SortBy
|
|
38138
38115
|
* @param {Object} opts.sortOrder SortOrder
|
|
38139
38116
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
38117
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
38140
38118
|
*/
|
|
38141
38119
|
getScripts(opts) {
|
|
38142
38120
|
opts = opts || {};
|
|
@@ -38146,7 +38124,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38146
38124
|
'/api/v2/scripts',
|
|
38147
38125
|
'GET',
|
|
38148
38126
|
{ },
|
|
38149
|
-
{ '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'] },
|
|
38127
|
+
{ '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'] },
|
|
38128
|
+
{ },
|
|
38129
|
+
{ },
|
|
38130
|
+
null,
|
|
38131
|
+
['PureCloud OAuth'],
|
|
38132
|
+
['application/json'],
|
|
38133
|
+
['application/json']
|
|
38134
|
+
);
|
|
38135
|
+
}
|
|
38136
|
+
|
|
38137
|
+
/**
|
|
38138
|
+
* Get the metadata for a list of scripts
|
|
38139
|
+
*
|
|
38140
|
+
* @param {Object} opts Optional parameters
|
|
38141
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
38142
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
38143
|
+
* @param {String} opts.expand Expand
|
|
38144
|
+
* @param {String} opts.name Name filter
|
|
38145
|
+
* @param {String} opts.feature Feature filter
|
|
38146
|
+
* @param {String} opts.flowId Secure flow id filter
|
|
38147
|
+
* @param {Object} opts.sortBy SortBy
|
|
38148
|
+
* @param {Object} opts.sortOrder SortOrder
|
|
38149
|
+
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
38150
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
38151
|
+
*/
|
|
38152
|
+
getScriptsDivisionviews(opts) {
|
|
38153
|
+
opts = opts || {};
|
|
38154
|
+
|
|
38155
|
+
|
|
38156
|
+
return this.apiClient.callApi(
|
|
38157
|
+
'/api/v2/scripts/divisionviews',
|
|
38158
|
+
'GET',
|
|
38159
|
+
{ },
|
|
38160
|
+
{ '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'] },
|
|
38150
38161
|
{ },
|
|
38151
38162
|
{ },
|
|
38152
38163
|
null,
|
|
@@ -38167,6 +38178,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38167
38178
|
* @param {String} opts.feature Feature filter
|
|
38168
38179
|
* @param {String} opts.flowId Secure flow id filter
|
|
38169
38180
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
38181
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
38170
38182
|
*/
|
|
38171
38183
|
getScriptsPublished(opts) {
|
|
38172
38184
|
opts = opts || {};
|
|
@@ -38176,7 +38188,38 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38176
38188
|
'/api/v2/scripts/published',
|
|
38177
38189
|
'GET',
|
|
38178
38190
|
{ },
|
|
38179
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'] },
|
|
38191
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
38192
|
+
{ },
|
|
38193
|
+
{ },
|
|
38194
|
+
null,
|
|
38195
|
+
['PureCloud OAuth'],
|
|
38196
|
+
['application/json'],
|
|
38197
|
+
['application/json']
|
|
38198
|
+
);
|
|
38199
|
+
}
|
|
38200
|
+
|
|
38201
|
+
/**
|
|
38202
|
+
* Get the published scripts metadata.
|
|
38203
|
+
*
|
|
38204
|
+
* @param {Object} opts Optional parameters
|
|
38205
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
38206
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
38207
|
+
* @param {String} opts.expand Expand
|
|
38208
|
+
* @param {String} opts.name Name filter
|
|
38209
|
+
* @param {String} opts.feature Feature filter
|
|
38210
|
+
* @param {String} opts.flowId Secure flow id filter
|
|
38211
|
+
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
38212
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
38213
|
+
*/
|
|
38214
|
+
getScriptsPublishedDivisionviews(opts) {
|
|
38215
|
+
opts = opts || {};
|
|
38216
|
+
|
|
38217
|
+
|
|
38218
|
+
return this.apiClient.callApi(
|
|
38219
|
+
'/api/v2/scripts/published/divisionviews',
|
|
38220
|
+
'GET',
|
|
38221
|
+
{ },
|
|
38222
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
38180
38223
|
{ },
|
|
38181
38224
|
{ },
|
|
38182
38225
|
null,
|
|
@@ -38374,7 +38417,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38374
38417
|
/**
|
|
38375
38418
|
* Search service.
|
|
38376
38419
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
38377
|
-
* @version
|
|
38420
|
+
* @version 135.0.0
|
|
38378
38421
|
*/
|
|
38379
38422
|
|
|
38380
38423
|
/**
|
|
@@ -38909,7 +38952,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38909
38952
|
/**
|
|
38910
38953
|
* SpeechTextAnalytics service.
|
|
38911
38954
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
38912
|
-
* @version
|
|
38955
|
+
* @version 135.0.0
|
|
38913
38956
|
*/
|
|
38914
38957
|
|
|
38915
38958
|
/**
|
|
@@ -39762,7 +39805,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39762
39805
|
/**
|
|
39763
39806
|
* Stations service.
|
|
39764
39807
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
39765
|
-
* @version
|
|
39808
|
+
* @version 135.0.0
|
|
39766
39809
|
*/
|
|
39767
39810
|
|
|
39768
39811
|
/**
|
|
@@ -39909,7 +39952,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39909
39952
|
/**
|
|
39910
39953
|
* Suggest service.
|
|
39911
39954
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
39912
|
-
* @version
|
|
39955
|
+
* @version 135.0.0
|
|
39913
39956
|
*/
|
|
39914
39957
|
|
|
39915
39958
|
/**
|
|
@@ -40048,7 +40091,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40048
40091
|
/**
|
|
40049
40092
|
* Telephony service.
|
|
40050
40093
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
40051
|
-
* @version
|
|
40094
|
+
* @version 135.0.0
|
|
40052
40095
|
*/
|
|
40053
40096
|
|
|
40054
40097
|
/**
|
|
@@ -40156,7 +40199,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40156
40199
|
/**
|
|
40157
40200
|
* TelephonyProvidersEdge service.
|
|
40158
40201
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
40159
|
-
* @version
|
|
40202
|
+
* @version 135.0.0
|
|
40160
40203
|
*/
|
|
40161
40204
|
|
|
40162
40205
|
/**
|
|
@@ -41571,7 +41614,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41571
41614
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
41572
41615
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
41573
41616
|
* @param {String} opts.sortBy Sort by
|
|
41574
|
-
* @param {String} opts._number
|
|
41617
|
+
* @param {String} opts._number Deprecated, filtering by number not supported
|
|
41575
41618
|
*/
|
|
41576
41619
|
getTelephonyProvidersEdgesExtensionpools(opts) {
|
|
41577
41620
|
opts = opts || {};
|
|
@@ -43789,7 +43832,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43789
43832
|
/**
|
|
43790
43833
|
* Textbots service.
|
|
43791
43834
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
43792
|
-
* @version
|
|
43835
|
+
* @version 135.0.0
|
|
43793
43836
|
*/
|
|
43794
43837
|
|
|
43795
43838
|
/**
|
|
@@ -43917,7 +43960,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43917
43960
|
/**
|
|
43918
43961
|
* Tokens service.
|
|
43919
43962
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
43920
|
-
* @version
|
|
43963
|
+
* @version 135.0.0
|
|
43921
43964
|
*/
|
|
43922
43965
|
|
|
43923
43966
|
/**
|
|
@@ -44023,7 +44066,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44023
44066
|
/**
|
|
44024
44067
|
* Uploads service.
|
|
44025
44068
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
44026
|
-
* @version
|
|
44069
|
+
* @version 135.0.0
|
|
44027
44070
|
*/
|
|
44028
44071
|
|
|
44029
44072
|
/**
|
|
@@ -44174,7 +44217,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44174
44217
|
/**
|
|
44175
44218
|
* Usage service.
|
|
44176
44219
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
44177
|
-
* @version
|
|
44220
|
+
* @version 135.0.0
|
|
44178
44221
|
*/
|
|
44179
44222
|
|
|
44180
44223
|
/**
|
|
@@ -44245,7 +44288,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44245
44288
|
/**
|
|
44246
44289
|
* UserRecordings service.
|
|
44247
44290
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
44248
|
-
* @version
|
|
44291
|
+
* @version 135.0.0
|
|
44249
44292
|
*/
|
|
44250
44293
|
|
|
44251
44294
|
/**
|
|
@@ -44429,7 +44472,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44429
44472
|
/**
|
|
44430
44473
|
* Users service.
|
|
44431
44474
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
44432
|
-
* @version
|
|
44475
|
+
* @version 135.0.0
|
|
44433
44476
|
*/
|
|
44434
44477
|
|
|
44435
44478
|
/**
|
|
@@ -46731,7 +46774,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46731
46774
|
/**
|
|
46732
46775
|
* Utilities service.
|
|
46733
46776
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
46734
|
-
* @version
|
|
46777
|
+
* @version 135.0.0
|
|
46735
46778
|
*/
|
|
46736
46779
|
|
|
46737
46780
|
/**
|
|
@@ -46842,7 +46885,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46842
46885
|
/**
|
|
46843
46886
|
* Voicemail service.
|
|
46844
46887
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
46845
|
-
* @version
|
|
46888
|
+
* @version 135.0.0
|
|
46846
46889
|
*/
|
|
46847
46890
|
|
|
46848
46891
|
/**
|
|
@@ -47509,7 +47552,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47509
47552
|
/**
|
|
47510
47553
|
* WebChat service.
|
|
47511
47554
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
47512
|
-
* @version
|
|
47555
|
+
* @version 135.0.0
|
|
47513
47556
|
*/
|
|
47514
47557
|
|
|
47515
47558
|
/**
|
|
@@ -48053,7 +48096,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48053
48096
|
/**
|
|
48054
48097
|
* WebDeployments service.
|
|
48055
48098
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
48056
|
-
* @version
|
|
48099
|
+
* @version 135.0.0
|
|
48057
48100
|
*/
|
|
48058
48101
|
|
|
48059
48102
|
/**
|
|
@@ -48408,7 +48451,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48408
48451
|
/**
|
|
48409
48452
|
* WebMessaging service.
|
|
48410
48453
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
48411
|
-
* @version
|
|
48454
|
+
* @version 135.0.0
|
|
48412
48455
|
*/
|
|
48413
48456
|
|
|
48414
48457
|
/**
|
|
@@ -48454,7 +48497,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48454
48497
|
/**
|
|
48455
48498
|
* Widgets service.
|
|
48456
48499
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
48457
|
-
* @version
|
|
48500
|
+
* @version 135.0.0
|
|
48458
48501
|
*/
|
|
48459
48502
|
|
|
48460
48503
|
/**
|
|
@@ -48600,7 +48643,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48600
48643
|
/**
|
|
48601
48644
|
* WorkforceManagement service.
|
|
48602
48645
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
48603
|
-
* @version
|
|
48646
|
+
* @version 135.0.0
|
|
48604
48647
|
*/
|
|
48605
48648
|
|
|
48606
48649
|
/**
|
|
@@ -48798,7 +48841,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48798
48841
|
/**
|
|
48799
48842
|
* Delete a short term forecast
|
|
48800
48843
|
* Must not be tied to any schedules
|
|
48801
|
-
* @param {String} businessUnitId The
|
|
48844
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
48802
48845
|
* @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
|
|
48803
48846
|
* @param {String} forecastId The ID of the forecast
|
|
48804
48847
|
*/
|
|
@@ -48878,7 +48921,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48878
48921
|
/**
|
|
48879
48922
|
* Deletes a time off limit object
|
|
48880
48923
|
*
|
|
48881
|
-
* @param {String} managementUnitId The
|
|
48924
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
48882
48925
|
* @param {String} timeOffLimitId The ID of the time off limit object to delete
|
|
48883
48926
|
*/
|
|
48884
48927
|
deleteWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
@@ -48908,7 +48951,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48908
48951
|
/**
|
|
48909
48952
|
* Deletes a time off plan
|
|
48910
48953
|
*
|
|
48911
|
-
* @param {String} managementUnitId The management unit
|
|
48954
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
48912
48955
|
* @param {String} timeOffPlanId The ID of the time off plan to delete
|
|
48913
48956
|
*/
|
|
48914
48957
|
deleteWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
@@ -49177,7 +49220,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49177
49220
|
/**
|
|
49178
49221
|
* Get intraday planning groups for the given date
|
|
49179
49222
|
*
|
|
49180
|
-
* @param {String} businessUnitId The
|
|
49223
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
49181
49224
|
* @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
|
|
49182
49225
|
*/
|
|
49183
49226
|
getWorkforcemanagementBusinessunitIntradayPlanninggroups(businessUnitId, _date) {
|
|
@@ -49630,7 +49673,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49630
49673
|
/**
|
|
49631
49674
|
* Get a short term forecast
|
|
49632
49675
|
*
|
|
49633
|
-
* @param {String} businessUnitId The
|
|
49676
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49634
49677
|
* @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
|
|
49635
49678
|
* @param {String} forecastId The ID of the forecast
|
|
49636
49679
|
* @param {Object} opts Optional parameters
|
|
@@ -49669,7 +49712,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49669
49712
|
/**
|
|
49670
49713
|
* Get the result of a short term forecast calculation
|
|
49671
49714
|
* Includes modifications unless you pass the doNotApplyModifications query parameter
|
|
49672
|
-
* @param {String} businessUnitId The
|
|
49715
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49673
49716
|
* @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
|
|
49674
49717
|
* @param {String} forecastId The ID of the forecast
|
|
49675
49718
|
* @param {Object} opts Optional parameters
|
|
@@ -49709,7 +49752,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49709
49752
|
/**
|
|
49710
49753
|
* Gets the forecast generation results
|
|
49711
49754
|
*
|
|
49712
|
-
* @param {String} businessUnitId The
|
|
49755
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49713
49756
|
* @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
|
|
49714
49757
|
* @param {String} forecastId The ID of the forecast
|
|
49715
49758
|
*/
|
|
@@ -49744,7 +49787,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49744
49787
|
/**
|
|
49745
49788
|
* Get the result of a long term forecast calculation
|
|
49746
49789
|
* Includes modifications unless you pass the doNotApplyModifications query parameter
|
|
49747
|
-
* @param {String} businessUnitId The
|
|
49790
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49748
49791
|
* @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
|
|
49749
49792
|
* @param {String} forecastId The ID of the forecast
|
|
49750
49793
|
* @param {Object} opts Optional parameters
|
|
@@ -49783,7 +49826,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49783
49826
|
/**
|
|
49784
49827
|
* Gets the forecast planning group snapshot
|
|
49785
49828
|
*
|
|
49786
|
-
* @param {String} businessUnitId The
|
|
49829
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49787
49830
|
* @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
|
|
49788
49831
|
* @param {String} forecastId The ID of the forecast
|
|
49789
49832
|
*/
|
|
@@ -49818,7 +49861,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49818
49861
|
/**
|
|
49819
49862
|
* Get short term forecasts
|
|
49820
49863
|
* 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
|
|
49821
|
-
* @param {String} businessUnitId The
|
|
49864
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49822
49865
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format or 'recent' (without quotes) to fetch recent forecasts
|
|
49823
49866
|
*/
|
|
49824
49867
|
getWorkforcemanagementBusinessunitWeekShorttermforecasts(businessUnitId, weekDateId) {
|
|
@@ -50036,7 +50079,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50036
50079
|
/**
|
|
50037
50080
|
* Get a list of user schedule adherence records for the requested management unit
|
|
50038
50081
|
*
|
|
50039
|
-
* @param {String} managementUnitId The
|
|
50082
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
50040
50083
|
* @param {Object} opts Optional parameters
|
|
50041
50084
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
50042
50085
|
*/
|
|
@@ -50065,7 +50108,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50065
50108
|
/**
|
|
50066
50109
|
* Get data for agent in the management unit
|
|
50067
50110
|
*
|
|
50068
|
-
* @param {String} managementUnitId The
|
|
50111
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50069
50112
|
* @param {String} agentId The agent id
|
|
50070
50113
|
* @param {Object} opts Optional parameters
|
|
50071
50114
|
* @param {Boolean} opts.excludeCapabilities Excludes all capabilities of the agent such as queues, languages, and skills
|
|
@@ -50099,7 +50142,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50099
50142
|
/**
|
|
50100
50143
|
* Gets all the shift trades for a given agent
|
|
50101
50144
|
*
|
|
50102
|
-
* @param {String} managementUnitId The
|
|
50145
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50103
50146
|
* @param {String} agentId The agent id
|
|
50104
50147
|
*/
|
|
50105
50148
|
getWorkforcemanagementManagementunitAgentShifttrades(managementUnitId, agentId) {
|
|
@@ -50129,7 +50172,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50129
50172
|
/**
|
|
50130
50173
|
* Gets a summary of all shift trades in the matched state
|
|
50131
50174
|
*
|
|
50132
|
-
* @param {String} managementUnitId The
|
|
50175
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50133
50176
|
*/
|
|
50134
50177
|
getWorkforcemanagementManagementunitShifttradesMatched(managementUnitId) {
|
|
50135
50178
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50154,7 +50197,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50154
50197
|
/**
|
|
50155
50198
|
* Gets list of users available for whom you can send direct shift trade requests
|
|
50156
50199
|
*
|
|
50157
|
-
* @param {String} managementUnitId The
|
|
50200
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50158
50201
|
*/
|
|
50159
50202
|
getWorkforcemanagementManagementunitShifttradesUsers(managementUnitId) {
|
|
50160
50203
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50179,7 +50222,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50179
50222
|
/**
|
|
50180
50223
|
* Gets a time off limit object
|
|
50181
50224
|
* Returns properties of time off limit object, but not daily values.
|
|
50182
|
-
* @param {String} managementUnitId The
|
|
50225
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
50183
50226
|
* @param {String} timeOffLimitId The ID of the time off limit to fetch
|
|
50184
50227
|
*/
|
|
50185
50228
|
getWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
@@ -50209,7 +50252,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50209
50252
|
/**
|
|
50210
50253
|
* Gets a list of time off limit objects under management unit.
|
|
50211
50254
|
* Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.
|
|
50212
|
-
* @param {String} managementUnitId The
|
|
50255
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
50213
50256
|
*/
|
|
50214
50257
|
getWorkforcemanagementManagementunitTimeofflimits(managementUnitId) {
|
|
50215
50258
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50234,7 +50277,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50234
50277
|
/**
|
|
50235
50278
|
* Gets a time off plan
|
|
50236
50279
|
*
|
|
50237
|
-
* @param {String} managementUnitId The management unit
|
|
50280
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
50238
50281
|
* @param {String} timeOffPlanId The ID of the time off plan to fetch
|
|
50239
50282
|
*/
|
|
50240
50283
|
getWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
@@ -50264,7 +50307,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50264
50307
|
/**
|
|
50265
50308
|
* Gets a list of time off plans
|
|
50266
50309
|
*
|
|
50267
|
-
* @param {String} managementUnitId The management unit
|
|
50310
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
50268
50311
|
*/
|
|
50269
50312
|
getWorkforcemanagementManagementunitTimeoffplans(managementUnitId) {
|
|
50270
50313
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50289,7 +50332,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50289
50332
|
/**
|
|
50290
50333
|
* Get a time off request
|
|
50291
50334
|
*
|
|
50292
|
-
* @param {String} managementUnitId The
|
|
50335
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50293
50336
|
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
50294
50337
|
* @param {String} timeOffRequestId Time Off Request Id
|
|
50295
50338
|
*/
|
|
@@ -50324,7 +50367,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50324
50367
|
/**
|
|
50325
50368
|
* Retrieves time off limit, allocated and waitlisted values according to specific time off request
|
|
50326
50369
|
*
|
|
50327
|
-
* @param {String} managementUnitId The
|
|
50370
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
50328
50371
|
* @param {String} userId The userId to whom the time off request applies.
|
|
50329
50372
|
* @param {String} timeOffRequestId The ID of the time off request, which dates and activityCodeId determine limit values to retrieve
|
|
50330
50373
|
*/
|
|
@@ -50359,7 +50402,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50359
50402
|
/**
|
|
50360
50403
|
* Get a list of time off requests for a given user
|
|
50361
50404
|
*
|
|
50362
|
-
* @param {String} managementUnitId The
|
|
50405
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50363
50406
|
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
50364
50407
|
* @param {Object} opts Optional parameters
|
|
50365
50408
|
* @param {Boolean} opts.recentlyReviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
|
|
@@ -50393,7 +50436,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50393
50436
|
/**
|
|
50394
50437
|
* Get users in the management unit
|
|
50395
50438
|
*
|
|
50396
|
-
* @param {String} managementUnitId The
|
|
50439
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50397
50440
|
*/
|
|
50398
50441
|
getWorkforcemanagementManagementunitUsers(managementUnitId) {
|
|
50399
50442
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50494,7 +50537,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50494
50537
|
/**
|
|
50495
50538
|
* Gets all the shift trades for a given week
|
|
50496
50539
|
*
|
|
50497
|
-
* @param {String} managementUnitId The
|
|
50540
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50498
50541
|
* @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
|
|
50499
50542
|
* @param {Object} opts Optional parameters
|
|
50500
50543
|
* @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
|
|
@@ -50767,7 +50810,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50767
50810
|
/**
|
|
50768
50811
|
* Get a time off request for the current user
|
|
50769
50812
|
*
|
|
50770
|
-
* @param {String} timeOffRequestId
|
|
50813
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
50771
50814
|
*/
|
|
50772
50815
|
getWorkforcemanagementTimeoffrequest(timeOffRequestId) {
|
|
50773
50816
|
// verify the required parameter 'timeOffRequestId' is set
|
|
@@ -50792,7 +50835,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50792
50835
|
/**
|
|
50793
50836
|
* Get the daily waitlist positions of a time off request for the current user
|
|
50794
50837
|
*
|
|
50795
|
-
* @param {String} timeOffRequestId
|
|
50838
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
50796
50839
|
*/
|
|
50797
50840
|
getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId) {
|
|
50798
50841
|
// verify the required parameter 'timeOffRequestId' is set
|
|
@@ -51035,7 +51078,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51035
51078
|
/**
|
|
51036
51079
|
* Updates a time off limit object.
|
|
51037
51080
|
* Updates time off limit object properties, but not daily values.
|
|
51038
|
-
* @param {String} managementUnitId The
|
|
51081
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
51039
51082
|
* @param {String} timeOffLimitId The id of time off limit object to update
|
|
51040
51083
|
* @param {Object} opts Optional parameters
|
|
51041
51084
|
* @param {Object} opts.body body
|
|
@@ -51069,7 +51112,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51069
51112
|
/**
|
|
51070
51113
|
* Updates a time off plan
|
|
51071
51114
|
*
|
|
51072
|
-
* @param {String} managementUnitId The management unit
|
|
51115
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
51073
51116
|
* @param {String} timeOffPlanId The ID of the time off plan to update
|
|
51074
51117
|
* @param {Object} opts Optional parameters
|
|
51075
51118
|
* @param {Object} opts.body body
|
|
@@ -51103,7 +51146,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51103
51146
|
/**
|
|
51104
51147
|
* Update a time off request
|
|
51105
51148
|
*
|
|
51106
|
-
* @param {String} managementUnitId The
|
|
51149
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
51107
51150
|
* @param {String} userId The id of the user the requested time off request belongs to
|
|
51108
51151
|
* @param {String} timeOffRequestId The id of the time off request to update
|
|
51109
51152
|
* @param {Object} opts Optional parameters
|
|
@@ -51142,7 +51185,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51142
51185
|
/**
|
|
51143
51186
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
51144
51187
|
*
|
|
51145
|
-
* @param {String} managementUnitId The
|
|
51188
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
51146
51189
|
* @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
|
|
51147
51190
|
* @param {Object} body body
|
|
51148
51191
|
* @param {String} tradeId The ID of the shift trade to update
|
|
@@ -51251,7 +51294,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51251
51294
|
/**
|
|
51252
51295
|
* Update a time off request for the current user
|
|
51253
51296
|
*
|
|
51254
|
-
* @param {String} timeOffRequestId
|
|
51297
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
51255
51298
|
* @param {Object} opts Optional parameters
|
|
51256
51299
|
* @param {Object} opts.body body
|
|
51257
51300
|
*/
|
|
@@ -51388,7 +51431,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51388
51431
|
/**
|
|
51389
51432
|
* Get intraday data for the given date for the requested planningGroupIds
|
|
51390
51433
|
*
|
|
51391
|
-
* @param {String} businessUnitId The
|
|
51434
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
51392
51435
|
* @param {Object} opts Optional parameters
|
|
51393
51436
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
51394
51437
|
* @param {Object} opts.body body
|
|
@@ -51821,7 +51864,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51821
51864
|
/**
|
|
51822
51865
|
* Copy a short term forecast
|
|
51823
51866
|
*
|
|
51824
|
-
* @param {String} businessUnitId The
|
|
51867
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51825
51868
|
* @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
|
|
51826
51869
|
* @param {String} forecastId The ID of the forecast to copy
|
|
51827
51870
|
* @param {Object} body body
|
|
@@ -51865,7 +51908,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51865
51908
|
/**
|
|
51866
51909
|
* Generate a short term forecast
|
|
51867
51910
|
*
|
|
51868
|
-
* @param {String} businessUnitId The
|
|
51911
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51869
51912
|
* @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
|
|
51870
51913
|
* @param {Object} body
|
|
51871
51914
|
* @param {Object} opts Optional parameters
|
|
@@ -51904,7 +51947,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51904
51947
|
/**
|
|
51905
51948
|
* Starts importing the uploaded short term forecast
|
|
51906
51949
|
* Call after uploading the forecast data to the url supplied by the /import/uploadurl route
|
|
51907
|
-
* @param {String} businessUnitId The
|
|
51950
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51908
51951
|
* @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
|
|
51909
51952
|
* @param {Object} body
|
|
51910
51953
|
*/
|
|
@@ -51939,7 +51982,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51939
51982
|
/**
|
|
51940
51983
|
* Creates a signed upload URL for importing a short term forecast
|
|
51941
51984
|
* Once the upload is complete, call the /import route to start the short term forecast import process
|
|
51942
|
-
* @param {String} businessUnitId The
|
|
51985
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51943
51986
|
* @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
|
|
51944
51987
|
* @param {Object} body body
|
|
51945
51988
|
*/
|
|
@@ -52066,7 +52109,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52066
52109
|
/**
|
|
52067
52110
|
* Query published schedules for given given time range for set of users
|
|
52068
52111
|
*
|
|
52069
|
-
* @param {String} managementUnitId The
|
|
52112
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52070
52113
|
* @param {Object} opts Optional parameters
|
|
52071
52114
|
* @param {Object} opts.body body
|
|
52072
52115
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
@@ -52097,7 +52140,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52097
52140
|
/**
|
|
52098
52141
|
* Request a historical adherence report
|
|
52099
52142
|
* The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
|
|
52100
|
-
* @param {String} managementUnitId The
|
|
52143
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
52101
52144
|
* @param {Object} opts Optional parameters
|
|
52102
52145
|
* @param {Object} opts.body body
|
|
52103
52146
|
*/
|
|
@@ -52155,7 +52198,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52155
52198
|
/**
|
|
52156
52199
|
* Query published schedules for given given time range for set of users
|
|
52157
52200
|
*
|
|
52158
|
-
* @param {String} managementUnitId The
|
|
52201
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52159
52202
|
* @param {Object} opts Optional parameters
|
|
52160
52203
|
* @param {Object} opts.body body
|
|
52161
52204
|
*/
|
|
@@ -52184,7 +52227,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52184
52227
|
/**
|
|
52185
52228
|
* Creates a new time off limit object under management unit.
|
|
52186
52229
|
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
52187
|
-
* @param {String} managementUnitId The
|
|
52230
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52188
52231
|
* @param {Object} opts Optional parameters
|
|
52189
52232
|
* @param {Object} opts.body body
|
|
52190
52233
|
*/
|
|
@@ -52213,7 +52256,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52213
52256
|
/**
|
|
52214
52257
|
* Retrieves time off limit related values based on a given set of filters.
|
|
52215
52258
|
*
|
|
52216
|
-
* @param {String} managementUnitId The
|
|
52259
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52217
52260
|
* @param {Object} opts Optional parameters
|
|
52218
52261
|
* @param {Object} opts.body body
|
|
52219
52262
|
*/
|
|
@@ -52242,7 +52285,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52242
52285
|
/**
|
|
52243
52286
|
* Creates a new time off plan
|
|
52244
52287
|
*
|
|
52245
|
-
* @param {String} managementUnitId The management unit
|
|
52288
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
52246
52289
|
* @param {Object} opts Optional parameters
|
|
52247
52290
|
* @param {Object} opts.body body
|
|
52248
52291
|
*/
|
|
@@ -52271,7 +52314,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52271
52314
|
/**
|
|
52272
52315
|
* Create a new time off request
|
|
52273
52316
|
*
|
|
52274
|
-
* @param {String} managementUnitId The
|
|
52317
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52275
52318
|
* @param {Object} opts Optional parameters
|
|
52276
52319
|
* @param {Object} opts.body body
|
|
52277
52320
|
*/
|
|
@@ -52300,7 +52343,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52300
52343
|
/**
|
|
52301
52344
|
* Fetches time off requests matching the conditions specified in the request body
|
|
52302
52345
|
* 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
|
|
52303
|
-
* @param {String} managementUnitId The
|
|
52346
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52304
52347
|
* @param {Object} opts Optional parameters
|
|
52305
52348
|
* @param {Object} opts.body body
|
|
52306
52349
|
*/
|
|
@@ -52329,7 +52372,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52329
52372
|
/**
|
|
52330
52373
|
* Retrieves daily waitlist position for a list of time off requests
|
|
52331
52374
|
*
|
|
52332
|
-
* @param {String} managementUnitId The
|
|
52375
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52333
52376
|
* @param {Object} opts Optional parameters
|
|
52334
52377
|
* @param {Object} opts.body body
|
|
52335
52378
|
*/
|
|
@@ -52358,7 +52401,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52358
52401
|
/**
|
|
52359
52402
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
52360
52403
|
*
|
|
52361
|
-
* @param {String} managementUnitId The
|
|
52404
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52362
52405
|
* @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
|
|
52363
52406
|
* @param {Object} body body
|
|
52364
52407
|
* @param {String} tradeId The ID of the shift trade to update
|
|
@@ -52398,7 +52441,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52398
52441
|
/**
|
|
52399
52442
|
* Adds a shift trade
|
|
52400
52443
|
*
|
|
52401
|
-
* @param {String} managementUnitId The
|
|
52444
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52402
52445
|
* @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
|
|
52403
52446
|
* @param {Object} body body
|
|
52404
52447
|
*/
|
|
@@ -52433,7 +52476,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52433
52476
|
/**
|
|
52434
52477
|
* Searches for potential shift trade matches for the current agent
|
|
52435
52478
|
*
|
|
52436
|
-
* @param {String} managementUnitId The
|
|
52479
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52437
52480
|
* @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
|
|
52438
52481
|
* @param {Object} body body
|
|
52439
52482
|
*/
|
|
@@ -52468,7 +52511,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52468
52511
|
/**
|
|
52469
52512
|
* Updates the state of a batch of shift trades
|
|
52470
52513
|
* Admin functionality is not supported with \"mine\".
|
|
52471
|
-
* @param {String} managementUnitId The
|
|
52514
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52472
52515
|
* @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
|
|
52473
52516
|
* @param {Object} body body
|
|
52474
52517
|
* @param {Object} opts Optional parameters
|
|
@@ -52789,7 +52832,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52789
52832
|
/**
|
|
52790
52833
|
* Sets daily values for a date range of time off limit object
|
|
52791
52834
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
52792
|
-
* @param {String} managementUnitId The
|
|
52835
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52793
52836
|
* @param {String} timeOffLimitId The ID of the time off limit object to set values for
|
|
52794
52837
|
* @param {Object} opts Optional parameters
|
|
52795
52838
|
* @param {Object} opts.body body
|
|
@@ -52851,7 +52894,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52851
52894
|
* </pre>
|
|
52852
52895
|
* </p>
|
|
52853
52896
|
* @module purecloud-platform-client-v2/index
|
|
52854
|
-
* @version
|
|
52897
|
+
* @version 135.0.0
|
|
52855
52898
|
*/
|
|
52856
52899
|
class platformClient {
|
|
52857
52900
|
constructor() {
|