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
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -2265,7 +2265,7 @@ class Configuration {
|
|
|
2265
2265
|
|
|
2266
2266
|
/**
|
|
2267
2267
|
* @module purecloud-platform-client-v2/ApiClient
|
|
2268
|
-
* @version
|
|
2268
|
+
* @version 136.0.0
|
|
2269
2269
|
*/
|
|
2270
2270
|
class ApiClient {
|
|
2271
2271
|
/**
|
|
@@ -3205,7 +3205,7 @@ class ApiClient {
|
|
|
3205
3205
|
|
|
3206
3206
|
// set header parameters
|
|
3207
3207
|
request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
|
|
3208
|
-
//request.set({ 'purecloud-sdk': '
|
|
3208
|
+
//request.set({ 'purecloud-sdk': '136.0.0' });
|
|
3209
3209
|
|
|
3210
3210
|
// set request timeout
|
|
3211
3211
|
request.timeout(that.timeout);
|
|
@@ -3305,7 +3305,7 @@ class AlertingApi {
|
|
|
3305
3305
|
/**
|
|
3306
3306
|
* Alerting service.
|
|
3307
3307
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3308
|
-
* @version
|
|
3308
|
+
* @version 136.0.0
|
|
3309
3309
|
*/
|
|
3310
3310
|
|
|
3311
3311
|
/**
|
|
@@ -3619,7 +3619,7 @@ class AnalyticsApi {
|
|
|
3619
3619
|
/**
|
|
3620
3620
|
* Analytics service.
|
|
3621
3621
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3622
|
-
* @version
|
|
3622
|
+
* @version 136.0.0
|
|
3623
3623
|
*/
|
|
3624
3624
|
|
|
3625
3625
|
/**
|
|
@@ -4801,7 +4801,7 @@ class ArchitectApi {
|
|
|
4801
4801
|
/**
|
|
4802
4802
|
* Architect service.
|
|
4803
4803
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4804
|
-
* @version
|
|
4804
|
+
* @version 136.0.0
|
|
4805
4805
|
*/
|
|
4806
4806
|
|
|
4807
4807
|
/**
|
|
@@ -7797,7 +7797,7 @@ class AuditApi {
|
|
|
7797
7797
|
/**
|
|
7798
7798
|
* Audit service.
|
|
7799
7799
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
7800
|
-
* @version
|
|
7800
|
+
* @version 136.0.0
|
|
7801
7801
|
*/
|
|
7802
7802
|
|
|
7803
7803
|
/**
|
|
@@ -7968,7 +7968,7 @@ class AuthorizationApi {
|
|
|
7968
7968
|
/**
|
|
7969
7969
|
* Authorization service.
|
|
7970
7970
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
7971
|
-
* @version
|
|
7971
|
+
* @version 136.0.0
|
|
7972
7972
|
*/
|
|
7973
7973
|
|
|
7974
7974
|
/**
|
|
@@ -9151,7 +9151,7 @@ class BillingApi {
|
|
|
9151
9151
|
/**
|
|
9152
9152
|
* Billing service.
|
|
9153
9153
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9154
|
-
* @version
|
|
9154
|
+
* @version 136.0.0
|
|
9155
9155
|
*/
|
|
9156
9156
|
|
|
9157
9157
|
/**
|
|
@@ -9231,7 +9231,7 @@ class ChatApi {
|
|
|
9231
9231
|
/**
|
|
9232
9232
|
* Chat service.
|
|
9233
9233
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
9234
|
-
* @version
|
|
9234
|
+
* @version 136.0.0
|
|
9235
9235
|
*/
|
|
9236
9236
|
|
|
9237
9237
|
/**
|
|
@@ -9322,7 +9322,7 @@ class CoachingApi {
|
|
|
9322
9322
|
/**
|
|
9323
9323
|
* Coaching service.
|
|
9324
9324
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9325
|
-
* @version
|
|
9325
|
+
* @version 136.0.0
|
|
9326
9326
|
*/
|
|
9327
9327
|
|
|
9328
9328
|
/**
|
|
@@ -9899,7 +9899,7 @@ class ContentManagementApi {
|
|
|
9899
9899
|
/**
|
|
9900
9900
|
* ContentManagement service.
|
|
9901
9901
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
9902
|
-
* @version
|
|
9902
|
+
* @version 136.0.0
|
|
9903
9903
|
*/
|
|
9904
9904
|
|
|
9905
9905
|
/**
|
|
@@ -11039,7 +11039,7 @@ class ConversationsApi {
|
|
|
11039
11039
|
/**
|
|
11040
11040
|
* Conversations service.
|
|
11041
11041
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
11042
|
-
* @version
|
|
11042
|
+
* @version 136.0.0
|
|
11043
11043
|
*/
|
|
11044
11044
|
|
|
11045
11045
|
/**
|
|
@@ -12944,7 +12944,7 @@ class ConversationsApi {
|
|
|
12944
12944
|
/**
|
|
12945
12945
|
* Get a list of Messaging Stickers
|
|
12946
12946
|
*
|
|
12947
|
-
* @param {
|
|
12947
|
+
* @param {Object} messengerType Messenger Type
|
|
12948
12948
|
* @param {Object} opts Optional parameters
|
|
12949
12949
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
12950
12950
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
@@ -13132,7 +13132,7 @@ class ConversationsApi {
|
|
|
13132
13132
|
}
|
|
13133
13133
|
|
|
13134
13134
|
/**
|
|
13135
|
-
* Update a conversation by setting
|
|
13135
|
+
* Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
13136
13136
|
*
|
|
13137
13137
|
* @param {String} conversationId conversationId
|
|
13138
13138
|
* @param {Object} body Conversation
|
|
@@ -14118,8 +14118,8 @@ class ConversationsApi {
|
|
|
14118
14118
|
}
|
|
14119
14119
|
|
|
14120
14120
|
/**
|
|
14121
|
-
* Update or activate a WhatsApp messaging integration
|
|
14122
|
-
* The following steps are required in order to fully activate a
|
|
14121
|
+
* Update or activate a WhatsApp messaging integration
|
|
14122
|
+
* 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.
|
|
14123
14123
|
* @param {String} integrationId Integration ID
|
|
14124
14124
|
* @param {Object} body WhatsAppIntegrationUpdateRequest
|
|
14125
14125
|
*/
|
|
@@ -15703,7 +15703,7 @@ class DataExtensionsApi {
|
|
|
15703
15703
|
/**
|
|
15704
15704
|
* DataExtensions service.
|
|
15705
15705
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
15706
|
-
* @version
|
|
15706
|
+
* @version 136.0.0
|
|
15707
15707
|
*/
|
|
15708
15708
|
|
|
15709
15709
|
/**
|
|
@@ -15789,7 +15789,7 @@ class ExternalContactsApi {
|
|
|
15789
15789
|
/**
|
|
15790
15790
|
* ExternalContacts service.
|
|
15791
15791
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
15792
|
-
* @version
|
|
15792
|
+
* @version 136.0.0
|
|
15793
15793
|
*/
|
|
15794
15794
|
|
|
15795
15795
|
/**
|
|
@@ -17532,7 +17532,7 @@ class FaxApi {
|
|
|
17532
17532
|
/**
|
|
17533
17533
|
* Fax service.
|
|
17534
17534
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
17535
|
-
* @version
|
|
17535
|
+
* @version 136.0.0
|
|
17536
17536
|
*/
|
|
17537
17537
|
|
|
17538
17538
|
/**
|
|
@@ -17703,7 +17703,7 @@ class FlowsApi {
|
|
|
17703
17703
|
/**
|
|
17704
17704
|
* Flows service.
|
|
17705
17705
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
17706
|
-
* @version
|
|
17706
|
+
* @version 136.0.0
|
|
17707
17707
|
*/
|
|
17708
17708
|
|
|
17709
17709
|
/**
|
|
@@ -17774,7 +17774,7 @@ class GamificationApi {
|
|
|
17774
17774
|
/**
|
|
17775
17775
|
* Gamification service.
|
|
17776
17776
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
17777
|
-
* @version
|
|
17777
|
+
* @version 136.0.0
|
|
17778
17778
|
*/
|
|
17779
17779
|
|
|
17780
17780
|
/**
|
|
@@ -18020,18 +18020,18 @@ class GamificationApi {
|
|
|
18020
18020
|
/**
|
|
18021
18021
|
* Performance profile by id
|
|
18022
18022
|
*
|
|
18023
|
-
* @param {String} performanceProfileId
|
|
18023
|
+
* @param {String} profileId performanceProfileId
|
|
18024
18024
|
*/
|
|
18025
|
-
getGamificationProfile(
|
|
18026
|
-
// verify the required parameter '
|
|
18027
|
-
if (
|
|
18028
|
-
throw 'Missing the required parameter "
|
|
18025
|
+
getGamificationProfile(profileId) {
|
|
18026
|
+
// verify the required parameter 'profileId' is set
|
|
18027
|
+
if (profileId === undefined || profileId === null) {
|
|
18028
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationProfile';
|
|
18029
18029
|
}
|
|
18030
18030
|
|
|
18031
18031
|
return this.apiClient.callApi(
|
|
18032
|
-
'/api/v2/gamification/profiles/{
|
|
18032
|
+
'/api/v2/gamification/profiles/{profileId}',
|
|
18033
18033
|
'GET',
|
|
18034
|
-
{ '
|
|
18034
|
+
{ 'profileId': profileId },
|
|
18035
18035
|
{ },
|
|
18036
18036
|
{ },
|
|
18037
18037
|
{ },
|
|
@@ -18874,18 +18874,18 @@ class GamificationApi {
|
|
|
18874
18874
|
/**
|
|
18875
18875
|
* Activate a performance profile
|
|
18876
18876
|
*
|
|
18877
|
-
* @param {String} performanceProfileId
|
|
18877
|
+
* @param {String} profileId performanceProfileId
|
|
18878
18878
|
*/
|
|
18879
|
-
postGamificationProfileActivate(
|
|
18880
|
-
// verify the required parameter '
|
|
18881
|
-
if (
|
|
18882
|
-
throw 'Missing the required parameter "
|
|
18879
|
+
postGamificationProfileActivate(profileId) {
|
|
18880
|
+
// verify the required parameter 'profileId' is set
|
|
18881
|
+
if (profileId === undefined || profileId === null) {
|
|
18882
|
+
throw 'Missing the required parameter "profileId" when calling postGamificationProfileActivate';
|
|
18883
18883
|
}
|
|
18884
18884
|
|
|
18885
18885
|
return this.apiClient.callApi(
|
|
18886
|
-
'/api/v2/gamification/profiles/{
|
|
18886
|
+
'/api/v2/gamification/profiles/{profileId}/activate',
|
|
18887
18887
|
'POST',
|
|
18888
|
-
{ '
|
|
18888
|
+
{ 'profileId': profileId },
|
|
18889
18889
|
{ },
|
|
18890
18890
|
{ },
|
|
18891
18891
|
{ },
|
|
@@ -18899,18 +18899,18 @@ class GamificationApi {
|
|
|
18899
18899
|
/**
|
|
18900
18900
|
* Deactivate a performance profile
|
|
18901
18901
|
*
|
|
18902
|
-
* @param {String} performanceProfileId
|
|
18902
|
+
* @param {String} profileId performanceProfileId
|
|
18903
18903
|
*/
|
|
18904
|
-
postGamificationProfileDeactivate(
|
|
18905
|
-
// verify the required parameter '
|
|
18906
|
-
if (
|
|
18907
|
-
throw 'Missing the required parameter "
|
|
18904
|
+
postGamificationProfileDeactivate(profileId) {
|
|
18905
|
+
// verify the required parameter 'profileId' is set
|
|
18906
|
+
if (profileId === undefined || profileId === null) {
|
|
18907
|
+
throw 'Missing the required parameter "profileId" when calling postGamificationProfileDeactivate';
|
|
18908
18908
|
}
|
|
18909
18909
|
|
|
18910
18910
|
return this.apiClient.callApi(
|
|
18911
|
-
'/api/v2/gamification/profiles/{
|
|
18911
|
+
'/api/v2/gamification/profiles/{profileId}/deactivate',
|
|
18912
18912
|
'POST',
|
|
18913
|
-
{ '
|
|
18913
|
+
{ 'profileId': profileId },
|
|
18914
18914
|
{ },
|
|
18915
18915
|
{ },
|
|
18916
18916
|
{ },
|
|
@@ -19112,22 +19112,22 @@ class GamificationApi {
|
|
|
19112
19112
|
/**
|
|
19113
19113
|
* Updates a performance profile
|
|
19114
19114
|
*
|
|
19115
|
-
* @param {String} performanceProfileId
|
|
19115
|
+
* @param {String} profileId performanceProfileId
|
|
19116
19116
|
* @param {Object} opts Optional parameters
|
|
19117
19117
|
* @param {Object} opts.body performanceProfile
|
|
19118
19118
|
*/
|
|
19119
|
-
putGamificationProfile(
|
|
19119
|
+
putGamificationProfile(profileId, opts) {
|
|
19120
19120
|
opts = opts || {};
|
|
19121
19121
|
|
|
19122
|
-
// verify the required parameter '
|
|
19123
|
-
if (
|
|
19124
|
-
throw 'Missing the required parameter "
|
|
19122
|
+
// verify the required parameter 'profileId' is set
|
|
19123
|
+
if (profileId === undefined || profileId === null) {
|
|
19124
|
+
throw 'Missing the required parameter "profileId" when calling putGamificationProfile';
|
|
19125
19125
|
}
|
|
19126
19126
|
|
|
19127
19127
|
return this.apiClient.callApi(
|
|
19128
|
-
'/api/v2/gamification/profiles/{
|
|
19128
|
+
'/api/v2/gamification/profiles/{profileId}',
|
|
19129
19129
|
'PUT',
|
|
19130
|
-
{ '
|
|
19130
|
+
{ 'profileId': profileId },
|
|
19131
19131
|
{ },
|
|
19132
19132
|
{ },
|
|
19133
19133
|
{ },
|
|
@@ -19204,7 +19204,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
19204
19204
|
/**
|
|
19205
19205
|
* GeneralDataProtectionRegulation service.
|
|
19206
19206
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
19207
|
-
* @version
|
|
19207
|
+
* @version 136.0.0
|
|
19208
19208
|
*/
|
|
19209
19209
|
|
|
19210
19210
|
/**
|
|
@@ -19334,7 +19334,7 @@ class GeolocationApi {
|
|
|
19334
19334
|
/**
|
|
19335
19335
|
* Geolocation service.
|
|
19336
19336
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
19337
|
-
* @version
|
|
19337
|
+
* @version 136.0.0
|
|
19338
19338
|
*/
|
|
19339
19339
|
|
|
19340
19340
|
/**
|
|
@@ -19465,7 +19465,7 @@ class GreetingsApi {
|
|
|
19465
19465
|
/**
|
|
19466
19466
|
* Greetings service.
|
|
19467
19467
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
19468
|
-
* @version
|
|
19468
|
+
* @version 136.0.0
|
|
19469
19469
|
*/
|
|
19470
19470
|
|
|
19471
19471
|
/**
|
|
@@ -19920,7 +19920,7 @@ class GroupsApi {
|
|
|
19920
19920
|
/**
|
|
19921
19921
|
* Groups service.
|
|
19922
19922
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
19923
|
-
* @version
|
|
19923
|
+
* @version 136.0.0
|
|
19924
19924
|
*/
|
|
19925
19925
|
|
|
19926
19926
|
/**
|
|
@@ -20325,7 +20325,7 @@ class IdentityProviderApi {
|
|
|
20325
20325
|
/**
|
|
20326
20326
|
* IdentityProvider service.
|
|
20327
20327
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
20328
|
-
* @version
|
|
20328
|
+
* @version 136.0.0
|
|
20329
20329
|
*/
|
|
20330
20330
|
|
|
20331
20331
|
/**
|
|
@@ -21081,7 +21081,7 @@ class IntegrationsApi {
|
|
|
21081
21081
|
/**
|
|
21082
21082
|
* Integrations service.
|
|
21083
21083
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
21084
|
-
* @version
|
|
21084
|
+
* @version 136.0.0
|
|
21085
21085
|
*/
|
|
21086
21086
|
|
|
21087
21087
|
/**
|
|
@@ -21499,9 +21499,10 @@ class IntegrationsApi {
|
|
|
21499
21499
|
* @param {String} opts.previousPage Previous page token
|
|
21500
21500
|
* @param {String} opts.sortBy Root level field name to sort on.
|
|
21501
21501
|
* @param {Object} opts.sortOrder Direction to sort 'sortBy' field. (default to asc)
|
|
21502
|
-
* @param {String} opts.category Filter by category name
|
|
21503
|
-
* @param {String} opts.name Filter by
|
|
21504
|
-
* @param {
|
|
21502
|
+
* @param {String} opts.category Filter by category name.
|
|
21503
|
+
* @param {String} opts.name Filter by partial or complete action name.
|
|
21504
|
+
* @param {String} opts.ids Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids.
|
|
21505
|
+
* @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.
|
|
21505
21506
|
* @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)
|
|
21506
21507
|
*/
|
|
21507
21508
|
getIntegrationsActions(opts) {
|
|
@@ -21512,7 +21513,7 @@ class IntegrationsApi {
|
|
|
21512
21513
|
'/api/v2/integrations/actions',
|
|
21513
21514
|
'GET',
|
|
21514
21515
|
{ },
|
|
21515
|
-
{ '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'] },
|
|
21516
|
+
{ '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'] },
|
|
21516
21517
|
{ },
|
|
21517
21518
|
{ },
|
|
21518
21519
|
null,
|
|
@@ -21562,9 +21563,10 @@ class IntegrationsApi {
|
|
|
21562
21563
|
* @param {String} opts.previousPage Previous page token
|
|
21563
21564
|
* @param {String} opts.sortBy Root level field name to sort on.
|
|
21564
21565
|
* @param {Object} opts.sortOrder Direction to sort 'sortBy' field. (default to asc)
|
|
21565
|
-
* @param {String} opts.category Filter by category name
|
|
21566
|
-
* @param {String} opts.name Filter by
|
|
21567
|
-
* @param {
|
|
21566
|
+
* @param {String} opts.category Filter by category name.
|
|
21567
|
+
* @param {String} opts.name Filter by partial or complete action name.
|
|
21568
|
+
* @param {String} opts.ids Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids.
|
|
21569
|
+
* @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.
|
|
21568
21570
|
* @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)
|
|
21569
21571
|
*/
|
|
21570
21572
|
getIntegrationsActionsDrafts(opts) {
|
|
@@ -21575,7 +21577,7 @@ class IntegrationsApi {
|
|
|
21575
21577
|
'/api/v2/integrations/actions/drafts',
|
|
21576
21578
|
'GET',
|
|
21577
21579
|
{ },
|
|
21578
|
-
{ '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'] },
|
|
21580
|
+
{ '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'] },
|
|
21579
21581
|
{ },
|
|
21580
21582
|
{ },
|
|
21581
21583
|
null,
|
|
@@ -22756,7 +22758,7 @@ class JourneyApi {
|
|
|
22756
22758
|
/**
|
|
22757
22759
|
* Journey service.
|
|
22758
22760
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
22759
|
-
* @version
|
|
22761
|
+
* @version 136.0.0
|
|
22760
22762
|
*/
|
|
22761
22763
|
|
|
22762
22764
|
/**
|
|
@@ -23467,7 +23469,7 @@ class KnowledgeApi {
|
|
|
23467
23469
|
/**
|
|
23468
23470
|
* Knowledge service.
|
|
23469
23471
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
23470
|
-
* @version
|
|
23472
|
+
* @version 136.0.0
|
|
23471
23473
|
*/
|
|
23472
23474
|
|
|
23473
23475
|
/**
|
|
@@ -24367,7 +24369,7 @@ class LanguageUnderstandingApi {
|
|
|
24367
24369
|
/**
|
|
24368
24370
|
* LanguageUnderstanding service.
|
|
24369
24371
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
24370
|
-
* @version
|
|
24372
|
+
* @version 136.0.0
|
|
24371
24373
|
*/
|
|
24372
24374
|
|
|
24373
24375
|
/**
|
|
@@ -25271,7 +25273,7 @@ class LanguagesApi {
|
|
|
25271
25273
|
/**
|
|
25272
25274
|
* Languages service.
|
|
25273
25275
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
25274
|
-
* @version
|
|
25276
|
+
* @version 136.0.0
|
|
25275
25277
|
*/
|
|
25276
25278
|
|
|
25277
25279
|
/**
|
|
@@ -25539,7 +25541,7 @@ class LearningApi {
|
|
|
25539
25541
|
/**
|
|
25540
25542
|
* Learning service.
|
|
25541
25543
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
25542
|
-
* @version
|
|
25544
|
+
* @version 136.0.0
|
|
25543
25545
|
*/
|
|
25544
25546
|
|
|
25545
25547
|
/**
|
|
@@ -26130,7 +26132,7 @@ class LicenseApi {
|
|
|
26130
26132
|
/**
|
|
26131
26133
|
* License service.
|
|
26132
26134
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
26133
|
-
* @version
|
|
26135
|
+
* @version 136.0.0
|
|
26134
26136
|
*/
|
|
26135
26137
|
|
|
26136
26138
|
/**
|
|
@@ -26368,7 +26370,7 @@ class LocationsApi {
|
|
|
26368
26370
|
/**
|
|
26369
26371
|
* Locations service.
|
|
26370
26372
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
26371
|
-
* @version
|
|
26373
|
+
* @version 136.0.0
|
|
26372
26374
|
*/
|
|
26373
26375
|
|
|
26374
26376
|
/**
|
|
@@ -26604,7 +26606,7 @@ class MessagingApi {
|
|
|
26604
26606
|
/**
|
|
26605
26607
|
* Messaging service.
|
|
26606
26608
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
26607
|
-
* @version
|
|
26609
|
+
* @version 136.0.0
|
|
26608
26610
|
*/
|
|
26609
26611
|
|
|
26610
26612
|
/**
|
|
@@ -26755,7 +26757,7 @@ class MobileDevicesApi {
|
|
|
26755
26757
|
/**
|
|
26756
26758
|
* MobileDevices service.
|
|
26757
26759
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
26758
|
-
* @version
|
|
26760
|
+
* @version 136.0.0
|
|
26759
26761
|
*/
|
|
26760
26762
|
|
|
26761
26763
|
/**
|
|
@@ -26906,7 +26908,7 @@ class NotificationsApi {
|
|
|
26906
26908
|
/**
|
|
26907
26909
|
* Notifications service.
|
|
26908
26910
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
26909
|
-
* @version
|
|
26911
|
+
* @version 136.0.0
|
|
26910
26912
|
*/
|
|
26911
26913
|
|
|
26912
26914
|
/**
|
|
@@ -27131,7 +27133,7 @@ class OAuthApi {
|
|
|
27131
27133
|
/**
|
|
27132
27134
|
* OAuth service.
|
|
27133
27135
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
27134
|
-
* @version
|
|
27136
|
+
* @version 136.0.0
|
|
27135
27137
|
*/
|
|
27136
27138
|
|
|
27137
27139
|
/**
|
|
@@ -27497,7 +27499,7 @@ class ObjectsApi {
|
|
|
27497
27499
|
/**
|
|
27498
27500
|
* Objects service.
|
|
27499
27501
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
27500
|
-
* @version
|
|
27502
|
+
* @version 136.0.0
|
|
27501
27503
|
*/
|
|
27502
27504
|
|
|
27503
27505
|
/**
|
|
@@ -27768,7 +27770,7 @@ class OrganizationApi {
|
|
|
27768
27770
|
/**
|
|
27769
27771
|
* Organization service.
|
|
27770
27772
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
27771
|
-
* @version
|
|
27773
|
+
* @version 136.0.0
|
|
27772
27774
|
*/
|
|
27773
27775
|
|
|
27774
27776
|
/**
|
|
@@ -28171,7 +28173,7 @@ class OrganizationAuthorizationApi {
|
|
|
28171
28173
|
/**
|
|
28172
28174
|
* OrganizationAuthorization service.
|
|
28173
28175
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
28174
|
-
* @version
|
|
28176
|
+
* @version 136.0.0
|
|
28175
28177
|
*/
|
|
28176
28178
|
|
|
28177
28179
|
/**
|
|
@@ -29096,7 +29098,7 @@ class OutboundApi {
|
|
|
29096
29098
|
/**
|
|
29097
29099
|
* Outbound service.
|
|
29098
29100
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
29099
|
-
* @version
|
|
29101
|
+
* @version 136.0.0
|
|
29100
29102
|
*/
|
|
29101
29103
|
|
|
29102
29104
|
/**
|
|
@@ -29446,6 +29448,31 @@ class OutboundApi {
|
|
|
29446
29448
|
);
|
|
29447
29449
|
}
|
|
29448
29450
|
|
|
29451
|
+
/**
|
|
29452
|
+
* Reset messaging campaign progress and recycle the messaging campaign
|
|
29453
|
+
*
|
|
29454
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
29455
|
+
*/
|
|
29456
|
+
deleteOutboundMessagingcampaignProgress(messagingCampaignId) {
|
|
29457
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
29458
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
29459
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling deleteOutboundMessagingcampaignProgress';
|
|
29460
|
+
}
|
|
29461
|
+
|
|
29462
|
+
return this.apiClient.callApi(
|
|
29463
|
+
'/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress',
|
|
29464
|
+
'DELETE',
|
|
29465
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
29466
|
+
{ },
|
|
29467
|
+
{ },
|
|
29468
|
+
{ },
|
|
29469
|
+
null,
|
|
29470
|
+
['PureCloud OAuth'],
|
|
29471
|
+
['application/json'],
|
|
29472
|
+
['application/json']
|
|
29473
|
+
);
|
|
29474
|
+
}
|
|
29475
|
+
|
|
29449
29476
|
/**
|
|
29450
29477
|
* Delete a Rule Set.
|
|
29451
29478
|
*
|
|
@@ -32126,7 +32153,7 @@ class PresenceApi {
|
|
|
32126
32153
|
/**
|
|
32127
32154
|
* Presence service.
|
|
32128
32155
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
32129
|
-
* @version
|
|
32156
|
+
* @version 136.0.0
|
|
32130
32157
|
*/
|
|
32131
32158
|
|
|
32132
32159
|
/**
|
|
@@ -32272,31 +32299,6 @@ class PresenceApi {
|
|
|
32272
32299
|
);
|
|
32273
32300
|
}
|
|
32274
32301
|
|
|
32275
|
-
/**
|
|
32276
|
-
* Get a user's Microsoft Teams presence.
|
|
32277
|
-
* 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.
|
|
32278
|
-
* @param {String} userId user Id
|
|
32279
|
-
*/
|
|
32280
|
-
getUserPresencesMicrosoftteams(userId) {
|
|
32281
|
-
// verify the required parameter 'userId' is set
|
|
32282
|
-
if (userId === undefined || userId === null) {
|
|
32283
|
-
throw 'Missing the required parameter "userId" when calling getUserPresencesMicrosoftteams';
|
|
32284
|
-
}
|
|
32285
|
-
|
|
32286
|
-
return this.apiClient.callApi(
|
|
32287
|
-
'/api/v2/users/{userId}/presences/microsoftteams',
|
|
32288
|
-
'GET',
|
|
32289
|
-
{ 'userId': userId },
|
|
32290
|
-
{ },
|
|
32291
|
-
{ },
|
|
32292
|
-
{ },
|
|
32293
|
-
null,
|
|
32294
|
-
['PureCloud OAuth'],
|
|
32295
|
-
['application/json'],
|
|
32296
|
-
['application/json']
|
|
32297
|
-
);
|
|
32298
|
-
}
|
|
32299
|
-
|
|
32300
32302
|
/**
|
|
32301
32303
|
* Get a user's Genesys Cloud presence.
|
|
32302
32304
|
* Get the default Genesys Cloud user presence source PURECLOUD
|
|
@@ -32322,31 +32324,6 @@ class PresenceApi {
|
|
|
32322
32324
|
);
|
|
32323
32325
|
}
|
|
32324
32326
|
|
|
32325
|
-
/**
|
|
32326
|
-
* Get a user's Zoom Phone presence.
|
|
32327
|
-
* 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.
|
|
32328
|
-
* @param {String} userId user Id
|
|
32329
|
-
*/
|
|
32330
|
-
getUserPresencesZoomphone(userId) {
|
|
32331
|
-
// verify the required parameter 'userId' is set
|
|
32332
|
-
if (userId === undefined || userId === null) {
|
|
32333
|
-
throw 'Missing the required parameter "userId" when calling getUserPresencesZoomphone';
|
|
32334
|
-
}
|
|
32335
|
-
|
|
32336
|
-
return this.apiClient.callApi(
|
|
32337
|
-
'/api/v2/users/{userId}/presences/zoomphone',
|
|
32338
|
-
'GET',
|
|
32339
|
-
{ 'userId': userId },
|
|
32340
|
-
{ },
|
|
32341
|
-
{ },
|
|
32342
|
-
{ },
|
|
32343
|
-
null,
|
|
32344
|
-
['PureCloud OAuth'],
|
|
32345
|
-
['application/json'],
|
|
32346
|
-
['application/json']
|
|
32347
|
-
);
|
|
32348
|
-
}
|
|
32349
|
-
|
|
32350
32327
|
/**
|
|
32351
32328
|
* Patch a user's Presence
|
|
32352
32329
|
* 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.
|
|
@@ -32498,7 +32475,7 @@ class QualityApi {
|
|
|
32498
32475
|
/**
|
|
32499
32476
|
* Quality service.
|
|
32500
32477
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
32501
|
-
* @version
|
|
32478
|
+
* @version 136.0.0
|
|
32502
32479
|
*/
|
|
32503
32480
|
|
|
32504
32481
|
/**
|
|
@@ -34076,7 +34053,7 @@ class RecordingApi {
|
|
|
34076
34053
|
/**
|
|
34077
34054
|
* Recording service.
|
|
34078
34055
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
34079
|
-
* @version
|
|
34056
|
+
* @version 136.0.0
|
|
34080
34057
|
*/
|
|
34081
34058
|
|
|
34082
34059
|
/**
|
|
@@ -34599,6 +34576,7 @@ class RecordingApi {
|
|
|
34599
34576
|
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
34600
34577
|
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
34601
34578
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
34579
|
+
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
34602
34580
|
*/
|
|
34603
34581
|
getRecordingCrossplatformMediaretentionpolicies(opts) {
|
|
34604
34582
|
opts = opts || {};
|
|
@@ -34608,7 +34586,7 @@ class RecordingApi {
|
|
|
34608
34586
|
'/api/v2/recording/crossplatform/mediaretentionpolicies',
|
|
34609
34587
|
'GET',
|
|
34610
34588
|
{ },
|
|
34611
|
-
{ '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'] },
|
|
34589
|
+
{ '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'] },
|
|
34612
34590
|
{ },
|
|
34613
34591
|
{ },
|
|
34614
34592
|
null,
|
|
@@ -34731,6 +34709,51 @@ class RecordingApi {
|
|
|
34731
34709
|
);
|
|
34732
34710
|
}
|
|
34733
34711
|
|
|
34712
|
+
/**
|
|
34713
|
+
* Get the encryption key configurations
|
|
34714
|
+
*
|
|
34715
|
+
* @param {String} keyConfigurationId Key Configurations Id
|
|
34716
|
+
*/
|
|
34717
|
+
getRecordingKeyconfiguration(keyConfigurationId) {
|
|
34718
|
+
// verify the required parameter 'keyConfigurationId' is set
|
|
34719
|
+
if (keyConfigurationId === undefined || keyConfigurationId === null) {
|
|
34720
|
+
throw 'Missing the required parameter "keyConfigurationId" when calling getRecordingKeyconfiguration';
|
|
34721
|
+
}
|
|
34722
|
+
|
|
34723
|
+
return this.apiClient.callApi(
|
|
34724
|
+
'/api/v2/recording/keyconfigurations/{keyConfigurationId}',
|
|
34725
|
+
'GET',
|
|
34726
|
+
{ 'keyConfigurationId': keyConfigurationId },
|
|
34727
|
+
{ },
|
|
34728
|
+
{ },
|
|
34729
|
+
{ },
|
|
34730
|
+
null,
|
|
34731
|
+
['PureCloud OAuth'],
|
|
34732
|
+
['application/json'],
|
|
34733
|
+
['application/json']
|
|
34734
|
+
);
|
|
34735
|
+
}
|
|
34736
|
+
|
|
34737
|
+
/**
|
|
34738
|
+
* Get a list of key configurations data
|
|
34739
|
+
*
|
|
34740
|
+
*/
|
|
34741
|
+
getRecordingKeyconfigurations() {
|
|
34742
|
+
|
|
34743
|
+
return this.apiClient.callApi(
|
|
34744
|
+
'/api/v2/recording/keyconfigurations',
|
|
34745
|
+
'GET',
|
|
34746
|
+
{ },
|
|
34747
|
+
{ },
|
|
34748
|
+
{ },
|
|
34749
|
+
{ },
|
|
34750
|
+
null,
|
|
34751
|
+
['PureCloud OAuth'],
|
|
34752
|
+
['application/json'],
|
|
34753
|
+
['application/json']
|
|
34754
|
+
);
|
|
34755
|
+
}
|
|
34756
|
+
|
|
34734
34757
|
/**
|
|
34735
34758
|
* Get the local encryption settings
|
|
34736
34759
|
*
|
|
@@ -34790,6 +34813,7 @@ class RecordingApi {
|
|
|
34790
34813
|
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
34791
34814
|
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
34792
34815
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
34816
|
+
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
34793
34817
|
*/
|
|
34794
34818
|
getRecordingMediaretentionpolicies(opts) {
|
|
34795
34819
|
opts = opts || {};
|
|
@@ -34799,7 +34823,7 @@ class RecordingApi {
|
|
|
34799
34823
|
'/api/v2/recording/mediaretentionpolicies',
|
|
34800
34824
|
'GET',
|
|
34801
34825
|
{ },
|
|
34802
|
-
{ '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'] },
|
|
34826
|
+
{ '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'] },
|
|
34803
34827
|
{ },
|
|
34804
34828
|
{ },
|
|
34805
34829
|
null,
|
|
@@ -35103,8 +35127,8 @@ class RecordingApi {
|
|
|
35103
35127
|
}
|
|
35104
35128
|
|
|
35105
35129
|
/**
|
|
35106
|
-
* Create a recording bulk job
|
|
35107
|
-
*
|
|
35130
|
+
* Create a recording bulk job.
|
|
35131
|
+
* Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state.
|
|
35108
35132
|
* @param {Object} body query
|
|
35109
35133
|
*/
|
|
35110
35134
|
postRecordingJobs(body) {
|
|
@@ -35127,6 +35151,56 @@ class RecordingApi {
|
|
|
35127
35151
|
);
|
|
35128
35152
|
}
|
|
35129
35153
|
|
|
35154
|
+
/**
|
|
35155
|
+
* Setup configurations for encryption key creation
|
|
35156
|
+
*
|
|
35157
|
+
* @param {Object} body Encryption Configuration
|
|
35158
|
+
*/
|
|
35159
|
+
postRecordingKeyconfigurations(body) {
|
|
35160
|
+
// verify the required parameter 'body' is set
|
|
35161
|
+
if (body === undefined || body === null) {
|
|
35162
|
+
throw 'Missing the required parameter "body" when calling postRecordingKeyconfigurations';
|
|
35163
|
+
}
|
|
35164
|
+
|
|
35165
|
+
return this.apiClient.callApi(
|
|
35166
|
+
'/api/v2/recording/keyconfigurations',
|
|
35167
|
+
'POST',
|
|
35168
|
+
{ },
|
|
35169
|
+
{ },
|
|
35170
|
+
{ },
|
|
35171
|
+
{ },
|
|
35172
|
+
body,
|
|
35173
|
+
['PureCloud OAuth'],
|
|
35174
|
+
['application/json'],
|
|
35175
|
+
['application/json']
|
|
35176
|
+
);
|
|
35177
|
+
}
|
|
35178
|
+
|
|
35179
|
+
/**
|
|
35180
|
+
* Validate encryption key configurations without saving it
|
|
35181
|
+
*
|
|
35182
|
+
* @param {Object} body Encryption Configuration
|
|
35183
|
+
*/
|
|
35184
|
+
postRecordingKeyconfigurationsValidate(body) {
|
|
35185
|
+
// verify the required parameter 'body' is set
|
|
35186
|
+
if (body === undefined || body === null) {
|
|
35187
|
+
throw 'Missing the required parameter "body" when calling postRecordingKeyconfigurationsValidate';
|
|
35188
|
+
}
|
|
35189
|
+
|
|
35190
|
+
return this.apiClient.callApi(
|
|
35191
|
+
'/api/v2/recording/keyconfigurations/validate',
|
|
35192
|
+
'POST',
|
|
35193
|
+
{ },
|
|
35194
|
+
{ },
|
|
35195
|
+
{ },
|
|
35196
|
+
{ },
|
|
35197
|
+
body,
|
|
35198
|
+
['PureCloud OAuth'],
|
|
35199
|
+
['application/json'],
|
|
35200
|
+
['application/json']
|
|
35201
|
+
);
|
|
35202
|
+
}
|
|
35203
|
+
|
|
35130
35204
|
/**
|
|
35131
35205
|
* create a local recording key
|
|
35132
35206
|
*
|
|
@@ -35461,6 +35535,36 @@ class RecordingApi {
|
|
|
35461
35535
|
);
|
|
35462
35536
|
}
|
|
35463
35537
|
|
|
35538
|
+
/**
|
|
35539
|
+
* Update the encryption key configurations
|
|
35540
|
+
*
|
|
35541
|
+
* @param {String} keyConfigurationId Key Configurations Id
|
|
35542
|
+
* @param {Object} body Encryption key configuration metadata
|
|
35543
|
+
*/
|
|
35544
|
+
putRecordingKeyconfiguration(keyConfigurationId, body) {
|
|
35545
|
+
// verify the required parameter 'keyConfigurationId' is set
|
|
35546
|
+
if (keyConfigurationId === undefined || keyConfigurationId === null) {
|
|
35547
|
+
throw 'Missing the required parameter "keyConfigurationId" when calling putRecordingKeyconfiguration';
|
|
35548
|
+
}
|
|
35549
|
+
// verify the required parameter 'body' is set
|
|
35550
|
+
if (body === undefined || body === null) {
|
|
35551
|
+
throw 'Missing the required parameter "body" when calling putRecordingKeyconfiguration';
|
|
35552
|
+
}
|
|
35553
|
+
|
|
35554
|
+
return this.apiClient.callApi(
|
|
35555
|
+
'/api/v2/recording/keyconfigurations/{keyConfigurationId}',
|
|
35556
|
+
'PUT',
|
|
35557
|
+
{ 'keyConfigurationId': keyConfigurationId },
|
|
35558
|
+
{ },
|
|
35559
|
+
{ },
|
|
35560
|
+
{ },
|
|
35561
|
+
body,
|
|
35562
|
+
['PureCloud OAuth'],
|
|
35563
|
+
['application/json'],
|
|
35564
|
+
['application/json']
|
|
35565
|
+
);
|
|
35566
|
+
}
|
|
35567
|
+
|
|
35464
35568
|
/**
|
|
35465
35569
|
* Update the local encryption settings
|
|
35466
35570
|
*
|
|
@@ -35602,7 +35706,7 @@ class ResponseManagementApi {
|
|
|
35602
35706
|
/**
|
|
35603
35707
|
* ResponseManagement service.
|
|
35604
35708
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
35605
|
-
* @version
|
|
35709
|
+
* @version 136.0.0
|
|
35606
35710
|
*/
|
|
35607
35711
|
|
|
35608
35712
|
/**
|
|
@@ -36086,7 +36190,7 @@ class RoutingApi {
|
|
|
36086
36190
|
/**
|
|
36087
36191
|
* Routing service.
|
|
36088
36192
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
36089
|
-
* @version
|
|
36193
|
+
* @version 136.0.0
|
|
36090
36194
|
*/
|
|
36091
36195
|
|
|
36092
36196
|
/**
|
|
@@ -36745,14 +36849,18 @@ class RoutingApi {
|
|
|
36745
36849
|
/**
|
|
36746
36850
|
* Get domains
|
|
36747
36851
|
*
|
|
36852
|
+
* @param {Object} opts Optional parameters
|
|
36853
|
+
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
36748
36854
|
*/
|
|
36749
|
-
getRoutingEmailDomains() {
|
|
36855
|
+
getRoutingEmailDomains(opts) {
|
|
36856
|
+
opts = opts || {};
|
|
36857
|
+
|
|
36750
36858
|
|
|
36751
36859
|
return this.apiClient.callApi(
|
|
36752
36860
|
'/api/v2/routing/email/domains',
|
|
36753
36861
|
'GET',
|
|
36754
36862
|
{ },
|
|
36755
|
-
{
|
|
36863
|
+
{ 'excludeStatus': opts['excludeStatus'] },
|
|
36756
36864
|
{ },
|
|
36757
36865
|
{ },
|
|
36758
36866
|
null,
|
|
@@ -39009,7 +39117,7 @@ class SCIMApi {
|
|
|
39009
39117
|
/**
|
|
39010
39118
|
* SCIM service.
|
|
39011
39119
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
39012
|
-
* @version
|
|
39120
|
+
* @version 136.0.0
|
|
39013
39121
|
*/
|
|
39014
39122
|
|
|
39015
39123
|
/**
|
|
@@ -39886,7 +39994,7 @@ class ScriptsApi {
|
|
|
39886
39994
|
/**
|
|
39887
39995
|
* Scripts service.
|
|
39888
39996
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
39889
|
-
* @version
|
|
39997
|
+
* @version 136.0.0
|
|
39890
39998
|
*/
|
|
39891
39999
|
|
|
39892
40000
|
/**
|
|
@@ -40002,6 +40110,7 @@ class ScriptsApi {
|
|
|
40002
40110
|
* @param {Object} opts.sortBy SortBy
|
|
40003
40111
|
* @param {Object} opts.sortOrder SortOrder
|
|
40004
40112
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
40113
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
40005
40114
|
*/
|
|
40006
40115
|
getScripts(opts) {
|
|
40007
40116
|
opts = opts || {};
|
|
@@ -40011,7 +40120,40 @@ class ScriptsApi {
|
|
|
40011
40120
|
'/api/v2/scripts',
|
|
40012
40121
|
'GET',
|
|
40013
40122
|
{ },
|
|
40014
|
-
{ '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'] },
|
|
40123
|
+
{ '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'] },
|
|
40124
|
+
{ },
|
|
40125
|
+
{ },
|
|
40126
|
+
null,
|
|
40127
|
+
['PureCloud OAuth'],
|
|
40128
|
+
['application/json'],
|
|
40129
|
+
['application/json']
|
|
40130
|
+
);
|
|
40131
|
+
}
|
|
40132
|
+
|
|
40133
|
+
/**
|
|
40134
|
+
* Get the metadata for a list of scripts
|
|
40135
|
+
*
|
|
40136
|
+
* @param {Object} opts Optional parameters
|
|
40137
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
40138
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
40139
|
+
* @param {String} opts.expand Expand
|
|
40140
|
+
* @param {String} opts.name Name filter
|
|
40141
|
+
* @param {String} opts.feature Feature filter
|
|
40142
|
+
* @param {String} opts.flowId Secure flow id filter
|
|
40143
|
+
* @param {Object} opts.sortBy SortBy
|
|
40144
|
+
* @param {Object} opts.sortOrder SortOrder
|
|
40145
|
+
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
40146
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
40147
|
+
*/
|
|
40148
|
+
getScriptsDivisionviews(opts) {
|
|
40149
|
+
opts = opts || {};
|
|
40150
|
+
|
|
40151
|
+
|
|
40152
|
+
return this.apiClient.callApi(
|
|
40153
|
+
'/api/v2/scripts/divisionviews',
|
|
40154
|
+
'GET',
|
|
40155
|
+
{ },
|
|
40156
|
+
{ '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'] },
|
|
40015
40157
|
{ },
|
|
40016
40158
|
{ },
|
|
40017
40159
|
null,
|
|
@@ -40032,6 +40174,7 @@ class ScriptsApi {
|
|
|
40032
40174
|
* @param {String} opts.feature Feature filter
|
|
40033
40175
|
* @param {String} opts.flowId Secure flow id filter
|
|
40034
40176
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
40177
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
40035
40178
|
*/
|
|
40036
40179
|
getScriptsPublished(opts) {
|
|
40037
40180
|
opts = opts || {};
|
|
@@ -40041,7 +40184,38 @@ class ScriptsApi {
|
|
|
40041
40184
|
'/api/v2/scripts/published',
|
|
40042
40185
|
'GET',
|
|
40043
40186
|
{ },
|
|
40044
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'] },
|
|
40187
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
40188
|
+
{ },
|
|
40189
|
+
{ },
|
|
40190
|
+
null,
|
|
40191
|
+
['PureCloud OAuth'],
|
|
40192
|
+
['application/json'],
|
|
40193
|
+
['application/json']
|
|
40194
|
+
);
|
|
40195
|
+
}
|
|
40196
|
+
|
|
40197
|
+
/**
|
|
40198
|
+
* Get the published scripts metadata.
|
|
40199
|
+
*
|
|
40200
|
+
* @param {Object} opts Optional parameters
|
|
40201
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
40202
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
40203
|
+
* @param {String} opts.expand Expand
|
|
40204
|
+
* @param {String} opts.name Name filter
|
|
40205
|
+
* @param {String} opts.feature Feature filter
|
|
40206
|
+
* @param {String} opts.flowId Secure flow id filter
|
|
40207
|
+
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
40208
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
40209
|
+
*/
|
|
40210
|
+
getScriptsPublishedDivisionviews(opts) {
|
|
40211
|
+
opts = opts || {};
|
|
40212
|
+
|
|
40213
|
+
|
|
40214
|
+
return this.apiClient.callApi(
|
|
40215
|
+
'/api/v2/scripts/published/divisionviews',
|
|
40216
|
+
'GET',
|
|
40217
|
+
{ },
|
|
40218
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
40045
40219
|
{ },
|
|
40046
40220
|
{ },
|
|
40047
40221
|
null,
|
|
@@ -40239,7 +40413,7 @@ class SearchApi {
|
|
|
40239
40413
|
/**
|
|
40240
40414
|
* Search service.
|
|
40241
40415
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
40242
|
-
* @version
|
|
40416
|
+
* @version 136.0.0
|
|
40243
40417
|
*/
|
|
40244
40418
|
|
|
40245
40419
|
/**
|
|
@@ -40774,7 +40948,7 @@ class SpeechTextAnalyticsApi {
|
|
|
40774
40948
|
/**
|
|
40775
40949
|
* SpeechTextAnalytics service.
|
|
40776
40950
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
40777
|
-
* @version
|
|
40951
|
+
* @version 136.0.0
|
|
40778
40952
|
*/
|
|
40779
40953
|
|
|
40780
40954
|
/**
|
|
@@ -41627,7 +41801,7 @@ class StationsApi {
|
|
|
41627
41801
|
/**
|
|
41628
41802
|
* Stations service.
|
|
41629
41803
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
41630
|
-
* @version
|
|
41804
|
+
* @version 136.0.0
|
|
41631
41805
|
*/
|
|
41632
41806
|
|
|
41633
41807
|
/**
|
|
@@ -41774,7 +41948,7 @@ class SuggestApi {
|
|
|
41774
41948
|
/**
|
|
41775
41949
|
* Suggest service.
|
|
41776
41950
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
41777
|
-
* @version
|
|
41951
|
+
* @version 136.0.0
|
|
41778
41952
|
*/
|
|
41779
41953
|
|
|
41780
41954
|
/**
|
|
@@ -41913,7 +42087,7 @@ class TelephonyApi {
|
|
|
41913
42087
|
/**
|
|
41914
42088
|
* Telephony service.
|
|
41915
42089
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
41916
|
-
* @version
|
|
42090
|
+
* @version 136.0.0
|
|
41917
42091
|
*/
|
|
41918
42092
|
|
|
41919
42093
|
/**
|
|
@@ -42021,7 +42195,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
42021
42195
|
/**
|
|
42022
42196
|
* TelephonyProvidersEdge service.
|
|
42023
42197
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
42024
|
-
* @version
|
|
42198
|
+
* @version 136.0.0
|
|
42025
42199
|
*/
|
|
42026
42200
|
|
|
42027
42201
|
/**
|
|
@@ -43436,7 +43610,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
43436
43610
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
43437
43611
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
43438
43612
|
* @param {String} opts.sortBy Sort by
|
|
43439
|
-
* @param {String} opts._number
|
|
43613
|
+
* @param {String} opts._number Deprecated, filtering by number not supported
|
|
43440
43614
|
*/
|
|
43441
43615
|
getTelephonyProvidersEdgesExtensionpools(opts) {
|
|
43442
43616
|
opts = opts || {};
|
|
@@ -45654,7 +45828,7 @@ class TextbotsApi {
|
|
|
45654
45828
|
/**
|
|
45655
45829
|
* Textbots service.
|
|
45656
45830
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
45657
|
-
* @version
|
|
45831
|
+
* @version 136.0.0
|
|
45658
45832
|
*/
|
|
45659
45833
|
|
|
45660
45834
|
/**
|
|
@@ -45782,7 +45956,7 @@ class TokensApi {
|
|
|
45782
45956
|
/**
|
|
45783
45957
|
* Tokens service.
|
|
45784
45958
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
45785
|
-
* @version
|
|
45959
|
+
* @version 136.0.0
|
|
45786
45960
|
*/
|
|
45787
45961
|
|
|
45788
45962
|
/**
|
|
@@ -45888,7 +46062,7 @@ class UploadsApi {
|
|
|
45888
46062
|
/**
|
|
45889
46063
|
* Uploads service.
|
|
45890
46064
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
45891
|
-
* @version
|
|
46065
|
+
* @version 136.0.0
|
|
45892
46066
|
*/
|
|
45893
46067
|
|
|
45894
46068
|
/**
|
|
@@ -46039,7 +46213,7 @@ class UsageApi {
|
|
|
46039
46213
|
/**
|
|
46040
46214
|
* Usage service.
|
|
46041
46215
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
46042
|
-
* @version
|
|
46216
|
+
* @version 136.0.0
|
|
46043
46217
|
*/
|
|
46044
46218
|
|
|
46045
46219
|
/**
|
|
@@ -46110,7 +46284,7 @@ class UserRecordingsApi {
|
|
|
46110
46284
|
/**
|
|
46111
46285
|
* UserRecordings service.
|
|
46112
46286
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
46113
|
-
* @version
|
|
46287
|
+
* @version 136.0.0
|
|
46114
46288
|
*/
|
|
46115
46289
|
|
|
46116
46290
|
/**
|
|
@@ -46294,7 +46468,7 @@ class UsersApi {
|
|
|
46294
46468
|
/**
|
|
46295
46469
|
* Users service.
|
|
46296
46470
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
46297
|
-
* @version
|
|
46471
|
+
* @version 136.0.0
|
|
46298
46472
|
*/
|
|
46299
46473
|
|
|
46300
46474
|
/**
|
|
@@ -48596,7 +48770,7 @@ class UtilitiesApi {
|
|
|
48596
48770
|
/**
|
|
48597
48771
|
* Utilities service.
|
|
48598
48772
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
48599
|
-
* @version
|
|
48773
|
+
* @version 136.0.0
|
|
48600
48774
|
*/
|
|
48601
48775
|
|
|
48602
48776
|
/**
|
|
@@ -48707,7 +48881,7 @@ class VoicemailApi {
|
|
|
48707
48881
|
/**
|
|
48708
48882
|
* Voicemail service.
|
|
48709
48883
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
48710
|
-
* @version
|
|
48884
|
+
* @version 136.0.0
|
|
48711
48885
|
*/
|
|
48712
48886
|
|
|
48713
48887
|
/**
|
|
@@ -49374,7 +49548,7 @@ class WebChatApi {
|
|
|
49374
49548
|
/**
|
|
49375
49549
|
* WebChat service.
|
|
49376
49550
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
49377
|
-
* @version
|
|
49551
|
+
* @version 136.0.0
|
|
49378
49552
|
*/
|
|
49379
49553
|
|
|
49380
49554
|
/**
|
|
@@ -49918,7 +50092,7 @@ class WebDeploymentsApi {
|
|
|
49918
50092
|
/**
|
|
49919
50093
|
* WebDeployments service.
|
|
49920
50094
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
49921
|
-
* @version
|
|
50095
|
+
* @version 136.0.0
|
|
49922
50096
|
*/
|
|
49923
50097
|
|
|
49924
50098
|
/**
|
|
@@ -50273,7 +50447,7 @@ class WebMessagingApi {
|
|
|
50273
50447
|
/**
|
|
50274
50448
|
* WebMessaging service.
|
|
50275
50449
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
50276
|
-
* @version
|
|
50450
|
+
* @version 136.0.0
|
|
50277
50451
|
*/
|
|
50278
50452
|
|
|
50279
50453
|
/**
|
|
@@ -50319,7 +50493,7 @@ class WidgetsApi {
|
|
|
50319
50493
|
/**
|
|
50320
50494
|
* Widgets service.
|
|
50321
50495
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
50322
|
-
* @version
|
|
50496
|
+
* @version 136.0.0
|
|
50323
50497
|
*/
|
|
50324
50498
|
|
|
50325
50499
|
/**
|
|
@@ -50465,7 +50639,7 @@ class WorkforceManagementApi {
|
|
|
50465
50639
|
/**
|
|
50466
50640
|
* WorkforceManagement service.
|
|
50467
50641
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
50468
|
-
* @version
|
|
50642
|
+
* @version 136.0.0
|
|
50469
50643
|
*/
|
|
50470
50644
|
|
|
50471
50645
|
/**
|
|
@@ -50663,7 +50837,7 @@ class WorkforceManagementApi {
|
|
|
50663
50837
|
/**
|
|
50664
50838
|
* Delete a short term forecast
|
|
50665
50839
|
* Must not be tied to any schedules
|
|
50666
|
-
* @param {String} businessUnitId The
|
|
50840
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
50667
50841
|
* @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
|
|
50668
50842
|
* @param {String} forecastId The ID of the forecast
|
|
50669
50843
|
*/
|
|
@@ -50743,7 +50917,7 @@ class WorkforceManagementApi {
|
|
|
50743
50917
|
/**
|
|
50744
50918
|
* Deletes a time off limit object
|
|
50745
50919
|
*
|
|
50746
|
-
* @param {String} managementUnitId The
|
|
50920
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
50747
50921
|
* @param {String} timeOffLimitId The ID of the time off limit object to delete
|
|
50748
50922
|
*/
|
|
50749
50923
|
deleteWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
@@ -50773,7 +50947,7 @@ class WorkforceManagementApi {
|
|
|
50773
50947
|
/**
|
|
50774
50948
|
* Deletes a time off plan
|
|
50775
50949
|
*
|
|
50776
|
-
* @param {String} managementUnitId The management unit
|
|
50950
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
50777
50951
|
* @param {String} timeOffPlanId The ID of the time off plan to delete
|
|
50778
50952
|
*/
|
|
50779
50953
|
deleteWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
@@ -51042,7 +51216,7 @@ class WorkforceManagementApi {
|
|
|
51042
51216
|
/**
|
|
51043
51217
|
* Get intraday planning groups for the given date
|
|
51044
51218
|
*
|
|
51045
|
-
* @param {String} businessUnitId The
|
|
51219
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
51046
51220
|
* @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
|
|
51047
51221
|
*/
|
|
51048
51222
|
getWorkforcemanagementBusinessunitIntradayPlanninggroups(businessUnitId, _date) {
|
|
@@ -51495,7 +51669,7 @@ class WorkforceManagementApi {
|
|
|
51495
51669
|
/**
|
|
51496
51670
|
* Get a short term forecast
|
|
51497
51671
|
*
|
|
51498
|
-
* @param {String} businessUnitId The
|
|
51672
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51499
51673
|
* @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
|
|
51500
51674
|
* @param {String} forecastId The ID of the forecast
|
|
51501
51675
|
* @param {Object} opts Optional parameters
|
|
@@ -51534,7 +51708,7 @@ class WorkforceManagementApi {
|
|
|
51534
51708
|
/**
|
|
51535
51709
|
* Get the result of a short term forecast calculation
|
|
51536
51710
|
* Includes modifications unless you pass the doNotApplyModifications query parameter
|
|
51537
|
-
* @param {String} businessUnitId The
|
|
51711
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51538
51712
|
* @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
|
|
51539
51713
|
* @param {String} forecastId The ID of the forecast
|
|
51540
51714
|
* @param {Object} opts Optional parameters
|
|
@@ -51574,7 +51748,7 @@ class WorkforceManagementApi {
|
|
|
51574
51748
|
/**
|
|
51575
51749
|
* Gets the forecast generation results
|
|
51576
51750
|
*
|
|
51577
|
-
* @param {String} businessUnitId The
|
|
51751
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51578
51752
|
* @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
|
|
51579
51753
|
* @param {String} forecastId The ID of the forecast
|
|
51580
51754
|
*/
|
|
@@ -51609,7 +51783,7 @@ class WorkforceManagementApi {
|
|
|
51609
51783
|
/**
|
|
51610
51784
|
* Get the result of a long term forecast calculation
|
|
51611
51785
|
* Includes modifications unless you pass the doNotApplyModifications query parameter
|
|
51612
|
-
* @param {String} businessUnitId The
|
|
51786
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51613
51787
|
* @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
|
|
51614
51788
|
* @param {String} forecastId The ID of the forecast
|
|
51615
51789
|
* @param {Object} opts Optional parameters
|
|
@@ -51648,7 +51822,7 @@ class WorkforceManagementApi {
|
|
|
51648
51822
|
/**
|
|
51649
51823
|
* Gets the forecast planning group snapshot
|
|
51650
51824
|
*
|
|
51651
|
-
* @param {String} businessUnitId The
|
|
51825
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51652
51826
|
* @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
|
|
51653
51827
|
* @param {String} forecastId The ID of the forecast
|
|
51654
51828
|
*/
|
|
@@ -51683,7 +51857,7 @@ class WorkforceManagementApi {
|
|
|
51683
51857
|
/**
|
|
51684
51858
|
* Get short term forecasts
|
|
51685
51859
|
* 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
|
|
51686
|
-
* @param {String} businessUnitId The
|
|
51860
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51687
51861
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format or 'recent' (without quotes) to fetch recent forecasts
|
|
51688
51862
|
*/
|
|
51689
51863
|
getWorkforcemanagementBusinessunitWeekShorttermforecasts(businessUnitId, weekDateId) {
|
|
@@ -51901,7 +52075,7 @@ class WorkforceManagementApi {
|
|
|
51901
52075
|
/**
|
|
51902
52076
|
* Get a list of user schedule adherence records for the requested management unit
|
|
51903
52077
|
*
|
|
51904
|
-
* @param {String} managementUnitId The
|
|
52078
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
51905
52079
|
* @param {Object} opts Optional parameters
|
|
51906
52080
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
51907
52081
|
*/
|
|
@@ -51930,7 +52104,7 @@ class WorkforceManagementApi {
|
|
|
51930
52104
|
/**
|
|
51931
52105
|
* Get data for agent in the management unit
|
|
51932
52106
|
*
|
|
51933
|
-
* @param {String} managementUnitId The
|
|
52107
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
51934
52108
|
* @param {String} agentId The agent id
|
|
51935
52109
|
* @param {Object} opts Optional parameters
|
|
51936
52110
|
* @param {Boolean} opts.excludeCapabilities Excludes all capabilities of the agent such as queues, languages, and skills
|
|
@@ -51964,7 +52138,7 @@ class WorkforceManagementApi {
|
|
|
51964
52138
|
/**
|
|
51965
52139
|
* Gets all the shift trades for a given agent
|
|
51966
52140
|
*
|
|
51967
|
-
* @param {String} managementUnitId The
|
|
52141
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
51968
52142
|
* @param {String} agentId The agent id
|
|
51969
52143
|
*/
|
|
51970
52144
|
getWorkforcemanagementManagementunitAgentShifttrades(managementUnitId, agentId) {
|
|
@@ -51994,7 +52168,7 @@ class WorkforceManagementApi {
|
|
|
51994
52168
|
/**
|
|
51995
52169
|
* Gets a summary of all shift trades in the matched state
|
|
51996
52170
|
*
|
|
51997
|
-
* @param {String} managementUnitId The
|
|
52171
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
51998
52172
|
*/
|
|
51999
52173
|
getWorkforcemanagementManagementunitShifttradesMatched(managementUnitId) {
|
|
52000
52174
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -52019,7 +52193,7 @@ class WorkforceManagementApi {
|
|
|
52019
52193
|
/**
|
|
52020
52194
|
* Gets list of users available for whom you can send direct shift trade requests
|
|
52021
52195
|
*
|
|
52022
|
-
* @param {String} managementUnitId The
|
|
52196
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52023
52197
|
*/
|
|
52024
52198
|
getWorkforcemanagementManagementunitShifttradesUsers(managementUnitId) {
|
|
52025
52199
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -52044,7 +52218,7 @@ class WorkforceManagementApi {
|
|
|
52044
52218
|
/**
|
|
52045
52219
|
* Gets a time off limit object
|
|
52046
52220
|
* Returns properties of time off limit object, but not daily values.
|
|
52047
|
-
* @param {String} managementUnitId The
|
|
52221
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52048
52222
|
* @param {String} timeOffLimitId The ID of the time off limit to fetch
|
|
52049
52223
|
*/
|
|
52050
52224
|
getWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
@@ -52074,7 +52248,7 @@ class WorkforceManagementApi {
|
|
|
52074
52248
|
/**
|
|
52075
52249
|
* Gets a list of time off limit objects under management unit.
|
|
52076
52250
|
* Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.
|
|
52077
|
-
* @param {String} managementUnitId The
|
|
52251
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52078
52252
|
*/
|
|
52079
52253
|
getWorkforcemanagementManagementunitTimeofflimits(managementUnitId) {
|
|
52080
52254
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -52099,7 +52273,7 @@ class WorkforceManagementApi {
|
|
|
52099
52273
|
/**
|
|
52100
52274
|
* Gets a time off plan
|
|
52101
52275
|
*
|
|
52102
|
-
* @param {String} managementUnitId The management unit
|
|
52276
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
52103
52277
|
* @param {String} timeOffPlanId The ID of the time off plan to fetch
|
|
52104
52278
|
*/
|
|
52105
52279
|
getWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
@@ -52129,7 +52303,7 @@ class WorkforceManagementApi {
|
|
|
52129
52303
|
/**
|
|
52130
52304
|
* Gets a list of time off plans
|
|
52131
52305
|
*
|
|
52132
|
-
* @param {String} managementUnitId The management unit
|
|
52306
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
52133
52307
|
*/
|
|
52134
52308
|
getWorkforcemanagementManagementunitTimeoffplans(managementUnitId) {
|
|
52135
52309
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -52154,7 +52328,7 @@ class WorkforceManagementApi {
|
|
|
52154
52328
|
/**
|
|
52155
52329
|
* Get a time off request
|
|
52156
52330
|
*
|
|
52157
|
-
* @param {String} managementUnitId The
|
|
52331
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52158
52332
|
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
52159
52333
|
* @param {String} timeOffRequestId Time Off Request Id
|
|
52160
52334
|
*/
|
|
@@ -52189,7 +52363,7 @@ class WorkforceManagementApi {
|
|
|
52189
52363
|
/**
|
|
52190
52364
|
* Retrieves time off limit, allocated and waitlisted values according to specific time off request
|
|
52191
52365
|
*
|
|
52192
|
-
* @param {String} managementUnitId The
|
|
52366
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52193
52367
|
* @param {String} userId The userId to whom the time off request applies.
|
|
52194
52368
|
* @param {String} timeOffRequestId The ID of the time off request, which dates and activityCodeId determine limit values to retrieve
|
|
52195
52369
|
*/
|
|
@@ -52224,7 +52398,7 @@ class WorkforceManagementApi {
|
|
|
52224
52398
|
/**
|
|
52225
52399
|
* Get a list of time off requests for a given user
|
|
52226
52400
|
*
|
|
52227
|
-
* @param {String} managementUnitId The
|
|
52401
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52228
52402
|
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
52229
52403
|
* @param {Object} opts Optional parameters
|
|
52230
52404
|
* @param {Boolean} opts.recentlyReviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
|
|
@@ -52258,7 +52432,7 @@ class WorkforceManagementApi {
|
|
|
52258
52432
|
/**
|
|
52259
52433
|
* Get users in the management unit
|
|
52260
52434
|
*
|
|
52261
|
-
* @param {String} managementUnitId The
|
|
52435
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52262
52436
|
*/
|
|
52263
52437
|
getWorkforcemanagementManagementunitUsers(managementUnitId) {
|
|
52264
52438
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -52359,7 +52533,7 @@ class WorkforceManagementApi {
|
|
|
52359
52533
|
/**
|
|
52360
52534
|
* Gets all the shift trades for a given week
|
|
52361
52535
|
*
|
|
52362
|
-
* @param {String} managementUnitId The
|
|
52536
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52363
52537
|
* @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
|
|
52364
52538
|
* @param {Object} opts Optional parameters
|
|
52365
52539
|
* @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
|
|
@@ -52632,7 +52806,7 @@ class WorkforceManagementApi {
|
|
|
52632
52806
|
/**
|
|
52633
52807
|
* Get a time off request for the current user
|
|
52634
52808
|
*
|
|
52635
|
-
* @param {String} timeOffRequestId
|
|
52809
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
52636
52810
|
*/
|
|
52637
52811
|
getWorkforcemanagementTimeoffrequest(timeOffRequestId) {
|
|
52638
52812
|
// verify the required parameter 'timeOffRequestId' is set
|
|
@@ -52657,7 +52831,7 @@ class WorkforceManagementApi {
|
|
|
52657
52831
|
/**
|
|
52658
52832
|
* Get the daily waitlist positions of a time off request for the current user
|
|
52659
52833
|
*
|
|
52660
|
-
* @param {String} timeOffRequestId
|
|
52834
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
52661
52835
|
*/
|
|
52662
52836
|
getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId) {
|
|
52663
52837
|
// verify the required parameter 'timeOffRequestId' is set
|
|
@@ -52900,7 +53074,7 @@ class WorkforceManagementApi {
|
|
|
52900
53074
|
/**
|
|
52901
53075
|
* Updates a time off limit object.
|
|
52902
53076
|
* Updates time off limit object properties, but not daily values.
|
|
52903
|
-
* @param {String} managementUnitId The
|
|
53077
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52904
53078
|
* @param {String} timeOffLimitId The id of time off limit object to update
|
|
52905
53079
|
* @param {Object} opts Optional parameters
|
|
52906
53080
|
* @param {Object} opts.body body
|
|
@@ -52934,7 +53108,7 @@ class WorkforceManagementApi {
|
|
|
52934
53108
|
/**
|
|
52935
53109
|
* Updates a time off plan
|
|
52936
53110
|
*
|
|
52937
|
-
* @param {String} managementUnitId The management unit
|
|
53111
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
52938
53112
|
* @param {String} timeOffPlanId The ID of the time off plan to update
|
|
52939
53113
|
* @param {Object} opts Optional parameters
|
|
52940
53114
|
* @param {Object} opts.body body
|
|
@@ -52968,7 +53142,7 @@ class WorkforceManagementApi {
|
|
|
52968
53142
|
/**
|
|
52969
53143
|
* Update a time off request
|
|
52970
53144
|
*
|
|
52971
|
-
* @param {String} managementUnitId The
|
|
53145
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52972
53146
|
* @param {String} userId The id of the user the requested time off request belongs to
|
|
52973
53147
|
* @param {String} timeOffRequestId The id of the time off request to update
|
|
52974
53148
|
* @param {Object} opts Optional parameters
|
|
@@ -53007,7 +53181,7 @@ class WorkforceManagementApi {
|
|
|
53007
53181
|
/**
|
|
53008
53182
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
53009
53183
|
*
|
|
53010
|
-
* @param {String} managementUnitId The
|
|
53184
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
53011
53185
|
* @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
|
|
53012
53186
|
* @param {Object} body body
|
|
53013
53187
|
* @param {String} tradeId The ID of the shift trade to update
|
|
@@ -53116,7 +53290,7 @@ class WorkforceManagementApi {
|
|
|
53116
53290
|
/**
|
|
53117
53291
|
* Update a time off request for the current user
|
|
53118
53292
|
*
|
|
53119
|
-
* @param {String} timeOffRequestId
|
|
53293
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
53120
53294
|
* @param {Object} opts Optional parameters
|
|
53121
53295
|
* @param {Object} opts.body body
|
|
53122
53296
|
*/
|
|
@@ -53253,7 +53427,7 @@ class WorkforceManagementApi {
|
|
|
53253
53427
|
/**
|
|
53254
53428
|
* Get intraday data for the given date for the requested planningGroupIds
|
|
53255
53429
|
*
|
|
53256
|
-
* @param {String} businessUnitId The
|
|
53430
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
53257
53431
|
* @param {Object} opts Optional parameters
|
|
53258
53432
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
53259
53433
|
* @param {Object} opts.body body
|
|
@@ -53686,7 +53860,7 @@ class WorkforceManagementApi {
|
|
|
53686
53860
|
/**
|
|
53687
53861
|
* Copy a short term forecast
|
|
53688
53862
|
*
|
|
53689
|
-
* @param {String} businessUnitId The
|
|
53863
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
53690
53864
|
* @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
|
|
53691
53865
|
* @param {String} forecastId The ID of the forecast to copy
|
|
53692
53866
|
* @param {Object} body body
|
|
@@ -53730,7 +53904,7 @@ class WorkforceManagementApi {
|
|
|
53730
53904
|
/**
|
|
53731
53905
|
* Generate a short term forecast
|
|
53732
53906
|
*
|
|
53733
|
-
* @param {String} businessUnitId The
|
|
53907
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
53734
53908
|
* @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
|
|
53735
53909
|
* @param {Object} body
|
|
53736
53910
|
* @param {Object} opts Optional parameters
|
|
@@ -53769,7 +53943,7 @@ class WorkforceManagementApi {
|
|
|
53769
53943
|
/**
|
|
53770
53944
|
* Starts importing the uploaded short term forecast
|
|
53771
53945
|
* Call after uploading the forecast data to the url supplied by the /import/uploadurl route
|
|
53772
|
-
* @param {String} businessUnitId The
|
|
53946
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
53773
53947
|
* @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
|
|
53774
53948
|
* @param {Object} body
|
|
53775
53949
|
*/
|
|
@@ -53804,7 +53978,7 @@ class WorkforceManagementApi {
|
|
|
53804
53978
|
/**
|
|
53805
53979
|
* Creates a signed upload URL for importing a short term forecast
|
|
53806
53980
|
* Once the upload is complete, call the /import route to start the short term forecast import process
|
|
53807
|
-
* @param {String} businessUnitId The
|
|
53981
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
53808
53982
|
* @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
|
|
53809
53983
|
* @param {Object} body body
|
|
53810
53984
|
*/
|
|
@@ -53931,7 +54105,7 @@ class WorkforceManagementApi {
|
|
|
53931
54105
|
/**
|
|
53932
54106
|
* Query published schedules for given given time range for set of users
|
|
53933
54107
|
*
|
|
53934
|
-
* @param {String} managementUnitId The
|
|
54108
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
53935
54109
|
* @param {Object} opts Optional parameters
|
|
53936
54110
|
* @param {Object} opts.body body
|
|
53937
54111
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
@@ -53962,7 +54136,7 @@ class WorkforceManagementApi {
|
|
|
53962
54136
|
/**
|
|
53963
54137
|
* Request a historical adherence report
|
|
53964
54138
|
* The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
|
|
53965
|
-
* @param {String} managementUnitId The
|
|
54139
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
53966
54140
|
* @param {Object} opts Optional parameters
|
|
53967
54141
|
* @param {Object} opts.body body
|
|
53968
54142
|
*/
|
|
@@ -54020,7 +54194,7 @@ class WorkforceManagementApi {
|
|
|
54020
54194
|
/**
|
|
54021
54195
|
* Query published schedules for given given time range for set of users
|
|
54022
54196
|
*
|
|
54023
|
-
* @param {String} managementUnitId The
|
|
54197
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
54024
54198
|
* @param {Object} opts Optional parameters
|
|
54025
54199
|
* @param {Object} opts.body body
|
|
54026
54200
|
*/
|
|
@@ -54049,7 +54223,7 @@ class WorkforceManagementApi {
|
|
|
54049
54223
|
/**
|
|
54050
54224
|
* Creates a new time off limit object under management unit.
|
|
54051
54225
|
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
54052
|
-
* @param {String} managementUnitId The
|
|
54226
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
54053
54227
|
* @param {Object} opts Optional parameters
|
|
54054
54228
|
* @param {Object} opts.body body
|
|
54055
54229
|
*/
|
|
@@ -54078,7 +54252,7 @@ class WorkforceManagementApi {
|
|
|
54078
54252
|
/**
|
|
54079
54253
|
* Retrieves time off limit related values based on a given set of filters.
|
|
54080
54254
|
*
|
|
54081
|
-
* @param {String} managementUnitId The
|
|
54255
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
54082
54256
|
* @param {Object} opts Optional parameters
|
|
54083
54257
|
* @param {Object} opts.body body
|
|
54084
54258
|
*/
|
|
@@ -54107,7 +54281,7 @@ class WorkforceManagementApi {
|
|
|
54107
54281
|
/**
|
|
54108
54282
|
* Creates a new time off plan
|
|
54109
54283
|
*
|
|
54110
|
-
* @param {String} managementUnitId The management unit
|
|
54284
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
54111
54285
|
* @param {Object} opts Optional parameters
|
|
54112
54286
|
* @param {Object} opts.body body
|
|
54113
54287
|
*/
|
|
@@ -54136,7 +54310,7 @@ class WorkforceManagementApi {
|
|
|
54136
54310
|
/**
|
|
54137
54311
|
* Create a new time off request
|
|
54138
54312
|
*
|
|
54139
|
-
* @param {String} managementUnitId The
|
|
54313
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
54140
54314
|
* @param {Object} opts Optional parameters
|
|
54141
54315
|
* @param {Object} opts.body body
|
|
54142
54316
|
*/
|
|
@@ -54165,7 +54339,7 @@ class WorkforceManagementApi {
|
|
|
54165
54339
|
/**
|
|
54166
54340
|
* Fetches time off requests matching the conditions specified in the request body
|
|
54167
54341
|
* 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
|
|
54168
|
-
* @param {String} managementUnitId The
|
|
54342
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
54169
54343
|
* @param {Object} opts Optional parameters
|
|
54170
54344
|
* @param {Object} opts.body body
|
|
54171
54345
|
*/
|
|
@@ -54194,7 +54368,7 @@ class WorkforceManagementApi {
|
|
|
54194
54368
|
/**
|
|
54195
54369
|
* Retrieves daily waitlist position for a list of time off requests
|
|
54196
54370
|
*
|
|
54197
|
-
* @param {String} managementUnitId The
|
|
54371
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
54198
54372
|
* @param {Object} opts Optional parameters
|
|
54199
54373
|
* @param {Object} opts.body body
|
|
54200
54374
|
*/
|
|
@@ -54223,7 +54397,7 @@ class WorkforceManagementApi {
|
|
|
54223
54397
|
/**
|
|
54224
54398
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
54225
54399
|
*
|
|
54226
|
-
* @param {String} managementUnitId The
|
|
54400
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
54227
54401
|
* @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
|
|
54228
54402
|
* @param {Object} body body
|
|
54229
54403
|
* @param {String} tradeId The ID of the shift trade to update
|
|
@@ -54263,7 +54437,7 @@ class WorkforceManagementApi {
|
|
|
54263
54437
|
/**
|
|
54264
54438
|
* Adds a shift trade
|
|
54265
54439
|
*
|
|
54266
|
-
* @param {String} managementUnitId The
|
|
54440
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
54267
54441
|
* @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
|
|
54268
54442
|
* @param {Object} body body
|
|
54269
54443
|
*/
|
|
@@ -54298,7 +54472,7 @@ class WorkforceManagementApi {
|
|
|
54298
54472
|
/**
|
|
54299
54473
|
* Searches for potential shift trade matches for the current agent
|
|
54300
54474
|
*
|
|
54301
|
-
* @param {String} managementUnitId The
|
|
54475
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
54302
54476
|
* @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
|
|
54303
54477
|
* @param {Object} body body
|
|
54304
54478
|
*/
|
|
@@ -54333,7 +54507,7 @@ class WorkforceManagementApi {
|
|
|
54333
54507
|
/**
|
|
54334
54508
|
* Updates the state of a batch of shift trades
|
|
54335
54509
|
* Admin functionality is not supported with \"mine\".
|
|
54336
|
-
* @param {String} managementUnitId The
|
|
54510
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
54337
54511
|
* @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
|
|
54338
54512
|
* @param {Object} body body
|
|
54339
54513
|
* @param {Object} opts Optional parameters
|
|
@@ -54654,7 +54828,7 @@ class WorkforceManagementApi {
|
|
|
54654
54828
|
/**
|
|
54655
54829
|
* Sets daily values for a date range of time off limit object
|
|
54656
54830
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
54657
|
-
* @param {String} managementUnitId The
|
|
54831
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
54658
54832
|
* @param {String} timeOffLimitId The ID of the time off limit object to set values for
|
|
54659
54833
|
* @param {Object} opts Optional parameters
|
|
54660
54834
|
* @param {Object} opts.body body
|
|
@@ -54716,7 +54890,7 @@ class WorkforceManagementApi {
|
|
|
54716
54890
|
* </pre>
|
|
54717
54891
|
* </p>
|
|
54718
54892
|
* @module purecloud-platform-client-v2/index
|
|
54719
|
-
* @version
|
|
54893
|
+
* @version 136.0.0
|
|
54720
54894
|
*/
|
|
54721
54895
|
class platformClient {
|
|
54722
54896
|
constructor() {
|