purecloud-platform-client-v2 134.0.0 → 136.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 +32 -29
- package/dist/node/purecloud-platform-client-v2.js +388 -214
- package/dist/web-amd/purecloud-platform-client-v2.js +388 -214
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +388 -214
- package/dist/web-cjs/purecloud-platform-client-v2.js +398 -225
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +364 -35
- 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 +5 -5
- 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 +29 -29
- 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 +11 -9
- 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 +132 -5
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +69 -3
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +51 -51
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -395,7 +395,7 @@ class Configuration {
|
|
|
395
395
|
|
|
396
396
|
/**
|
|
397
397
|
* @module purecloud-platform-client-v2/ApiClient
|
|
398
|
-
* @version
|
|
398
|
+
* @version 136.0.0
|
|
399
399
|
*/
|
|
400
400
|
class ApiClient {
|
|
401
401
|
/**
|
|
@@ -1342,7 +1342,7 @@ class ApiClient {
|
|
|
1342
1342
|
|
|
1343
1343
|
// set header parameters
|
|
1344
1344
|
request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
|
|
1345
|
-
//request.set({ 'purecloud-sdk': '
|
|
1345
|
+
//request.set({ 'purecloud-sdk': '136.0.0' });
|
|
1346
1346
|
|
|
1347
1347
|
// set request timeout
|
|
1348
1348
|
request.timeout(that.timeout);
|
|
@@ -1442,7 +1442,7 @@ class AlertingApi {
|
|
|
1442
1442
|
/**
|
|
1443
1443
|
* Alerting service.
|
|
1444
1444
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1445
|
-
* @version
|
|
1445
|
+
* @version 136.0.0
|
|
1446
1446
|
*/
|
|
1447
1447
|
|
|
1448
1448
|
/**
|
|
@@ -1756,7 +1756,7 @@ class AnalyticsApi {
|
|
|
1756
1756
|
/**
|
|
1757
1757
|
* Analytics service.
|
|
1758
1758
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1759
|
-
* @version
|
|
1759
|
+
* @version 136.0.0
|
|
1760
1760
|
*/
|
|
1761
1761
|
|
|
1762
1762
|
/**
|
|
@@ -2938,7 +2938,7 @@ class ArchitectApi {
|
|
|
2938
2938
|
/**
|
|
2939
2939
|
* Architect service.
|
|
2940
2940
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2941
|
-
* @version
|
|
2941
|
+
* @version 136.0.0
|
|
2942
2942
|
*/
|
|
2943
2943
|
|
|
2944
2944
|
/**
|
|
@@ -5934,7 +5934,7 @@ class AuditApi {
|
|
|
5934
5934
|
/**
|
|
5935
5935
|
* Audit service.
|
|
5936
5936
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
5937
|
-
* @version
|
|
5937
|
+
* @version 136.0.0
|
|
5938
5938
|
*/
|
|
5939
5939
|
|
|
5940
5940
|
/**
|
|
@@ -6105,7 +6105,7 @@ class AuthorizationApi {
|
|
|
6105
6105
|
/**
|
|
6106
6106
|
* Authorization service.
|
|
6107
6107
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6108
|
-
* @version
|
|
6108
|
+
* @version 136.0.0
|
|
6109
6109
|
*/
|
|
6110
6110
|
|
|
6111
6111
|
/**
|
|
@@ -7288,7 +7288,7 @@ class BillingApi {
|
|
|
7288
7288
|
/**
|
|
7289
7289
|
* Billing service.
|
|
7290
7290
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7291
|
-
* @version
|
|
7291
|
+
* @version 136.0.0
|
|
7292
7292
|
*/
|
|
7293
7293
|
|
|
7294
7294
|
/**
|
|
@@ -7368,7 +7368,7 @@ class ChatApi {
|
|
|
7368
7368
|
/**
|
|
7369
7369
|
* Chat service.
|
|
7370
7370
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7371
|
-
* @version
|
|
7371
|
+
* @version 136.0.0
|
|
7372
7372
|
*/
|
|
7373
7373
|
|
|
7374
7374
|
/**
|
|
@@ -7459,7 +7459,7 @@ class CoachingApi {
|
|
|
7459
7459
|
/**
|
|
7460
7460
|
* Coaching service.
|
|
7461
7461
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7462
|
-
* @version
|
|
7462
|
+
* @version 136.0.0
|
|
7463
7463
|
*/
|
|
7464
7464
|
|
|
7465
7465
|
/**
|
|
@@ -8036,7 +8036,7 @@ class ContentManagementApi {
|
|
|
8036
8036
|
/**
|
|
8037
8037
|
* ContentManagement service.
|
|
8038
8038
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8039
|
-
* @version
|
|
8039
|
+
* @version 136.0.0
|
|
8040
8040
|
*/
|
|
8041
8041
|
|
|
8042
8042
|
/**
|
|
@@ -9176,7 +9176,7 @@ class ConversationsApi {
|
|
|
9176
9176
|
/**
|
|
9177
9177
|
* Conversations service.
|
|
9178
9178
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9179
|
-
* @version
|
|
9179
|
+
* @version 136.0.0
|
|
9180
9180
|
*/
|
|
9181
9181
|
|
|
9182
9182
|
/**
|
|
@@ -11081,7 +11081,7 @@ class ConversationsApi {
|
|
|
11081
11081
|
/**
|
|
11082
11082
|
* Get a list of Messaging Stickers
|
|
11083
11083
|
*
|
|
11084
|
-
* @param {
|
|
11084
|
+
* @param {Object} messengerType Messenger Type
|
|
11085
11085
|
* @param {Object} opts Optional parameters
|
|
11086
11086
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
11087
11087
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
@@ -11269,7 +11269,7 @@ class ConversationsApi {
|
|
|
11269
11269
|
}
|
|
11270
11270
|
|
|
11271
11271
|
/**
|
|
11272
|
-
* Update a conversation by setting
|
|
11272
|
+
* Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
11273
11273
|
*
|
|
11274
11274
|
* @param {String} conversationId conversationId
|
|
11275
11275
|
* @param {Object} body Conversation
|
|
@@ -12255,8 +12255,8 @@ class ConversationsApi {
|
|
|
12255
12255
|
}
|
|
12256
12256
|
|
|
12257
12257
|
/**
|
|
12258
|
-
* Update or activate a WhatsApp messaging integration
|
|
12259
|
-
* The following steps are required in order to fully activate a
|
|
12258
|
+
* Update or activate a WhatsApp messaging integration
|
|
12259
|
+
* The following steps are required in order to fully activate a WhatsApp Integration: Initially, you will need to get an activation code by sending: an action set to Activate, and an authenticationMethod choosing from Sms or Voice. Finally, once you have been informed of an activation code on selected authenticationMethod, you will need to confirm the code by sending: an action set to Confirm, and the confirmationCode you have received from Whatsapp.
|
|
12260
12260
|
* @param {String} integrationId Integration ID
|
|
12261
12261
|
* @param {Object} body WhatsAppIntegrationUpdateRequest
|
|
12262
12262
|
*/
|
|
@@ -13840,7 +13840,7 @@ class DataExtensionsApi {
|
|
|
13840
13840
|
/**
|
|
13841
13841
|
* DataExtensions service.
|
|
13842
13842
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
13843
|
-
* @version
|
|
13843
|
+
* @version 136.0.0
|
|
13844
13844
|
*/
|
|
13845
13845
|
|
|
13846
13846
|
/**
|
|
@@ -13926,7 +13926,7 @@ class ExternalContactsApi {
|
|
|
13926
13926
|
/**
|
|
13927
13927
|
* ExternalContacts service.
|
|
13928
13928
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
13929
|
-
* @version
|
|
13929
|
+
* @version 136.0.0
|
|
13930
13930
|
*/
|
|
13931
13931
|
|
|
13932
13932
|
/**
|
|
@@ -15669,7 +15669,7 @@ class FaxApi {
|
|
|
15669
15669
|
/**
|
|
15670
15670
|
* Fax service.
|
|
15671
15671
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
15672
|
-
* @version
|
|
15672
|
+
* @version 136.0.0
|
|
15673
15673
|
*/
|
|
15674
15674
|
|
|
15675
15675
|
/**
|
|
@@ -15840,7 +15840,7 @@ class FlowsApi {
|
|
|
15840
15840
|
/**
|
|
15841
15841
|
* Flows service.
|
|
15842
15842
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
15843
|
-
* @version
|
|
15843
|
+
* @version 136.0.0
|
|
15844
15844
|
*/
|
|
15845
15845
|
|
|
15846
15846
|
/**
|
|
@@ -15911,7 +15911,7 @@ class GamificationApi {
|
|
|
15911
15911
|
/**
|
|
15912
15912
|
* Gamification service.
|
|
15913
15913
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
15914
|
-
* @version
|
|
15914
|
+
* @version 136.0.0
|
|
15915
15915
|
*/
|
|
15916
15916
|
|
|
15917
15917
|
/**
|
|
@@ -16157,18 +16157,18 @@ class GamificationApi {
|
|
|
16157
16157
|
/**
|
|
16158
16158
|
* Performance profile by id
|
|
16159
16159
|
*
|
|
16160
|
-
* @param {String} performanceProfileId
|
|
16160
|
+
* @param {String} profileId performanceProfileId
|
|
16161
16161
|
*/
|
|
16162
|
-
getGamificationProfile(
|
|
16163
|
-
// verify the required parameter '
|
|
16164
|
-
if (
|
|
16165
|
-
throw 'Missing the required parameter "
|
|
16162
|
+
getGamificationProfile(profileId) {
|
|
16163
|
+
// verify the required parameter 'profileId' is set
|
|
16164
|
+
if (profileId === undefined || profileId === null) {
|
|
16165
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationProfile';
|
|
16166
16166
|
}
|
|
16167
16167
|
|
|
16168
16168
|
return this.apiClient.callApi(
|
|
16169
|
-
'/api/v2/gamification/profiles/{
|
|
16169
|
+
'/api/v2/gamification/profiles/{profileId}',
|
|
16170
16170
|
'GET',
|
|
16171
|
-
{ '
|
|
16171
|
+
{ 'profileId': profileId },
|
|
16172
16172
|
{ },
|
|
16173
16173
|
{ },
|
|
16174
16174
|
{ },
|
|
@@ -17011,18 +17011,18 @@ class GamificationApi {
|
|
|
17011
17011
|
/**
|
|
17012
17012
|
* Activate a performance profile
|
|
17013
17013
|
*
|
|
17014
|
-
* @param {String} performanceProfileId
|
|
17014
|
+
* @param {String} profileId performanceProfileId
|
|
17015
17015
|
*/
|
|
17016
|
-
postGamificationProfileActivate(
|
|
17017
|
-
// verify the required parameter '
|
|
17018
|
-
if (
|
|
17019
|
-
throw 'Missing the required parameter "
|
|
17016
|
+
postGamificationProfileActivate(profileId) {
|
|
17017
|
+
// verify the required parameter 'profileId' is set
|
|
17018
|
+
if (profileId === undefined || profileId === null) {
|
|
17019
|
+
throw 'Missing the required parameter "profileId" when calling postGamificationProfileActivate';
|
|
17020
17020
|
}
|
|
17021
17021
|
|
|
17022
17022
|
return this.apiClient.callApi(
|
|
17023
|
-
'/api/v2/gamification/profiles/{
|
|
17023
|
+
'/api/v2/gamification/profiles/{profileId}/activate',
|
|
17024
17024
|
'POST',
|
|
17025
|
-
{ '
|
|
17025
|
+
{ 'profileId': profileId },
|
|
17026
17026
|
{ },
|
|
17027
17027
|
{ },
|
|
17028
17028
|
{ },
|
|
@@ -17036,18 +17036,18 @@ class GamificationApi {
|
|
|
17036
17036
|
/**
|
|
17037
17037
|
* Deactivate a performance profile
|
|
17038
17038
|
*
|
|
17039
|
-
* @param {String} performanceProfileId
|
|
17039
|
+
* @param {String} profileId performanceProfileId
|
|
17040
17040
|
*/
|
|
17041
|
-
postGamificationProfileDeactivate(
|
|
17042
|
-
// verify the required parameter '
|
|
17043
|
-
if (
|
|
17044
|
-
throw 'Missing the required parameter "
|
|
17041
|
+
postGamificationProfileDeactivate(profileId) {
|
|
17042
|
+
// verify the required parameter 'profileId' is set
|
|
17043
|
+
if (profileId === undefined || profileId === null) {
|
|
17044
|
+
throw 'Missing the required parameter "profileId" when calling postGamificationProfileDeactivate';
|
|
17045
17045
|
}
|
|
17046
17046
|
|
|
17047
17047
|
return this.apiClient.callApi(
|
|
17048
|
-
'/api/v2/gamification/profiles/{
|
|
17048
|
+
'/api/v2/gamification/profiles/{profileId}/deactivate',
|
|
17049
17049
|
'POST',
|
|
17050
|
-
{ '
|
|
17050
|
+
{ 'profileId': profileId },
|
|
17051
17051
|
{ },
|
|
17052
17052
|
{ },
|
|
17053
17053
|
{ },
|
|
@@ -17249,22 +17249,22 @@ class GamificationApi {
|
|
|
17249
17249
|
/**
|
|
17250
17250
|
* Updates a performance profile
|
|
17251
17251
|
*
|
|
17252
|
-
* @param {String} performanceProfileId
|
|
17252
|
+
* @param {String} profileId performanceProfileId
|
|
17253
17253
|
* @param {Object} opts Optional parameters
|
|
17254
17254
|
* @param {Object} opts.body performanceProfile
|
|
17255
17255
|
*/
|
|
17256
|
-
putGamificationProfile(
|
|
17256
|
+
putGamificationProfile(profileId, opts) {
|
|
17257
17257
|
opts = opts || {};
|
|
17258
17258
|
|
|
17259
|
-
// verify the required parameter '
|
|
17260
|
-
if (
|
|
17261
|
-
throw 'Missing the required parameter "
|
|
17259
|
+
// verify the required parameter 'profileId' is set
|
|
17260
|
+
if (profileId === undefined || profileId === null) {
|
|
17261
|
+
throw 'Missing the required parameter "profileId" when calling putGamificationProfile';
|
|
17262
17262
|
}
|
|
17263
17263
|
|
|
17264
17264
|
return this.apiClient.callApi(
|
|
17265
|
-
'/api/v2/gamification/profiles/{
|
|
17265
|
+
'/api/v2/gamification/profiles/{profileId}',
|
|
17266
17266
|
'PUT',
|
|
17267
|
-
{ '
|
|
17267
|
+
{ 'profileId': profileId },
|
|
17268
17268
|
{ },
|
|
17269
17269
|
{ },
|
|
17270
17270
|
{ },
|
|
@@ -17341,7 +17341,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
17341
17341
|
/**
|
|
17342
17342
|
* GeneralDataProtectionRegulation service.
|
|
17343
17343
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
17344
|
-
* @version
|
|
17344
|
+
* @version 136.0.0
|
|
17345
17345
|
*/
|
|
17346
17346
|
|
|
17347
17347
|
/**
|
|
@@ -17471,7 +17471,7 @@ class GeolocationApi {
|
|
|
17471
17471
|
/**
|
|
17472
17472
|
* Geolocation service.
|
|
17473
17473
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
17474
|
-
* @version
|
|
17474
|
+
* @version 136.0.0
|
|
17475
17475
|
*/
|
|
17476
17476
|
|
|
17477
17477
|
/**
|
|
@@ -17602,7 +17602,7 @@ class GreetingsApi {
|
|
|
17602
17602
|
/**
|
|
17603
17603
|
* Greetings service.
|
|
17604
17604
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
17605
|
-
* @version
|
|
17605
|
+
* @version 136.0.0
|
|
17606
17606
|
*/
|
|
17607
17607
|
|
|
17608
17608
|
/**
|
|
@@ -18057,7 +18057,7 @@ class GroupsApi {
|
|
|
18057
18057
|
/**
|
|
18058
18058
|
* Groups service.
|
|
18059
18059
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
18060
|
-
* @version
|
|
18060
|
+
* @version 136.0.0
|
|
18061
18061
|
*/
|
|
18062
18062
|
|
|
18063
18063
|
/**
|
|
@@ -18462,7 +18462,7 @@ class IdentityProviderApi {
|
|
|
18462
18462
|
/**
|
|
18463
18463
|
* IdentityProvider service.
|
|
18464
18464
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
18465
|
-
* @version
|
|
18465
|
+
* @version 136.0.0
|
|
18466
18466
|
*/
|
|
18467
18467
|
|
|
18468
18468
|
/**
|
|
@@ -19218,7 +19218,7 @@ class IntegrationsApi {
|
|
|
19218
19218
|
/**
|
|
19219
19219
|
* Integrations service.
|
|
19220
19220
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
19221
|
-
* @version
|
|
19221
|
+
* @version 136.0.0
|
|
19222
19222
|
*/
|
|
19223
19223
|
|
|
19224
19224
|
/**
|
|
@@ -19636,9 +19636,10 @@ class IntegrationsApi {
|
|
|
19636
19636
|
* @param {String} opts.previousPage Previous page token
|
|
19637
19637
|
* @param {String} opts.sortBy Root level field name to sort on.
|
|
19638
19638
|
* @param {Object} opts.sortOrder Direction to sort 'sortBy' field. (default to asc)
|
|
19639
|
-
* @param {String} opts.category Filter by category name
|
|
19640
|
-
* @param {String} opts.name Filter by
|
|
19641
|
-
* @param {
|
|
19639
|
+
* @param {String} opts.category Filter by category name.
|
|
19640
|
+
* @param {String} opts.name Filter by partial or complete action name.
|
|
19641
|
+
* @param {String} opts.ids Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids.
|
|
19642
|
+
* @param {Object} opts.secure Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions.
|
|
19642
19643
|
* @param {Object} opts.includeAuthActions Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. (default to false)
|
|
19643
19644
|
*/
|
|
19644
19645
|
getIntegrationsActions(opts) {
|
|
@@ -19649,7 +19650,7 @@ class IntegrationsApi {
|
|
|
19649
19650
|
'/api/v2/integrations/actions',
|
|
19650
19651
|
'GET',
|
|
19651
19652
|
{ },
|
|
19652
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'category': opts['category'],'name': opts['name'],'secure': opts['secure'],'includeAuthActions': opts['includeAuthActions'] },
|
|
19653
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'category': opts['category'],'name': opts['name'],'ids': opts['ids'],'secure': opts['secure'],'includeAuthActions': opts['includeAuthActions'] },
|
|
19653
19654
|
{ },
|
|
19654
19655
|
{ },
|
|
19655
19656
|
null,
|
|
@@ -19699,9 +19700,10 @@ class IntegrationsApi {
|
|
|
19699
19700
|
* @param {String} opts.previousPage Previous page token
|
|
19700
19701
|
* @param {String} opts.sortBy Root level field name to sort on.
|
|
19701
19702
|
* @param {Object} opts.sortOrder Direction to sort 'sortBy' field. (default to asc)
|
|
19702
|
-
* @param {String} opts.category Filter by category name
|
|
19703
|
-
* @param {String} opts.name Filter by
|
|
19704
|
-
* @param {
|
|
19703
|
+
* @param {String} opts.category Filter by category name.
|
|
19704
|
+
* @param {String} opts.name Filter by partial or complete action name.
|
|
19705
|
+
* @param {String} opts.ids Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids.
|
|
19706
|
+
* @param {Object} opts.secure Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions.
|
|
19705
19707
|
* @param {Object} opts.includeAuthActions Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. (default to false)
|
|
19706
19708
|
*/
|
|
19707
19709
|
getIntegrationsActionsDrafts(opts) {
|
|
@@ -19712,7 +19714,7 @@ class IntegrationsApi {
|
|
|
19712
19714
|
'/api/v2/integrations/actions/drafts',
|
|
19713
19715
|
'GET',
|
|
19714
19716
|
{ },
|
|
19715
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'category': opts['category'],'name': opts['name'],'secure': opts['secure'],'includeAuthActions': opts['includeAuthActions'] },
|
|
19717
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'category': opts['category'],'name': opts['name'],'ids': opts['ids'],'secure': opts['secure'],'includeAuthActions': opts['includeAuthActions'] },
|
|
19716
19718
|
{ },
|
|
19717
19719
|
{ },
|
|
19718
19720
|
null,
|
|
@@ -20893,7 +20895,7 @@ class JourneyApi {
|
|
|
20893
20895
|
/**
|
|
20894
20896
|
* Journey service.
|
|
20895
20897
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
20896
|
-
* @version
|
|
20898
|
+
* @version 136.0.0
|
|
20897
20899
|
*/
|
|
20898
20900
|
|
|
20899
20901
|
/**
|
|
@@ -21604,7 +21606,7 @@ class KnowledgeApi {
|
|
|
21604
21606
|
/**
|
|
21605
21607
|
* Knowledge service.
|
|
21606
21608
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
21607
|
-
* @version
|
|
21609
|
+
* @version 136.0.0
|
|
21608
21610
|
*/
|
|
21609
21611
|
|
|
21610
21612
|
/**
|
|
@@ -22504,7 +22506,7 @@ class LanguageUnderstandingApi {
|
|
|
22504
22506
|
/**
|
|
22505
22507
|
* LanguageUnderstanding service.
|
|
22506
22508
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
22507
|
-
* @version
|
|
22509
|
+
* @version 136.0.0
|
|
22508
22510
|
*/
|
|
22509
22511
|
|
|
22510
22512
|
/**
|
|
@@ -23408,7 +23410,7 @@ class LanguagesApi {
|
|
|
23408
23410
|
/**
|
|
23409
23411
|
* Languages service.
|
|
23410
23412
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
23411
|
-
* @version
|
|
23413
|
+
* @version 136.0.0
|
|
23412
23414
|
*/
|
|
23413
23415
|
|
|
23414
23416
|
/**
|
|
@@ -23676,7 +23678,7 @@ class LearningApi {
|
|
|
23676
23678
|
/**
|
|
23677
23679
|
* Learning service.
|
|
23678
23680
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
23679
|
-
* @version
|
|
23681
|
+
* @version 136.0.0
|
|
23680
23682
|
*/
|
|
23681
23683
|
|
|
23682
23684
|
/**
|
|
@@ -24267,7 +24269,7 @@ class LicenseApi {
|
|
|
24267
24269
|
/**
|
|
24268
24270
|
* License service.
|
|
24269
24271
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
24270
|
-
* @version
|
|
24272
|
+
* @version 136.0.0
|
|
24271
24273
|
*/
|
|
24272
24274
|
|
|
24273
24275
|
/**
|
|
@@ -24505,7 +24507,7 @@ class LocationsApi {
|
|
|
24505
24507
|
/**
|
|
24506
24508
|
* Locations service.
|
|
24507
24509
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
24508
|
-
* @version
|
|
24510
|
+
* @version 136.0.0
|
|
24509
24511
|
*/
|
|
24510
24512
|
|
|
24511
24513
|
/**
|
|
@@ -24741,7 +24743,7 @@ class MessagingApi {
|
|
|
24741
24743
|
/**
|
|
24742
24744
|
* Messaging service.
|
|
24743
24745
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
24744
|
-
* @version
|
|
24746
|
+
* @version 136.0.0
|
|
24745
24747
|
*/
|
|
24746
24748
|
|
|
24747
24749
|
/**
|
|
@@ -24892,7 +24894,7 @@ class MobileDevicesApi {
|
|
|
24892
24894
|
/**
|
|
24893
24895
|
* MobileDevices service.
|
|
24894
24896
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
24895
|
-
* @version
|
|
24897
|
+
* @version 136.0.0
|
|
24896
24898
|
*/
|
|
24897
24899
|
|
|
24898
24900
|
/**
|
|
@@ -25043,7 +25045,7 @@ class NotificationsApi {
|
|
|
25043
25045
|
/**
|
|
25044
25046
|
* Notifications service.
|
|
25045
25047
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
25046
|
-
* @version
|
|
25048
|
+
* @version 136.0.0
|
|
25047
25049
|
*/
|
|
25048
25050
|
|
|
25049
25051
|
/**
|
|
@@ -25268,7 +25270,7 @@ class OAuthApi {
|
|
|
25268
25270
|
/**
|
|
25269
25271
|
* OAuth service.
|
|
25270
25272
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
25271
|
-
* @version
|
|
25273
|
+
* @version 136.0.0
|
|
25272
25274
|
*/
|
|
25273
25275
|
|
|
25274
25276
|
/**
|
|
@@ -25634,7 +25636,7 @@ class ObjectsApi {
|
|
|
25634
25636
|
/**
|
|
25635
25637
|
* Objects service.
|
|
25636
25638
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
25637
|
-
* @version
|
|
25639
|
+
* @version 136.0.0
|
|
25638
25640
|
*/
|
|
25639
25641
|
|
|
25640
25642
|
/**
|
|
@@ -25905,7 +25907,7 @@ class OrganizationApi {
|
|
|
25905
25907
|
/**
|
|
25906
25908
|
* Organization service.
|
|
25907
25909
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
25908
|
-
* @version
|
|
25910
|
+
* @version 136.0.0
|
|
25909
25911
|
*/
|
|
25910
25912
|
|
|
25911
25913
|
/**
|
|
@@ -26308,7 +26310,7 @@ class OrganizationAuthorizationApi {
|
|
|
26308
26310
|
/**
|
|
26309
26311
|
* OrganizationAuthorization service.
|
|
26310
26312
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
26311
|
-
* @version
|
|
26313
|
+
* @version 136.0.0
|
|
26312
26314
|
*/
|
|
26313
26315
|
|
|
26314
26316
|
/**
|
|
@@ -27233,7 +27235,7 @@ class OutboundApi {
|
|
|
27233
27235
|
/**
|
|
27234
27236
|
* Outbound service.
|
|
27235
27237
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
27236
|
-
* @version
|
|
27238
|
+
* @version 136.0.0
|
|
27237
27239
|
*/
|
|
27238
27240
|
|
|
27239
27241
|
/**
|
|
@@ -27583,6 +27585,31 @@ class OutboundApi {
|
|
|
27583
27585
|
);
|
|
27584
27586
|
}
|
|
27585
27587
|
|
|
27588
|
+
/**
|
|
27589
|
+
* Reset messaging campaign progress and recycle the messaging campaign
|
|
27590
|
+
*
|
|
27591
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
27592
|
+
*/
|
|
27593
|
+
deleteOutboundMessagingcampaignProgress(messagingCampaignId) {
|
|
27594
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
27595
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
27596
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling deleteOutboundMessagingcampaignProgress';
|
|
27597
|
+
}
|
|
27598
|
+
|
|
27599
|
+
return this.apiClient.callApi(
|
|
27600
|
+
'/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress',
|
|
27601
|
+
'DELETE',
|
|
27602
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
27603
|
+
{ },
|
|
27604
|
+
{ },
|
|
27605
|
+
{ },
|
|
27606
|
+
null,
|
|
27607
|
+
['PureCloud OAuth'],
|
|
27608
|
+
['application/json'],
|
|
27609
|
+
['application/json']
|
|
27610
|
+
);
|
|
27611
|
+
}
|
|
27612
|
+
|
|
27586
27613
|
/**
|
|
27587
27614
|
* Delete a Rule Set.
|
|
27588
27615
|
*
|
|
@@ -30263,7 +30290,7 @@ class PresenceApi {
|
|
|
30263
30290
|
/**
|
|
30264
30291
|
* Presence service.
|
|
30265
30292
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
30266
|
-
* @version
|
|
30293
|
+
* @version 136.0.0
|
|
30267
30294
|
*/
|
|
30268
30295
|
|
|
30269
30296
|
/**
|
|
@@ -30409,31 +30436,6 @@ class PresenceApi {
|
|
|
30409
30436
|
);
|
|
30410
30437
|
}
|
|
30411
30438
|
|
|
30412
|
-
/**
|
|
30413
|
-
* Get a user's Microsoft Teams presence.
|
|
30414
|
-
* Gets the presence for a Microsoft Teams user. This will return the Microsoft Teams presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.
|
|
30415
|
-
* @param {String} userId user Id
|
|
30416
|
-
*/
|
|
30417
|
-
getUserPresencesMicrosoftteams(userId) {
|
|
30418
|
-
// verify the required parameter 'userId' is set
|
|
30419
|
-
if (userId === undefined || userId === null) {
|
|
30420
|
-
throw 'Missing the required parameter "userId" when calling getUserPresencesMicrosoftteams';
|
|
30421
|
-
}
|
|
30422
|
-
|
|
30423
|
-
return this.apiClient.callApi(
|
|
30424
|
-
'/api/v2/users/{userId}/presences/microsoftteams',
|
|
30425
|
-
'GET',
|
|
30426
|
-
{ 'userId': userId },
|
|
30427
|
-
{ },
|
|
30428
|
-
{ },
|
|
30429
|
-
{ },
|
|
30430
|
-
null,
|
|
30431
|
-
['PureCloud OAuth'],
|
|
30432
|
-
['application/json'],
|
|
30433
|
-
['application/json']
|
|
30434
|
-
);
|
|
30435
|
-
}
|
|
30436
|
-
|
|
30437
30439
|
/**
|
|
30438
30440
|
* Get a user's Genesys Cloud presence.
|
|
30439
30441
|
* Get the default Genesys Cloud user presence source PURECLOUD
|
|
@@ -30459,31 +30461,6 @@ class PresenceApi {
|
|
|
30459
30461
|
);
|
|
30460
30462
|
}
|
|
30461
30463
|
|
|
30462
|
-
/**
|
|
30463
|
-
* Get a user's Zoom Phone presence.
|
|
30464
|
-
* Gets the presence for a Zoom user. This will return the Zoom Phone presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.
|
|
30465
|
-
* @param {String} userId user Id
|
|
30466
|
-
*/
|
|
30467
|
-
getUserPresencesZoomphone(userId) {
|
|
30468
|
-
// verify the required parameter 'userId' is set
|
|
30469
|
-
if (userId === undefined || userId === null) {
|
|
30470
|
-
throw 'Missing the required parameter "userId" when calling getUserPresencesZoomphone';
|
|
30471
|
-
}
|
|
30472
|
-
|
|
30473
|
-
return this.apiClient.callApi(
|
|
30474
|
-
'/api/v2/users/{userId}/presences/zoomphone',
|
|
30475
|
-
'GET',
|
|
30476
|
-
{ 'userId': userId },
|
|
30477
|
-
{ },
|
|
30478
|
-
{ },
|
|
30479
|
-
{ },
|
|
30480
|
-
null,
|
|
30481
|
-
['PureCloud OAuth'],
|
|
30482
|
-
['application/json'],
|
|
30483
|
-
['application/json']
|
|
30484
|
-
);
|
|
30485
|
-
}
|
|
30486
|
-
|
|
30487
30464
|
/**
|
|
30488
30465
|
* Patch a user's Presence
|
|
30489
30466
|
* Patch a user's presence for the specified source that is not specifically listed. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
|
|
@@ -30635,7 +30612,7 @@ class QualityApi {
|
|
|
30635
30612
|
/**
|
|
30636
30613
|
* Quality service.
|
|
30637
30614
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
30638
|
-
* @version
|
|
30615
|
+
* @version 136.0.0
|
|
30639
30616
|
*/
|
|
30640
30617
|
|
|
30641
30618
|
/**
|
|
@@ -32213,7 +32190,7 @@ class RecordingApi {
|
|
|
32213
32190
|
/**
|
|
32214
32191
|
* Recording service.
|
|
32215
32192
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
32216
|
-
* @version
|
|
32193
|
+
* @version 136.0.0
|
|
32217
32194
|
*/
|
|
32218
32195
|
|
|
32219
32196
|
/**
|
|
@@ -32736,6 +32713,7 @@ class RecordingApi {
|
|
|
32736
32713
|
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
32737
32714
|
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
32738
32715
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
32716
|
+
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
32739
32717
|
*/
|
|
32740
32718
|
getRecordingCrossplatformMediaretentionpolicies(opts) {
|
|
32741
32719
|
opts = opts || {};
|
|
@@ -32745,7 +32723,7 @@ class RecordingApi {
|
|
|
32745
32723
|
'/api/v2/recording/crossplatform/mediaretentionpolicies',
|
|
32746
32724
|
'GET',
|
|
32747
32725
|
{ },
|
|
32748
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'] },
|
|
32726
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'],'deleteDaysThreshold': opts['deleteDaysThreshold'] },
|
|
32749
32727
|
{ },
|
|
32750
32728
|
{ },
|
|
32751
32729
|
null,
|
|
@@ -32868,6 +32846,51 @@ class RecordingApi {
|
|
|
32868
32846
|
);
|
|
32869
32847
|
}
|
|
32870
32848
|
|
|
32849
|
+
/**
|
|
32850
|
+
* Get the encryption key configurations
|
|
32851
|
+
*
|
|
32852
|
+
* @param {String} keyConfigurationId Key Configurations Id
|
|
32853
|
+
*/
|
|
32854
|
+
getRecordingKeyconfiguration(keyConfigurationId) {
|
|
32855
|
+
// verify the required parameter 'keyConfigurationId' is set
|
|
32856
|
+
if (keyConfigurationId === undefined || keyConfigurationId === null) {
|
|
32857
|
+
throw 'Missing the required parameter "keyConfigurationId" when calling getRecordingKeyconfiguration';
|
|
32858
|
+
}
|
|
32859
|
+
|
|
32860
|
+
return this.apiClient.callApi(
|
|
32861
|
+
'/api/v2/recording/keyconfigurations/{keyConfigurationId}',
|
|
32862
|
+
'GET',
|
|
32863
|
+
{ 'keyConfigurationId': keyConfigurationId },
|
|
32864
|
+
{ },
|
|
32865
|
+
{ },
|
|
32866
|
+
{ },
|
|
32867
|
+
null,
|
|
32868
|
+
['PureCloud OAuth'],
|
|
32869
|
+
['application/json'],
|
|
32870
|
+
['application/json']
|
|
32871
|
+
);
|
|
32872
|
+
}
|
|
32873
|
+
|
|
32874
|
+
/**
|
|
32875
|
+
* Get a list of key configurations data
|
|
32876
|
+
*
|
|
32877
|
+
*/
|
|
32878
|
+
getRecordingKeyconfigurations() {
|
|
32879
|
+
|
|
32880
|
+
return this.apiClient.callApi(
|
|
32881
|
+
'/api/v2/recording/keyconfigurations',
|
|
32882
|
+
'GET',
|
|
32883
|
+
{ },
|
|
32884
|
+
{ },
|
|
32885
|
+
{ },
|
|
32886
|
+
{ },
|
|
32887
|
+
null,
|
|
32888
|
+
['PureCloud OAuth'],
|
|
32889
|
+
['application/json'],
|
|
32890
|
+
['application/json']
|
|
32891
|
+
);
|
|
32892
|
+
}
|
|
32893
|
+
|
|
32871
32894
|
/**
|
|
32872
32895
|
* Get the local encryption settings
|
|
32873
32896
|
*
|
|
@@ -32927,6 +32950,7 @@ class RecordingApi {
|
|
|
32927
32950
|
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
32928
32951
|
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
32929
32952
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
32953
|
+
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
32930
32954
|
*/
|
|
32931
32955
|
getRecordingMediaretentionpolicies(opts) {
|
|
32932
32956
|
opts = opts || {};
|
|
@@ -32936,7 +32960,7 @@ class RecordingApi {
|
|
|
32936
32960
|
'/api/v2/recording/mediaretentionpolicies',
|
|
32937
32961
|
'GET',
|
|
32938
32962
|
{ },
|
|
32939
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'] },
|
|
32963
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'],'deleteDaysThreshold': opts['deleteDaysThreshold'] },
|
|
32940
32964
|
{ },
|
|
32941
32965
|
{ },
|
|
32942
32966
|
null,
|
|
@@ -33240,8 +33264,8 @@ class RecordingApi {
|
|
|
33240
33264
|
}
|
|
33241
33265
|
|
|
33242
33266
|
/**
|
|
33243
|
-
* Create a recording bulk job
|
|
33244
|
-
*
|
|
33267
|
+
* Create a recording bulk job.
|
|
33268
|
+
* Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state.
|
|
33245
33269
|
* @param {Object} body query
|
|
33246
33270
|
*/
|
|
33247
33271
|
postRecordingJobs(body) {
|
|
@@ -33264,6 +33288,56 @@ class RecordingApi {
|
|
|
33264
33288
|
);
|
|
33265
33289
|
}
|
|
33266
33290
|
|
|
33291
|
+
/**
|
|
33292
|
+
* Setup configurations for encryption key creation
|
|
33293
|
+
*
|
|
33294
|
+
* @param {Object} body Encryption Configuration
|
|
33295
|
+
*/
|
|
33296
|
+
postRecordingKeyconfigurations(body) {
|
|
33297
|
+
// verify the required parameter 'body' is set
|
|
33298
|
+
if (body === undefined || body === null) {
|
|
33299
|
+
throw 'Missing the required parameter "body" when calling postRecordingKeyconfigurations';
|
|
33300
|
+
}
|
|
33301
|
+
|
|
33302
|
+
return this.apiClient.callApi(
|
|
33303
|
+
'/api/v2/recording/keyconfigurations',
|
|
33304
|
+
'POST',
|
|
33305
|
+
{ },
|
|
33306
|
+
{ },
|
|
33307
|
+
{ },
|
|
33308
|
+
{ },
|
|
33309
|
+
body,
|
|
33310
|
+
['PureCloud OAuth'],
|
|
33311
|
+
['application/json'],
|
|
33312
|
+
['application/json']
|
|
33313
|
+
);
|
|
33314
|
+
}
|
|
33315
|
+
|
|
33316
|
+
/**
|
|
33317
|
+
* Validate encryption key configurations without saving it
|
|
33318
|
+
*
|
|
33319
|
+
* @param {Object} body Encryption Configuration
|
|
33320
|
+
*/
|
|
33321
|
+
postRecordingKeyconfigurationsValidate(body) {
|
|
33322
|
+
// verify the required parameter 'body' is set
|
|
33323
|
+
if (body === undefined || body === null) {
|
|
33324
|
+
throw 'Missing the required parameter "body" when calling postRecordingKeyconfigurationsValidate';
|
|
33325
|
+
}
|
|
33326
|
+
|
|
33327
|
+
return this.apiClient.callApi(
|
|
33328
|
+
'/api/v2/recording/keyconfigurations/validate',
|
|
33329
|
+
'POST',
|
|
33330
|
+
{ },
|
|
33331
|
+
{ },
|
|
33332
|
+
{ },
|
|
33333
|
+
{ },
|
|
33334
|
+
body,
|
|
33335
|
+
['PureCloud OAuth'],
|
|
33336
|
+
['application/json'],
|
|
33337
|
+
['application/json']
|
|
33338
|
+
);
|
|
33339
|
+
}
|
|
33340
|
+
|
|
33267
33341
|
/**
|
|
33268
33342
|
* create a local recording key
|
|
33269
33343
|
*
|
|
@@ -33598,6 +33672,36 @@ class RecordingApi {
|
|
|
33598
33672
|
);
|
|
33599
33673
|
}
|
|
33600
33674
|
|
|
33675
|
+
/**
|
|
33676
|
+
* Update the encryption key configurations
|
|
33677
|
+
*
|
|
33678
|
+
* @param {String} keyConfigurationId Key Configurations Id
|
|
33679
|
+
* @param {Object} body Encryption key configuration metadata
|
|
33680
|
+
*/
|
|
33681
|
+
putRecordingKeyconfiguration(keyConfigurationId, body) {
|
|
33682
|
+
// verify the required parameter 'keyConfigurationId' is set
|
|
33683
|
+
if (keyConfigurationId === undefined || keyConfigurationId === null) {
|
|
33684
|
+
throw 'Missing the required parameter "keyConfigurationId" when calling putRecordingKeyconfiguration';
|
|
33685
|
+
}
|
|
33686
|
+
// verify the required parameter 'body' is set
|
|
33687
|
+
if (body === undefined || body === null) {
|
|
33688
|
+
throw 'Missing the required parameter "body" when calling putRecordingKeyconfiguration';
|
|
33689
|
+
}
|
|
33690
|
+
|
|
33691
|
+
return this.apiClient.callApi(
|
|
33692
|
+
'/api/v2/recording/keyconfigurations/{keyConfigurationId}',
|
|
33693
|
+
'PUT',
|
|
33694
|
+
{ 'keyConfigurationId': keyConfigurationId },
|
|
33695
|
+
{ },
|
|
33696
|
+
{ },
|
|
33697
|
+
{ },
|
|
33698
|
+
body,
|
|
33699
|
+
['PureCloud OAuth'],
|
|
33700
|
+
['application/json'],
|
|
33701
|
+
['application/json']
|
|
33702
|
+
);
|
|
33703
|
+
}
|
|
33704
|
+
|
|
33601
33705
|
/**
|
|
33602
33706
|
* Update the local encryption settings
|
|
33603
33707
|
*
|
|
@@ -33739,7 +33843,7 @@ class ResponseManagementApi {
|
|
|
33739
33843
|
/**
|
|
33740
33844
|
* ResponseManagement service.
|
|
33741
33845
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
33742
|
-
* @version
|
|
33846
|
+
* @version 136.0.0
|
|
33743
33847
|
*/
|
|
33744
33848
|
|
|
33745
33849
|
/**
|
|
@@ -34223,7 +34327,7 @@ class RoutingApi {
|
|
|
34223
34327
|
/**
|
|
34224
34328
|
* Routing service.
|
|
34225
34329
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
34226
|
-
* @version
|
|
34330
|
+
* @version 136.0.0
|
|
34227
34331
|
*/
|
|
34228
34332
|
|
|
34229
34333
|
/**
|
|
@@ -34882,14 +34986,18 @@ class RoutingApi {
|
|
|
34882
34986
|
/**
|
|
34883
34987
|
* Get domains
|
|
34884
34988
|
*
|
|
34989
|
+
* @param {Object} opts Optional parameters
|
|
34990
|
+
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
34885
34991
|
*/
|
|
34886
|
-
getRoutingEmailDomains() {
|
|
34992
|
+
getRoutingEmailDomains(opts) {
|
|
34993
|
+
opts = opts || {};
|
|
34994
|
+
|
|
34887
34995
|
|
|
34888
34996
|
return this.apiClient.callApi(
|
|
34889
34997
|
'/api/v2/routing/email/domains',
|
|
34890
34998
|
'GET',
|
|
34891
34999
|
{ },
|
|
34892
|
-
{
|
|
35000
|
+
{ 'excludeStatus': opts['excludeStatus'] },
|
|
34893
35001
|
{ },
|
|
34894
35002
|
{ },
|
|
34895
35003
|
null,
|
|
@@ -37146,7 +37254,7 @@ class SCIMApi {
|
|
|
37146
37254
|
/**
|
|
37147
37255
|
* SCIM service.
|
|
37148
37256
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
37149
|
-
* @version
|
|
37257
|
+
* @version 136.0.0
|
|
37150
37258
|
*/
|
|
37151
37259
|
|
|
37152
37260
|
/**
|
|
@@ -38023,7 +38131,7 @@ class ScriptsApi {
|
|
|
38023
38131
|
/**
|
|
38024
38132
|
* Scripts service.
|
|
38025
38133
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
38026
|
-
* @version
|
|
38134
|
+
* @version 136.0.0
|
|
38027
38135
|
*/
|
|
38028
38136
|
|
|
38029
38137
|
/**
|
|
@@ -38139,6 +38247,7 @@ class ScriptsApi {
|
|
|
38139
38247
|
* @param {Object} opts.sortBy SortBy
|
|
38140
38248
|
* @param {Object} opts.sortOrder SortOrder
|
|
38141
38249
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
38250
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
38142
38251
|
*/
|
|
38143
38252
|
getScripts(opts) {
|
|
38144
38253
|
opts = opts || {};
|
|
@@ -38148,7 +38257,40 @@ class ScriptsApi {
|
|
|
38148
38257
|
'/api/v2/scripts',
|
|
38149
38258
|
'GET',
|
|
38150
38259
|
{ },
|
|
38151
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'scriptDataVersion': opts['scriptDataVersion'] },
|
|
38260
|
+
{ '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'] },
|
|
38261
|
+
{ },
|
|
38262
|
+
{ },
|
|
38263
|
+
null,
|
|
38264
|
+
['PureCloud OAuth'],
|
|
38265
|
+
['application/json'],
|
|
38266
|
+
['application/json']
|
|
38267
|
+
);
|
|
38268
|
+
}
|
|
38269
|
+
|
|
38270
|
+
/**
|
|
38271
|
+
* Get the metadata for a list of scripts
|
|
38272
|
+
*
|
|
38273
|
+
* @param {Object} opts Optional parameters
|
|
38274
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
38275
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
38276
|
+
* @param {String} opts.expand Expand
|
|
38277
|
+
* @param {String} opts.name Name filter
|
|
38278
|
+
* @param {String} opts.feature Feature filter
|
|
38279
|
+
* @param {String} opts.flowId Secure flow id filter
|
|
38280
|
+
* @param {Object} opts.sortBy SortBy
|
|
38281
|
+
* @param {Object} opts.sortOrder SortOrder
|
|
38282
|
+
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
38283
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
38284
|
+
*/
|
|
38285
|
+
getScriptsDivisionviews(opts) {
|
|
38286
|
+
opts = opts || {};
|
|
38287
|
+
|
|
38288
|
+
|
|
38289
|
+
return this.apiClient.callApi(
|
|
38290
|
+
'/api/v2/scripts/divisionviews',
|
|
38291
|
+
'GET',
|
|
38292
|
+
{ },
|
|
38293
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
38152
38294
|
{ },
|
|
38153
38295
|
{ },
|
|
38154
38296
|
null,
|
|
@@ -38169,6 +38311,7 @@ class ScriptsApi {
|
|
|
38169
38311
|
* @param {String} opts.feature Feature filter
|
|
38170
38312
|
* @param {String} opts.flowId Secure flow id filter
|
|
38171
38313
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
38314
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
38172
38315
|
*/
|
|
38173
38316
|
getScriptsPublished(opts) {
|
|
38174
38317
|
opts = opts || {};
|
|
@@ -38178,7 +38321,38 @@ class ScriptsApi {
|
|
|
38178
38321
|
'/api/v2/scripts/published',
|
|
38179
38322
|
'GET',
|
|
38180
38323
|
{ },
|
|
38181
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'] },
|
|
38324
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
38325
|
+
{ },
|
|
38326
|
+
{ },
|
|
38327
|
+
null,
|
|
38328
|
+
['PureCloud OAuth'],
|
|
38329
|
+
['application/json'],
|
|
38330
|
+
['application/json']
|
|
38331
|
+
);
|
|
38332
|
+
}
|
|
38333
|
+
|
|
38334
|
+
/**
|
|
38335
|
+
* Get the published scripts metadata.
|
|
38336
|
+
*
|
|
38337
|
+
* @param {Object} opts Optional parameters
|
|
38338
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
38339
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
38340
|
+
* @param {String} opts.expand Expand
|
|
38341
|
+
* @param {String} opts.name Name filter
|
|
38342
|
+
* @param {String} opts.feature Feature filter
|
|
38343
|
+
* @param {String} opts.flowId Secure flow id filter
|
|
38344
|
+
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
38345
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
38346
|
+
*/
|
|
38347
|
+
getScriptsPublishedDivisionviews(opts) {
|
|
38348
|
+
opts = opts || {};
|
|
38349
|
+
|
|
38350
|
+
|
|
38351
|
+
return this.apiClient.callApi(
|
|
38352
|
+
'/api/v2/scripts/published/divisionviews',
|
|
38353
|
+
'GET',
|
|
38354
|
+
{ },
|
|
38355
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
38182
38356
|
{ },
|
|
38183
38357
|
{ },
|
|
38184
38358
|
null,
|
|
@@ -38376,7 +38550,7 @@ class SearchApi {
|
|
|
38376
38550
|
/**
|
|
38377
38551
|
* Search service.
|
|
38378
38552
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
38379
|
-
* @version
|
|
38553
|
+
* @version 136.0.0
|
|
38380
38554
|
*/
|
|
38381
38555
|
|
|
38382
38556
|
/**
|
|
@@ -38911,7 +39085,7 @@ class SpeechTextAnalyticsApi {
|
|
|
38911
39085
|
/**
|
|
38912
39086
|
* SpeechTextAnalytics service.
|
|
38913
39087
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
38914
|
-
* @version
|
|
39088
|
+
* @version 136.0.0
|
|
38915
39089
|
*/
|
|
38916
39090
|
|
|
38917
39091
|
/**
|
|
@@ -39764,7 +39938,7 @@ class StationsApi {
|
|
|
39764
39938
|
/**
|
|
39765
39939
|
* Stations service.
|
|
39766
39940
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
39767
|
-
* @version
|
|
39941
|
+
* @version 136.0.0
|
|
39768
39942
|
*/
|
|
39769
39943
|
|
|
39770
39944
|
/**
|
|
@@ -39911,7 +40085,7 @@ class SuggestApi {
|
|
|
39911
40085
|
/**
|
|
39912
40086
|
* Suggest service.
|
|
39913
40087
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
39914
|
-
* @version
|
|
40088
|
+
* @version 136.0.0
|
|
39915
40089
|
*/
|
|
39916
40090
|
|
|
39917
40091
|
/**
|
|
@@ -40050,7 +40224,7 @@ class TelephonyApi {
|
|
|
40050
40224
|
/**
|
|
40051
40225
|
* Telephony service.
|
|
40052
40226
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
40053
|
-
* @version
|
|
40227
|
+
* @version 136.0.0
|
|
40054
40228
|
*/
|
|
40055
40229
|
|
|
40056
40230
|
/**
|
|
@@ -40158,7 +40332,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
40158
40332
|
/**
|
|
40159
40333
|
* TelephonyProvidersEdge service.
|
|
40160
40334
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
40161
|
-
* @version
|
|
40335
|
+
* @version 136.0.0
|
|
40162
40336
|
*/
|
|
40163
40337
|
|
|
40164
40338
|
/**
|
|
@@ -41573,7 +41747,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
41573
41747
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
41574
41748
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
41575
41749
|
* @param {String} opts.sortBy Sort by
|
|
41576
|
-
* @param {String} opts._number
|
|
41750
|
+
* @param {String} opts._number Deprecated, filtering by number not supported
|
|
41577
41751
|
*/
|
|
41578
41752
|
getTelephonyProvidersEdgesExtensionpools(opts) {
|
|
41579
41753
|
opts = opts || {};
|
|
@@ -43791,7 +43965,7 @@ class TextbotsApi {
|
|
|
43791
43965
|
/**
|
|
43792
43966
|
* Textbots service.
|
|
43793
43967
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
43794
|
-
* @version
|
|
43968
|
+
* @version 136.0.0
|
|
43795
43969
|
*/
|
|
43796
43970
|
|
|
43797
43971
|
/**
|
|
@@ -43919,7 +44093,7 @@ class TokensApi {
|
|
|
43919
44093
|
/**
|
|
43920
44094
|
* Tokens service.
|
|
43921
44095
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
43922
|
-
* @version
|
|
44096
|
+
* @version 136.0.0
|
|
43923
44097
|
*/
|
|
43924
44098
|
|
|
43925
44099
|
/**
|
|
@@ -44025,7 +44199,7 @@ class UploadsApi {
|
|
|
44025
44199
|
/**
|
|
44026
44200
|
* Uploads service.
|
|
44027
44201
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
44028
|
-
* @version
|
|
44202
|
+
* @version 136.0.0
|
|
44029
44203
|
*/
|
|
44030
44204
|
|
|
44031
44205
|
/**
|
|
@@ -44176,7 +44350,7 @@ class UsageApi {
|
|
|
44176
44350
|
/**
|
|
44177
44351
|
* Usage service.
|
|
44178
44352
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
44179
|
-
* @version
|
|
44353
|
+
* @version 136.0.0
|
|
44180
44354
|
*/
|
|
44181
44355
|
|
|
44182
44356
|
/**
|
|
@@ -44247,7 +44421,7 @@ class UserRecordingsApi {
|
|
|
44247
44421
|
/**
|
|
44248
44422
|
* UserRecordings service.
|
|
44249
44423
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
44250
|
-
* @version
|
|
44424
|
+
* @version 136.0.0
|
|
44251
44425
|
*/
|
|
44252
44426
|
|
|
44253
44427
|
/**
|
|
@@ -44431,7 +44605,7 @@ class UsersApi {
|
|
|
44431
44605
|
/**
|
|
44432
44606
|
* Users service.
|
|
44433
44607
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
44434
|
-
* @version
|
|
44608
|
+
* @version 136.0.0
|
|
44435
44609
|
*/
|
|
44436
44610
|
|
|
44437
44611
|
/**
|
|
@@ -46733,7 +46907,7 @@ class UtilitiesApi {
|
|
|
46733
46907
|
/**
|
|
46734
46908
|
* Utilities service.
|
|
46735
46909
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
46736
|
-
* @version
|
|
46910
|
+
* @version 136.0.0
|
|
46737
46911
|
*/
|
|
46738
46912
|
|
|
46739
46913
|
/**
|
|
@@ -46844,7 +47018,7 @@ class VoicemailApi {
|
|
|
46844
47018
|
/**
|
|
46845
47019
|
* Voicemail service.
|
|
46846
47020
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
46847
|
-
* @version
|
|
47021
|
+
* @version 136.0.0
|
|
46848
47022
|
*/
|
|
46849
47023
|
|
|
46850
47024
|
/**
|
|
@@ -47511,7 +47685,7 @@ class WebChatApi {
|
|
|
47511
47685
|
/**
|
|
47512
47686
|
* WebChat service.
|
|
47513
47687
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
47514
|
-
* @version
|
|
47688
|
+
* @version 136.0.0
|
|
47515
47689
|
*/
|
|
47516
47690
|
|
|
47517
47691
|
/**
|
|
@@ -48055,7 +48229,7 @@ class WebDeploymentsApi {
|
|
|
48055
48229
|
/**
|
|
48056
48230
|
* WebDeployments service.
|
|
48057
48231
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
48058
|
-
* @version
|
|
48232
|
+
* @version 136.0.0
|
|
48059
48233
|
*/
|
|
48060
48234
|
|
|
48061
48235
|
/**
|
|
@@ -48410,7 +48584,7 @@ class WebMessagingApi {
|
|
|
48410
48584
|
/**
|
|
48411
48585
|
* WebMessaging service.
|
|
48412
48586
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
48413
|
-
* @version
|
|
48587
|
+
* @version 136.0.0
|
|
48414
48588
|
*/
|
|
48415
48589
|
|
|
48416
48590
|
/**
|
|
@@ -48456,7 +48630,7 @@ class WidgetsApi {
|
|
|
48456
48630
|
/**
|
|
48457
48631
|
* Widgets service.
|
|
48458
48632
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
48459
|
-
* @version
|
|
48633
|
+
* @version 136.0.0
|
|
48460
48634
|
*/
|
|
48461
48635
|
|
|
48462
48636
|
/**
|
|
@@ -48602,7 +48776,7 @@ class WorkforceManagementApi {
|
|
|
48602
48776
|
/**
|
|
48603
48777
|
* WorkforceManagement service.
|
|
48604
48778
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
48605
|
-
* @version
|
|
48779
|
+
* @version 136.0.0
|
|
48606
48780
|
*/
|
|
48607
48781
|
|
|
48608
48782
|
/**
|
|
@@ -48800,7 +48974,7 @@ class WorkforceManagementApi {
|
|
|
48800
48974
|
/**
|
|
48801
48975
|
* Delete a short term forecast
|
|
48802
48976
|
* Must not be tied to any schedules
|
|
48803
|
-
* @param {String} businessUnitId The
|
|
48977
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
48804
48978
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
48805
48979
|
* @param {String} forecastId The ID of the forecast
|
|
48806
48980
|
*/
|
|
@@ -48880,7 +49054,7 @@ class WorkforceManagementApi {
|
|
|
48880
49054
|
/**
|
|
48881
49055
|
* Deletes a time off limit object
|
|
48882
49056
|
*
|
|
48883
|
-
* @param {String} managementUnitId The
|
|
49057
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
48884
49058
|
* @param {String} timeOffLimitId The ID of the time off limit object to delete
|
|
48885
49059
|
*/
|
|
48886
49060
|
deleteWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
@@ -48910,7 +49084,7 @@ class WorkforceManagementApi {
|
|
|
48910
49084
|
/**
|
|
48911
49085
|
* Deletes a time off plan
|
|
48912
49086
|
*
|
|
48913
|
-
* @param {String} managementUnitId The management unit
|
|
49087
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
48914
49088
|
* @param {String} timeOffPlanId The ID of the time off plan to delete
|
|
48915
49089
|
*/
|
|
48916
49090
|
deleteWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
@@ -49179,7 +49353,7 @@ class WorkforceManagementApi {
|
|
|
49179
49353
|
/**
|
|
49180
49354
|
* Get intraday planning groups for the given date
|
|
49181
49355
|
*
|
|
49182
|
-
* @param {String} businessUnitId The
|
|
49356
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
49183
49357
|
* @param {String} _date yyyy-MM-dd date string interpreted in the configured business unit time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
49184
49358
|
*/
|
|
49185
49359
|
getWorkforcemanagementBusinessunitIntradayPlanninggroups(businessUnitId, _date) {
|
|
@@ -49632,7 +49806,7 @@ class WorkforceManagementApi {
|
|
|
49632
49806
|
/**
|
|
49633
49807
|
* Get a short term forecast
|
|
49634
49808
|
*
|
|
49635
|
-
* @param {String} businessUnitId The
|
|
49809
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49636
49810
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
49637
49811
|
* @param {String} forecastId The ID of the forecast
|
|
49638
49812
|
* @param {Object} opts Optional parameters
|
|
@@ -49671,7 +49845,7 @@ class WorkforceManagementApi {
|
|
|
49671
49845
|
/**
|
|
49672
49846
|
* Get the result of a short term forecast calculation
|
|
49673
49847
|
* Includes modifications unless you pass the doNotApplyModifications query parameter
|
|
49674
|
-
* @param {String} businessUnitId The
|
|
49848
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49675
49849
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
49676
49850
|
* @param {String} forecastId The ID of the forecast
|
|
49677
49851
|
* @param {Object} opts Optional parameters
|
|
@@ -49711,7 +49885,7 @@ class WorkforceManagementApi {
|
|
|
49711
49885
|
/**
|
|
49712
49886
|
* Gets the forecast generation results
|
|
49713
49887
|
*
|
|
49714
|
-
* @param {String} businessUnitId The
|
|
49888
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49715
49889
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
49716
49890
|
* @param {String} forecastId The ID of the forecast
|
|
49717
49891
|
*/
|
|
@@ -49746,7 +49920,7 @@ class WorkforceManagementApi {
|
|
|
49746
49920
|
/**
|
|
49747
49921
|
* Get the result of a long term forecast calculation
|
|
49748
49922
|
* Includes modifications unless you pass the doNotApplyModifications query parameter
|
|
49749
|
-
* @param {String} businessUnitId The
|
|
49923
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49750
49924
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
49751
49925
|
* @param {String} forecastId The ID of the forecast
|
|
49752
49926
|
* @param {Object} opts Optional parameters
|
|
@@ -49785,7 +49959,7 @@ class WorkforceManagementApi {
|
|
|
49785
49959
|
/**
|
|
49786
49960
|
* Gets the forecast planning group snapshot
|
|
49787
49961
|
*
|
|
49788
|
-
* @param {String} businessUnitId The
|
|
49962
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49789
49963
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
49790
49964
|
* @param {String} forecastId The ID of the forecast
|
|
49791
49965
|
*/
|
|
@@ -49820,7 +49994,7 @@ class WorkforceManagementApi {
|
|
|
49820
49994
|
/**
|
|
49821
49995
|
* Get short term forecasts
|
|
49822
49996
|
* Use \"recent\" (without quotes) for the `weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any forecast which spans the specified week
|
|
49823
|
-
* @param {String} businessUnitId The
|
|
49997
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49824
49998
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format or 'recent' (without quotes) to fetch recent forecasts
|
|
49825
49999
|
*/
|
|
49826
50000
|
getWorkforcemanagementBusinessunitWeekShorttermforecasts(businessUnitId, weekDateId) {
|
|
@@ -50038,7 +50212,7 @@ class WorkforceManagementApi {
|
|
|
50038
50212
|
/**
|
|
50039
50213
|
* Get a list of user schedule adherence records for the requested management unit
|
|
50040
50214
|
*
|
|
50041
|
-
* @param {String} managementUnitId The
|
|
50215
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
50042
50216
|
* @param {Object} opts Optional parameters
|
|
50043
50217
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
50044
50218
|
*/
|
|
@@ -50067,7 +50241,7 @@ class WorkforceManagementApi {
|
|
|
50067
50241
|
/**
|
|
50068
50242
|
* Get data for agent in the management unit
|
|
50069
50243
|
*
|
|
50070
|
-
* @param {String} managementUnitId The
|
|
50244
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50071
50245
|
* @param {String} agentId The agent id
|
|
50072
50246
|
* @param {Object} opts Optional parameters
|
|
50073
50247
|
* @param {Boolean} opts.excludeCapabilities Excludes all capabilities of the agent such as queues, languages, and skills
|
|
@@ -50101,7 +50275,7 @@ class WorkforceManagementApi {
|
|
|
50101
50275
|
/**
|
|
50102
50276
|
* Gets all the shift trades for a given agent
|
|
50103
50277
|
*
|
|
50104
|
-
* @param {String} managementUnitId The
|
|
50278
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50105
50279
|
* @param {String} agentId The agent id
|
|
50106
50280
|
*/
|
|
50107
50281
|
getWorkforcemanagementManagementunitAgentShifttrades(managementUnitId, agentId) {
|
|
@@ -50131,7 +50305,7 @@ class WorkforceManagementApi {
|
|
|
50131
50305
|
/**
|
|
50132
50306
|
* Gets a summary of all shift trades in the matched state
|
|
50133
50307
|
*
|
|
50134
|
-
* @param {String} managementUnitId The
|
|
50308
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50135
50309
|
*/
|
|
50136
50310
|
getWorkforcemanagementManagementunitShifttradesMatched(managementUnitId) {
|
|
50137
50311
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50156,7 +50330,7 @@ class WorkforceManagementApi {
|
|
|
50156
50330
|
/**
|
|
50157
50331
|
* Gets list of users available for whom you can send direct shift trade requests
|
|
50158
50332
|
*
|
|
50159
|
-
* @param {String} managementUnitId The
|
|
50333
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50160
50334
|
*/
|
|
50161
50335
|
getWorkforcemanagementManagementunitShifttradesUsers(managementUnitId) {
|
|
50162
50336
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50181,7 +50355,7 @@ class WorkforceManagementApi {
|
|
|
50181
50355
|
/**
|
|
50182
50356
|
* Gets a time off limit object
|
|
50183
50357
|
* Returns properties of time off limit object, but not daily values.
|
|
50184
|
-
* @param {String} managementUnitId The
|
|
50358
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
50185
50359
|
* @param {String} timeOffLimitId The ID of the time off limit to fetch
|
|
50186
50360
|
*/
|
|
50187
50361
|
getWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
@@ -50211,7 +50385,7 @@ class WorkforceManagementApi {
|
|
|
50211
50385
|
/**
|
|
50212
50386
|
* Gets a list of time off limit objects under management unit.
|
|
50213
50387
|
* Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.
|
|
50214
|
-
* @param {String} managementUnitId The
|
|
50388
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
50215
50389
|
*/
|
|
50216
50390
|
getWorkforcemanagementManagementunitTimeofflimits(managementUnitId) {
|
|
50217
50391
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50236,7 +50410,7 @@ class WorkforceManagementApi {
|
|
|
50236
50410
|
/**
|
|
50237
50411
|
* Gets a time off plan
|
|
50238
50412
|
*
|
|
50239
|
-
* @param {String} managementUnitId The management unit
|
|
50413
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
50240
50414
|
* @param {String} timeOffPlanId The ID of the time off plan to fetch
|
|
50241
50415
|
*/
|
|
50242
50416
|
getWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
@@ -50266,7 +50440,7 @@ class WorkforceManagementApi {
|
|
|
50266
50440
|
/**
|
|
50267
50441
|
* Gets a list of time off plans
|
|
50268
50442
|
*
|
|
50269
|
-
* @param {String} managementUnitId The management unit
|
|
50443
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
50270
50444
|
*/
|
|
50271
50445
|
getWorkforcemanagementManagementunitTimeoffplans(managementUnitId) {
|
|
50272
50446
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50291,7 +50465,7 @@ class WorkforceManagementApi {
|
|
|
50291
50465
|
/**
|
|
50292
50466
|
* Get a time off request
|
|
50293
50467
|
*
|
|
50294
|
-
* @param {String} managementUnitId The
|
|
50468
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50295
50469
|
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
50296
50470
|
* @param {String} timeOffRequestId Time Off Request Id
|
|
50297
50471
|
*/
|
|
@@ -50326,7 +50500,7 @@ class WorkforceManagementApi {
|
|
|
50326
50500
|
/**
|
|
50327
50501
|
* Retrieves time off limit, allocated and waitlisted values according to specific time off request
|
|
50328
50502
|
*
|
|
50329
|
-
* @param {String} managementUnitId The
|
|
50503
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
50330
50504
|
* @param {String} userId The userId to whom the time off request applies.
|
|
50331
50505
|
* @param {String} timeOffRequestId The ID of the time off request, which dates and activityCodeId determine limit values to retrieve
|
|
50332
50506
|
*/
|
|
@@ -50361,7 +50535,7 @@ class WorkforceManagementApi {
|
|
|
50361
50535
|
/**
|
|
50362
50536
|
* Get a list of time off requests for a given user
|
|
50363
50537
|
*
|
|
50364
|
-
* @param {String} managementUnitId The
|
|
50538
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50365
50539
|
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
50366
50540
|
* @param {Object} opts Optional parameters
|
|
50367
50541
|
* @param {Boolean} opts.recentlyReviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
|
|
@@ -50395,7 +50569,7 @@ class WorkforceManagementApi {
|
|
|
50395
50569
|
/**
|
|
50396
50570
|
* Get users in the management unit
|
|
50397
50571
|
*
|
|
50398
|
-
* @param {String} managementUnitId The
|
|
50572
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50399
50573
|
*/
|
|
50400
50574
|
getWorkforcemanagementManagementunitUsers(managementUnitId) {
|
|
50401
50575
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50496,7 +50670,7 @@ class WorkforceManagementApi {
|
|
|
50496
50670
|
/**
|
|
50497
50671
|
* Gets all the shift trades for a given week
|
|
50498
50672
|
*
|
|
50499
|
-
* @param {String} managementUnitId The
|
|
50673
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50500
50674
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
50501
50675
|
* @param {Object} opts Optional parameters
|
|
50502
50676
|
* @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
|
|
@@ -50769,7 +50943,7 @@ class WorkforceManagementApi {
|
|
|
50769
50943
|
/**
|
|
50770
50944
|
* Get a time off request for the current user
|
|
50771
50945
|
*
|
|
50772
|
-
* @param {String} timeOffRequestId
|
|
50946
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
50773
50947
|
*/
|
|
50774
50948
|
getWorkforcemanagementTimeoffrequest(timeOffRequestId) {
|
|
50775
50949
|
// verify the required parameter 'timeOffRequestId' is set
|
|
@@ -50794,7 +50968,7 @@ class WorkforceManagementApi {
|
|
|
50794
50968
|
/**
|
|
50795
50969
|
* Get the daily waitlist positions of a time off request for the current user
|
|
50796
50970
|
*
|
|
50797
|
-
* @param {String} timeOffRequestId
|
|
50971
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
50798
50972
|
*/
|
|
50799
50973
|
getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId) {
|
|
50800
50974
|
// verify the required parameter 'timeOffRequestId' is set
|
|
@@ -51037,7 +51211,7 @@ class WorkforceManagementApi {
|
|
|
51037
51211
|
/**
|
|
51038
51212
|
* Updates a time off limit object.
|
|
51039
51213
|
* Updates time off limit object properties, but not daily values.
|
|
51040
|
-
* @param {String} managementUnitId The
|
|
51214
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
51041
51215
|
* @param {String} timeOffLimitId The id of time off limit object to update
|
|
51042
51216
|
* @param {Object} opts Optional parameters
|
|
51043
51217
|
* @param {Object} opts.body body
|
|
@@ -51071,7 +51245,7 @@ class WorkforceManagementApi {
|
|
|
51071
51245
|
/**
|
|
51072
51246
|
* Updates a time off plan
|
|
51073
51247
|
*
|
|
51074
|
-
* @param {String} managementUnitId The management unit
|
|
51248
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
51075
51249
|
* @param {String} timeOffPlanId The ID of the time off plan to update
|
|
51076
51250
|
* @param {Object} opts Optional parameters
|
|
51077
51251
|
* @param {Object} opts.body body
|
|
@@ -51105,7 +51279,7 @@ class WorkforceManagementApi {
|
|
|
51105
51279
|
/**
|
|
51106
51280
|
* Update a time off request
|
|
51107
51281
|
*
|
|
51108
|
-
* @param {String} managementUnitId The
|
|
51282
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
51109
51283
|
* @param {String} userId The id of the user the requested time off request belongs to
|
|
51110
51284
|
* @param {String} timeOffRequestId The id of the time off request to update
|
|
51111
51285
|
* @param {Object} opts Optional parameters
|
|
@@ -51144,7 +51318,7 @@ class WorkforceManagementApi {
|
|
|
51144
51318
|
/**
|
|
51145
51319
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
51146
51320
|
*
|
|
51147
|
-
* @param {String} managementUnitId The
|
|
51321
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
51148
51322
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51149
51323
|
* @param {Object} body body
|
|
51150
51324
|
* @param {String} tradeId The ID of the shift trade to update
|
|
@@ -51253,7 +51427,7 @@ class WorkforceManagementApi {
|
|
|
51253
51427
|
/**
|
|
51254
51428
|
* Update a time off request for the current user
|
|
51255
51429
|
*
|
|
51256
|
-
* @param {String} timeOffRequestId
|
|
51430
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
51257
51431
|
* @param {Object} opts Optional parameters
|
|
51258
51432
|
* @param {Object} opts.body body
|
|
51259
51433
|
*/
|
|
@@ -51390,7 +51564,7 @@ class WorkforceManagementApi {
|
|
|
51390
51564
|
/**
|
|
51391
51565
|
* Get intraday data for the given date for the requested planningGroupIds
|
|
51392
51566
|
*
|
|
51393
|
-
* @param {String} businessUnitId The
|
|
51567
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
51394
51568
|
* @param {Object} opts Optional parameters
|
|
51395
51569
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
51396
51570
|
* @param {Object} opts.body body
|
|
@@ -51823,7 +51997,7 @@ class WorkforceManagementApi {
|
|
|
51823
51997
|
/**
|
|
51824
51998
|
* Copy a short term forecast
|
|
51825
51999
|
*
|
|
51826
|
-
* @param {String} businessUnitId The
|
|
52000
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51827
52001
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51828
52002
|
* @param {String} forecastId The ID of the forecast to copy
|
|
51829
52003
|
* @param {Object} body body
|
|
@@ -51867,7 +52041,7 @@ class WorkforceManagementApi {
|
|
|
51867
52041
|
/**
|
|
51868
52042
|
* Generate a short term forecast
|
|
51869
52043
|
*
|
|
51870
|
-
* @param {String} businessUnitId The
|
|
52044
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51871
52045
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51872
52046
|
* @param {Object} body
|
|
51873
52047
|
* @param {Object} opts Optional parameters
|
|
@@ -51906,7 +52080,7 @@ class WorkforceManagementApi {
|
|
|
51906
52080
|
/**
|
|
51907
52081
|
* Starts importing the uploaded short term forecast
|
|
51908
52082
|
* Call after uploading the forecast data to the url supplied by the /import/uploadurl route
|
|
51909
|
-
* @param {String} businessUnitId The
|
|
52083
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51910
52084
|
* @param {String} weekDateId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51911
52085
|
* @param {Object} body
|
|
51912
52086
|
*/
|
|
@@ -51941,7 +52115,7 @@ class WorkforceManagementApi {
|
|
|
51941
52115
|
/**
|
|
51942
52116
|
* Creates a signed upload URL for importing a short term forecast
|
|
51943
52117
|
* Once the upload is complete, call the /import route to start the short term forecast import process
|
|
51944
|
-
* @param {String} businessUnitId The
|
|
52118
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51945
52119
|
* @param {String} weekDateId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51946
52120
|
* @param {Object} body body
|
|
51947
52121
|
*/
|
|
@@ -52068,7 +52242,7 @@ class WorkforceManagementApi {
|
|
|
52068
52242
|
/**
|
|
52069
52243
|
* Query published schedules for given given time range for set of users
|
|
52070
52244
|
*
|
|
52071
|
-
* @param {String} managementUnitId The
|
|
52245
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52072
52246
|
* @param {Object} opts Optional parameters
|
|
52073
52247
|
* @param {Object} opts.body body
|
|
52074
52248
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
@@ -52099,7 +52273,7 @@ class WorkforceManagementApi {
|
|
|
52099
52273
|
/**
|
|
52100
52274
|
* Request a historical adherence report
|
|
52101
52275
|
* The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
|
|
52102
|
-
* @param {String} managementUnitId The
|
|
52276
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
52103
52277
|
* @param {Object} opts Optional parameters
|
|
52104
52278
|
* @param {Object} opts.body body
|
|
52105
52279
|
*/
|
|
@@ -52157,7 +52331,7 @@ class WorkforceManagementApi {
|
|
|
52157
52331
|
/**
|
|
52158
52332
|
* Query published schedules for given given time range for set of users
|
|
52159
52333
|
*
|
|
52160
|
-
* @param {String} managementUnitId The
|
|
52334
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52161
52335
|
* @param {Object} opts Optional parameters
|
|
52162
52336
|
* @param {Object} opts.body body
|
|
52163
52337
|
*/
|
|
@@ -52186,7 +52360,7 @@ class WorkforceManagementApi {
|
|
|
52186
52360
|
/**
|
|
52187
52361
|
* Creates a new time off limit object under management unit.
|
|
52188
52362
|
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
52189
|
-
* @param {String} managementUnitId The
|
|
52363
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52190
52364
|
* @param {Object} opts Optional parameters
|
|
52191
52365
|
* @param {Object} opts.body body
|
|
52192
52366
|
*/
|
|
@@ -52215,7 +52389,7 @@ class WorkforceManagementApi {
|
|
|
52215
52389
|
/**
|
|
52216
52390
|
* Retrieves time off limit related values based on a given set of filters.
|
|
52217
52391
|
*
|
|
52218
|
-
* @param {String} managementUnitId The
|
|
52392
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52219
52393
|
* @param {Object} opts Optional parameters
|
|
52220
52394
|
* @param {Object} opts.body body
|
|
52221
52395
|
*/
|
|
@@ -52244,7 +52418,7 @@ class WorkforceManagementApi {
|
|
|
52244
52418
|
/**
|
|
52245
52419
|
* Creates a new time off plan
|
|
52246
52420
|
*
|
|
52247
|
-
* @param {String} managementUnitId The management unit
|
|
52421
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
52248
52422
|
* @param {Object} opts Optional parameters
|
|
52249
52423
|
* @param {Object} opts.body body
|
|
52250
52424
|
*/
|
|
@@ -52273,7 +52447,7 @@ class WorkforceManagementApi {
|
|
|
52273
52447
|
/**
|
|
52274
52448
|
* Create a new time off request
|
|
52275
52449
|
*
|
|
52276
|
-
* @param {String} managementUnitId The
|
|
52450
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52277
52451
|
* @param {Object} opts Optional parameters
|
|
52278
52452
|
* @param {Object} opts.body body
|
|
52279
52453
|
*/
|
|
@@ -52302,7 +52476,7 @@ class WorkforceManagementApi {
|
|
|
52302
52476
|
/**
|
|
52303
52477
|
* Fetches time off requests matching the conditions specified in the request body
|
|
52304
52478
|
* Request body requires one of the following: User ID is specified, statuses == [Pending] or date range to be specified and less than or equal to 33 days. All other fields are filters
|
|
52305
|
-
* @param {String} managementUnitId The
|
|
52479
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52306
52480
|
* @param {Object} opts Optional parameters
|
|
52307
52481
|
* @param {Object} opts.body body
|
|
52308
52482
|
*/
|
|
@@ -52331,7 +52505,7 @@ class WorkforceManagementApi {
|
|
|
52331
52505
|
/**
|
|
52332
52506
|
* Retrieves daily waitlist position for a list of time off requests
|
|
52333
52507
|
*
|
|
52334
|
-
* @param {String} managementUnitId The
|
|
52508
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52335
52509
|
* @param {Object} opts Optional parameters
|
|
52336
52510
|
* @param {Object} opts.body body
|
|
52337
52511
|
*/
|
|
@@ -52360,7 +52534,7 @@ class WorkforceManagementApi {
|
|
|
52360
52534
|
/**
|
|
52361
52535
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
52362
52536
|
*
|
|
52363
|
-
* @param {String} managementUnitId The
|
|
52537
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52364
52538
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
52365
52539
|
* @param {Object} body body
|
|
52366
52540
|
* @param {String} tradeId The ID of the shift trade to update
|
|
@@ -52400,7 +52574,7 @@ class WorkforceManagementApi {
|
|
|
52400
52574
|
/**
|
|
52401
52575
|
* Adds a shift trade
|
|
52402
52576
|
*
|
|
52403
|
-
* @param {String} managementUnitId The
|
|
52577
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52404
52578
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
52405
52579
|
* @param {Object} body body
|
|
52406
52580
|
*/
|
|
@@ -52435,7 +52609,7 @@ class WorkforceManagementApi {
|
|
|
52435
52609
|
/**
|
|
52436
52610
|
* Searches for potential shift trade matches for the current agent
|
|
52437
52611
|
*
|
|
52438
|
-
* @param {String} managementUnitId The
|
|
52612
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52439
52613
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
52440
52614
|
* @param {Object} body body
|
|
52441
52615
|
*/
|
|
@@ -52470,7 +52644,7 @@ class WorkforceManagementApi {
|
|
|
52470
52644
|
/**
|
|
52471
52645
|
* Updates the state of a batch of shift trades
|
|
52472
52646
|
* Admin functionality is not supported with \"mine\".
|
|
52473
|
-
* @param {String} managementUnitId The
|
|
52647
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52474
52648
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
52475
52649
|
* @param {Object} body body
|
|
52476
52650
|
* @param {Object} opts Optional parameters
|
|
@@ -52791,7 +52965,7 @@ class WorkforceManagementApi {
|
|
|
52791
52965
|
/**
|
|
52792
52966
|
* Sets daily values for a date range of time off limit object
|
|
52793
52967
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
52794
|
-
* @param {String} managementUnitId The
|
|
52968
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52795
52969
|
* @param {String} timeOffLimitId The ID of the time off limit object to set values for
|
|
52796
52970
|
* @param {Object} opts Optional parameters
|
|
52797
52971
|
* @param {Object} opts.body body
|
|
@@ -52853,7 +53027,7 @@ class WorkforceManagementApi {
|
|
|
52853
53027
|
* </pre>
|
|
52854
53028
|
* </p>
|
|
52855
53029
|
* @module purecloud-platform-client-v2/index
|
|
52856
|
-
* @version
|
|
53030
|
+
* @version 136.0.0
|
|
52857
53031
|
*/
|
|
52858
53032
|
class platformClient {
|
|
52859
53033
|
constructor() {
|