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
|
@@ -393,7 +393,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
393
393
|
|
|
394
394
|
/**
|
|
395
395
|
* @module purecloud-platform-client-v2/ApiClient
|
|
396
|
-
* @version
|
|
396
|
+
* @version 136.0.0
|
|
397
397
|
*/
|
|
398
398
|
class ApiClient {
|
|
399
399
|
/**
|
|
@@ -1340,7 +1340,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1340
1340
|
|
|
1341
1341
|
// set header parameters
|
|
1342
1342
|
request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
|
|
1343
|
-
//request.set({ 'purecloud-sdk': '
|
|
1343
|
+
//request.set({ 'purecloud-sdk': '136.0.0' });
|
|
1344
1344
|
|
|
1345
1345
|
// set request timeout
|
|
1346
1346
|
request.timeout(that.timeout);
|
|
@@ -1440,7 +1440,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1440
1440
|
/**
|
|
1441
1441
|
* Alerting service.
|
|
1442
1442
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1443
|
-
* @version
|
|
1443
|
+
* @version 136.0.0
|
|
1444
1444
|
*/
|
|
1445
1445
|
|
|
1446
1446
|
/**
|
|
@@ -1754,7 +1754,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1754
1754
|
/**
|
|
1755
1755
|
* Analytics service.
|
|
1756
1756
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1757
|
-
* @version
|
|
1757
|
+
* @version 136.0.0
|
|
1758
1758
|
*/
|
|
1759
1759
|
|
|
1760
1760
|
/**
|
|
@@ -2936,7 +2936,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2936
2936
|
/**
|
|
2937
2937
|
* Architect service.
|
|
2938
2938
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2939
|
-
* @version
|
|
2939
|
+
* @version 136.0.0
|
|
2940
2940
|
*/
|
|
2941
2941
|
|
|
2942
2942
|
/**
|
|
@@ -5932,7 +5932,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5932
5932
|
/**
|
|
5933
5933
|
* Audit service.
|
|
5934
5934
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
5935
|
-
* @version
|
|
5935
|
+
* @version 136.0.0
|
|
5936
5936
|
*/
|
|
5937
5937
|
|
|
5938
5938
|
/**
|
|
@@ -6103,7 +6103,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6103
6103
|
/**
|
|
6104
6104
|
* Authorization service.
|
|
6105
6105
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6106
|
-
* @version
|
|
6106
|
+
* @version 136.0.0
|
|
6107
6107
|
*/
|
|
6108
6108
|
|
|
6109
6109
|
/**
|
|
@@ -7286,7 +7286,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7286
7286
|
/**
|
|
7287
7287
|
* Billing service.
|
|
7288
7288
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7289
|
-
* @version
|
|
7289
|
+
* @version 136.0.0
|
|
7290
7290
|
*/
|
|
7291
7291
|
|
|
7292
7292
|
/**
|
|
@@ -7366,7 +7366,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7366
7366
|
/**
|
|
7367
7367
|
* Chat service.
|
|
7368
7368
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7369
|
-
* @version
|
|
7369
|
+
* @version 136.0.0
|
|
7370
7370
|
*/
|
|
7371
7371
|
|
|
7372
7372
|
/**
|
|
@@ -7457,7 +7457,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7457
7457
|
/**
|
|
7458
7458
|
* Coaching service.
|
|
7459
7459
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7460
|
-
* @version
|
|
7460
|
+
* @version 136.0.0
|
|
7461
7461
|
*/
|
|
7462
7462
|
|
|
7463
7463
|
/**
|
|
@@ -8034,7 +8034,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8034
8034
|
/**
|
|
8035
8035
|
* ContentManagement service.
|
|
8036
8036
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8037
|
-
* @version
|
|
8037
|
+
* @version 136.0.0
|
|
8038
8038
|
*/
|
|
8039
8039
|
|
|
8040
8040
|
/**
|
|
@@ -9174,7 +9174,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9174
9174
|
/**
|
|
9175
9175
|
* Conversations service.
|
|
9176
9176
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9177
|
-
* @version
|
|
9177
|
+
* @version 136.0.0
|
|
9178
9178
|
*/
|
|
9179
9179
|
|
|
9180
9180
|
/**
|
|
@@ -11079,7 +11079,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11079
11079
|
/**
|
|
11080
11080
|
* Get a list of Messaging Stickers
|
|
11081
11081
|
*
|
|
11082
|
-
* @param {
|
|
11082
|
+
* @param {Object} messengerType Messenger Type
|
|
11083
11083
|
* @param {Object} opts Optional parameters
|
|
11084
11084
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
11085
11085
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
@@ -11267,7 +11267,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11267
11267
|
}
|
|
11268
11268
|
|
|
11269
11269
|
/**
|
|
11270
|
-
* Update a conversation by setting
|
|
11270
|
+
* Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
11271
11271
|
*
|
|
11272
11272
|
* @param {String} conversationId conversationId
|
|
11273
11273
|
* @param {Object} body Conversation
|
|
@@ -12253,8 +12253,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12253
12253
|
}
|
|
12254
12254
|
|
|
12255
12255
|
/**
|
|
12256
|
-
* Update or activate a WhatsApp messaging integration
|
|
12257
|
-
* The following steps are required in order to fully activate a
|
|
12256
|
+
* Update or activate a WhatsApp messaging integration
|
|
12257
|
+
* 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.
|
|
12258
12258
|
* @param {String} integrationId Integration ID
|
|
12259
12259
|
* @param {Object} body WhatsAppIntegrationUpdateRequest
|
|
12260
12260
|
*/
|
|
@@ -13838,7 +13838,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13838
13838
|
/**
|
|
13839
13839
|
* DataExtensions service.
|
|
13840
13840
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
13841
|
-
* @version
|
|
13841
|
+
* @version 136.0.0
|
|
13842
13842
|
*/
|
|
13843
13843
|
|
|
13844
13844
|
/**
|
|
@@ -13924,7 +13924,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13924
13924
|
/**
|
|
13925
13925
|
* ExternalContacts service.
|
|
13926
13926
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
13927
|
-
* @version
|
|
13927
|
+
* @version 136.0.0
|
|
13928
13928
|
*/
|
|
13929
13929
|
|
|
13930
13930
|
/**
|
|
@@ -15667,7 +15667,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15667
15667
|
/**
|
|
15668
15668
|
* Fax service.
|
|
15669
15669
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
15670
|
-
* @version
|
|
15670
|
+
* @version 136.0.0
|
|
15671
15671
|
*/
|
|
15672
15672
|
|
|
15673
15673
|
/**
|
|
@@ -15838,7 +15838,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15838
15838
|
/**
|
|
15839
15839
|
* Flows service.
|
|
15840
15840
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
15841
|
-
* @version
|
|
15841
|
+
* @version 136.0.0
|
|
15842
15842
|
*/
|
|
15843
15843
|
|
|
15844
15844
|
/**
|
|
@@ -15909,7 +15909,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15909
15909
|
/**
|
|
15910
15910
|
* Gamification service.
|
|
15911
15911
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
15912
|
-
* @version
|
|
15912
|
+
* @version 136.0.0
|
|
15913
15913
|
*/
|
|
15914
15914
|
|
|
15915
15915
|
/**
|
|
@@ -16155,18 +16155,18 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16155
16155
|
/**
|
|
16156
16156
|
* Performance profile by id
|
|
16157
16157
|
*
|
|
16158
|
-
* @param {String} performanceProfileId
|
|
16158
|
+
* @param {String} profileId performanceProfileId
|
|
16159
16159
|
*/
|
|
16160
|
-
getGamificationProfile(
|
|
16161
|
-
// verify the required parameter '
|
|
16162
|
-
if (
|
|
16163
|
-
throw 'Missing the required parameter "
|
|
16160
|
+
getGamificationProfile(profileId) {
|
|
16161
|
+
// verify the required parameter 'profileId' is set
|
|
16162
|
+
if (profileId === undefined || profileId === null) {
|
|
16163
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationProfile';
|
|
16164
16164
|
}
|
|
16165
16165
|
|
|
16166
16166
|
return this.apiClient.callApi(
|
|
16167
|
-
'/api/v2/gamification/profiles/{
|
|
16167
|
+
'/api/v2/gamification/profiles/{profileId}',
|
|
16168
16168
|
'GET',
|
|
16169
|
-
{ '
|
|
16169
|
+
{ 'profileId': profileId },
|
|
16170
16170
|
{ },
|
|
16171
16171
|
{ },
|
|
16172
16172
|
{ },
|
|
@@ -17009,18 +17009,18 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17009
17009
|
/**
|
|
17010
17010
|
* Activate a performance profile
|
|
17011
17011
|
*
|
|
17012
|
-
* @param {String} performanceProfileId
|
|
17012
|
+
* @param {String} profileId performanceProfileId
|
|
17013
17013
|
*/
|
|
17014
|
-
postGamificationProfileActivate(
|
|
17015
|
-
// verify the required parameter '
|
|
17016
|
-
if (
|
|
17017
|
-
throw 'Missing the required parameter "
|
|
17014
|
+
postGamificationProfileActivate(profileId) {
|
|
17015
|
+
// verify the required parameter 'profileId' is set
|
|
17016
|
+
if (profileId === undefined || profileId === null) {
|
|
17017
|
+
throw 'Missing the required parameter "profileId" when calling postGamificationProfileActivate';
|
|
17018
17018
|
}
|
|
17019
17019
|
|
|
17020
17020
|
return this.apiClient.callApi(
|
|
17021
|
-
'/api/v2/gamification/profiles/{
|
|
17021
|
+
'/api/v2/gamification/profiles/{profileId}/activate',
|
|
17022
17022
|
'POST',
|
|
17023
|
-
{ '
|
|
17023
|
+
{ 'profileId': profileId },
|
|
17024
17024
|
{ },
|
|
17025
17025
|
{ },
|
|
17026
17026
|
{ },
|
|
@@ -17034,18 +17034,18 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17034
17034
|
/**
|
|
17035
17035
|
* Deactivate a performance profile
|
|
17036
17036
|
*
|
|
17037
|
-
* @param {String} performanceProfileId
|
|
17037
|
+
* @param {String} profileId performanceProfileId
|
|
17038
17038
|
*/
|
|
17039
|
-
postGamificationProfileDeactivate(
|
|
17040
|
-
// verify the required parameter '
|
|
17041
|
-
if (
|
|
17042
|
-
throw 'Missing the required parameter "
|
|
17039
|
+
postGamificationProfileDeactivate(profileId) {
|
|
17040
|
+
// verify the required parameter 'profileId' is set
|
|
17041
|
+
if (profileId === undefined || profileId === null) {
|
|
17042
|
+
throw 'Missing the required parameter "profileId" when calling postGamificationProfileDeactivate';
|
|
17043
17043
|
}
|
|
17044
17044
|
|
|
17045
17045
|
return this.apiClient.callApi(
|
|
17046
|
-
'/api/v2/gamification/profiles/{
|
|
17046
|
+
'/api/v2/gamification/profiles/{profileId}/deactivate',
|
|
17047
17047
|
'POST',
|
|
17048
|
-
{ '
|
|
17048
|
+
{ 'profileId': profileId },
|
|
17049
17049
|
{ },
|
|
17050
17050
|
{ },
|
|
17051
17051
|
{ },
|
|
@@ -17247,22 +17247,22 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17247
17247
|
/**
|
|
17248
17248
|
* Updates a performance profile
|
|
17249
17249
|
*
|
|
17250
|
-
* @param {String} performanceProfileId
|
|
17250
|
+
* @param {String} profileId performanceProfileId
|
|
17251
17251
|
* @param {Object} opts Optional parameters
|
|
17252
17252
|
* @param {Object} opts.body performanceProfile
|
|
17253
17253
|
*/
|
|
17254
|
-
putGamificationProfile(
|
|
17254
|
+
putGamificationProfile(profileId, opts) {
|
|
17255
17255
|
opts = opts || {};
|
|
17256
17256
|
|
|
17257
|
-
// verify the required parameter '
|
|
17258
|
-
if (
|
|
17259
|
-
throw 'Missing the required parameter "
|
|
17257
|
+
// verify the required parameter 'profileId' is set
|
|
17258
|
+
if (profileId === undefined || profileId === null) {
|
|
17259
|
+
throw 'Missing the required parameter "profileId" when calling putGamificationProfile';
|
|
17260
17260
|
}
|
|
17261
17261
|
|
|
17262
17262
|
return this.apiClient.callApi(
|
|
17263
|
-
'/api/v2/gamification/profiles/{
|
|
17263
|
+
'/api/v2/gamification/profiles/{profileId}',
|
|
17264
17264
|
'PUT',
|
|
17265
|
-
{ '
|
|
17265
|
+
{ 'profileId': profileId },
|
|
17266
17266
|
{ },
|
|
17267
17267
|
{ },
|
|
17268
17268
|
{ },
|
|
@@ -17339,7 +17339,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17339
17339
|
/**
|
|
17340
17340
|
* GeneralDataProtectionRegulation service.
|
|
17341
17341
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
17342
|
-
* @version
|
|
17342
|
+
* @version 136.0.0
|
|
17343
17343
|
*/
|
|
17344
17344
|
|
|
17345
17345
|
/**
|
|
@@ -17469,7 +17469,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17469
17469
|
/**
|
|
17470
17470
|
* Geolocation service.
|
|
17471
17471
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
17472
|
-
* @version
|
|
17472
|
+
* @version 136.0.0
|
|
17473
17473
|
*/
|
|
17474
17474
|
|
|
17475
17475
|
/**
|
|
@@ -17600,7 +17600,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17600
17600
|
/**
|
|
17601
17601
|
* Greetings service.
|
|
17602
17602
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
17603
|
-
* @version
|
|
17603
|
+
* @version 136.0.0
|
|
17604
17604
|
*/
|
|
17605
17605
|
|
|
17606
17606
|
/**
|
|
@@ -18055,7 +18055,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18055
18055
|
/**
|
|
18056
18056
|
* Groups service.
|
|
18057
18057
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
18058
|
-
* @version
|
|
18058
|
+
* @version 136.0.0
|
|
18059
18059
|
*/
|
|
18060
18060
|
|
|
18061
18061
|
/**
|
|
@@ -18460,7 +18460,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18460
18460
|
/**
|
|
18461
18461
|
* IdentityProvider service.
|
|
18462
18462
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
18463
|
-
* @version
|
|
18463
|
+
* @version 136.0.0
|
|
18464
18464
|
*/
|
|
18465
18465
|
|
|
18466
18466
|
/**
|
|
@@ -19216,7 +19216,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19216
19216
|
/**
|
|
19217
19217
|
* Integrations service.
|
|
19218
19218
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
19219
|
-
* @version
|
|
19219
|
+
* @version 136.0.0
|
|
19220
19220
|
*/
|
|
19221
19221
|
|
|
19222
19222
|
/**
|
|
@@ -19634,9 +19634,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19634
19634
|
* @param {String} opts.previousPage Previous page token
|
|
19635
19635
|
* @param {String} opts.sortBy Root level field name to sort on.
|
|
19636
19636
|
* @param {Object} opts.sortOrder Direction to sort 'sortBy' field. (default to asc)
|
|
19637
|
-
* @param {String} opts.category Filter by category name
|
|
19638
|
-
* @param {String} opts.name Filter by
|
|
19639
|
-
* @param {
|
|
19637
|
+
* @param {String} opts.category Filter by category name.
|
|
19638
|
+
* @param {String} opts.name Filter by partial or complete action name.
|
|
19639
|
+
* @param {String} opts.ids Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids.
|
|
19640
|
+
* @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.
|
|
19640
19641
|
* @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)
|
|
19641
19642
|
*/
|
|
19642
19643
|
getIntegrationsActions(opts) {
|
|
@@ -19647,7 +19648,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19647
19648
|
'/api/v2/integrations/actions',
|
|
19648
19649
|
'GET',
|
|
19649
19650
|
{ },
|
|
19650
|
-
{ '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'] },
|
|
19651
|
+
{ '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'] },
|
|
19651
19652
|
{ },
|
|
19652
19653
|
{ },
|
|
19653
19654
|
null,
|
|
@@ -19697,9 +19698,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19697
19698
|
* @param {String} opts.previousPage Previous page token
|
|
19698
19699
|
* @param {String} opts.sortBy Root level field name to sort on.
|
|
19699
19700
|
* @param {Object} opts.sortOrder Direction to sort 'sortBy' field. (default to asc)
|
|
19700
|
-
* @param {String} opts.category Filter by category name
|
|
19701
|
-
* @param {String} opts.name Filter by
|
|
19702
|
-
* @param {
|
|
19701
|
+
* @param {String} opts.category Filter by category name.
|
|
19702
|
+
* @param {String} opts.name Filter by partial or complete action name.
|
|
19703
|
+
* @param {String} opts.ids Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids.
|
|
19704
|
+
* @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.
|
|
19703
19705
|
* @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)
|
|
19704
19706
|
*/
|
|
19705
19707
|
getIntegrationsActionsDrafts(opts) {
|
|
@@ -19710,7 +19712,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19710
19712
|
'/api/v2/integrations/actions/drafts',
|
|
19711
19713
|
'GET',
|
|
19712
19714
|
{ },
|
|
19713
|
-
{ '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'] },
|
|
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'],'ids': opts['ids'],'secure': opts['secure'],'includeAuthActions': opts['includeAuthActions'] },
|
|
19714
19716
|
{ },
|
|
19715
19717
|
{ },
|
|
19716
19718
|
null,
|
|
@@ -20891,7 +20893,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20891
20893
|
/**
|
|
20892
20894
|
* Journey service.
|
|
20893
20895
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
20894
|
-
* @version
|
|
20896
|
+
* @version 136.0.0
|
|
20895
20897
|
*/
|
|
20896
20898
|
|
|
20897
20899
|
/**
|
|
@@ -21602,7 +21604,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21602
21604
|
/**
|
|
21603
21605
|
* Knowledge service.
|
|
21604
21606
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
21605
|
-
* @version
|
|
21607
|
+
* @version 136.0.0
|
|
21606
21608
|
*/
|
|
21607
21609
|
|
|
21608
21610
|
/**
|
|
@@ -22502,7 +22504,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22502
22504
|
/**
|
|
22503
22505
|
* LanguageUnderstanding service.
|
|
22504
22506
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
22505
|
-
* @version
|
|
22507
|
+
* @version 136.0.0
|
|
22506
22508
|
*/
|
|
22507
22509
|
|
|
22508
22510
|
/**
|
|
@@ -23406,7 +23408,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23406
23408
|
/**
|
|
23407
23409
|
* Languages service.
|
|
23408
23410
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
23409
|
-
* @version
|
|
23411
|
+
* @version 136.0.0
|
|
23410
23412
|
*/
|
|
23411
23413
|
|
|
23412
23414
|
/**
|
|
@@ -23674,7 +23676,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23674
23676
|
/**
|
|
23675
23677
|
* Learning service.
|
|
23676
23678
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
23677
|
-
* @version
|
|
23679
|
+
* @version 136.0.0
|
|
23678
23680
|
*/
|
|
23679
23681
|
|
|
23680
23682
|
/**
|
|
@@ -24265,7 +24267,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24265
24267
|
/**
|
|
24266
24268
|
* License service.
|
|
24267
24269
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
24268
|
-
* @version
|
|
24270
|
+
* @version 136.0.0
|
|
24269
24271
|
*/
|
|
24270
24272
|
|
|
24271
24273
|
/**
|
|
@@ -24503,7 +24505,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24503
24505
|
/**
|
|
24504
24506
|
* Locations service.
|
|
24505
24507
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
24506
|
-
* @version
|
|
24508
|
+
* @version 136.0.0
|
|
24507
24509
|
*/
|
|
24508
24510
|
|
|
24509
24511
|
/**
|
|
@@ -24739,7 +24741,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24739
24741
|
/**
|
|
24740
24742
|
* Messaging service.
|
|
24741
24743
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
24742
|
-
* @version
|
|
24744
|
+
* @version 136.0.0
|
|
24743
24745
|
*/
|
|
24744
24746
|
|
|
24745
24747
|
/**
|
|
@@ -24890,7 +24892,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24890
24892
|
/**
|
|
24891
24893
|
* MobileDevices service.
|
|
24892
24894
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
24893
|
-
* @version
|
|
24895
|
+
* @version 136.0.0
|
|
24894
24896
|
*/
|
|
24895
24897
|
|
|
24896
24898
|
/**
|
|
@@ -25041,7 +25043,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25041
25043
|
/**
|
|
25042
25044
|
* Notifications service.
|
|
25043
25045
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
25044
|
-
* @version
|
|
25046
|
+
* @version 136.0.0
|
|
25045
25047
|
*/
|
|
25046
25048
|
|
|
25047
25049
|
/**
|
|
@@ -25266,7 +25268,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25266
25268
|
/**
|
|
25267
25269
|
* OAuth service.
|
|
25268
25270
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
25269
|
-
* @version
|
|
25271
|
+
* @version 136.0.0
|
|
25270
25272
|
*/
|
|
25271
25273
|
|
|
25272
25274
|
/**
|
|
@@ -25632,7 +25634,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25632
25634
|
/**
|
|
25633
25635
|
* Objects service.
|
|
25634
25636
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
25635
|
-
* @version
|
|
25637
|
+
* @version 136.0.0
|
|
25636
25638
|
*/
|
|
25637
25639
|
|
|
25638
25640
|
/**
|
|
@@ -25903,7 +25905,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25903
25905
|
/**
|
|
25904
25906
|
* Organization service.
|
|
25905
25907
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
25906
|
-
* @version
|
|
25908
|
+
* @version 136.0.0
|
|
25907
25909
|
*/
|
|
25908
25910
|
|
|
25909
25911
|
/**
|
|
@@ -26306,7 +26308,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26306
26308
|
/**
|
|
26307
26309
|
* OrganizationAuthorization service.
|
|
26308
26310
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
26309
|
-
* @version
|
|
26311
|
+
* @version 136.0.0
|
|
26310
26312
|
*/
|
|
26311
26313
|
|
|
26312
26314
|
/**
|
|
@@ -27231,7 +27233,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27231
27233
|
/**
|
|
27232
27234
|
* Outbound service.
|
|
27233
27235
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
27234
|
-
* @version
|
|
27236
|
+
* @version 136.0.0
|
|
27235
27237
|
*/
|
|
27236
27238
|
|
|
27237
27239
|
/**
|
|
@@ -27581,6 +27583,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27581
27583
|
);
|
|
27582
27584
|
}
|
|
27583
27585
|
|
|
27586
|
+
/**
|
|
27587
|
+
* Reset messaging campaign progress and recycle the messaging campaign
|
|
27588
|
+
*
|
|
27589
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
27590
|
+
*/
|
|
27591
|
+
deleteOutboundMessagingcampaignProgress(messagingCampaignId) {
|
|
27592
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
27593
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
27594
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling deleteOutboundMessagingcampaignProgress';
|
|
27595
|
+
}
|
|
27596
|
+
|
|
27597
|
+
return this.apiClient.callApi(
|
|
27598
|
+
'/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress',
|
|
27599
|
+
'DELETE',
|
|
27600
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
27601
|
+
{ },
|
|
27602
|
+
{ },
|
|
27603
|
+
{ },
|
|
27604
|
+
null,
|
|
27605
|
+
['PureCloud OAuth'],
|
|
27606
|
+
['application/json'],
|
|
27607
|
+
['application/json']
|
|
27608
|
+
);
|
|
27609
|
+
}
|
|
27610
|
+
|
|
27584
27611
|
/**
|
|
27585
27612
|
* Delete a Rule Set.
|
|
27586
27613
|
*
|
|
@@ -30261,7 +30288,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30261
30288
|
/**
|
|
30262
30289
|
* Presence service.
|
|
30263
30290
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
30264
|
-
* @version
|
|
30291
|
+
* @version 136.0.0
|
|
30265
30292
|
*/
|
|
30266
30293
|
|
|
30267
30294
|
/**
|
|
@@ -30407,31 +30434,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30407
30434
|
);
|
|
30408
30435
|
}
|
|
30409
30436
|
|
|
30410
|
-
/**
|
|
30411
|
-
* Get a user's Microsoft Teams presence.
|
|
30412
|
-
* Gets the presence for a Microsoft Teams user. This will return the Microsoft Teams presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.
|
|
30413
|
-
* @param {String} userId user Id
|
|
30414
|
-
*/
|
|
30415
|
-
getUserPresencesMicrosoftteams(userId) {
|
|
30416
|
-
// verify the required parameter 'userId' is set
|
|
30417
|
-
if (userId === undefined || userId === null) {
|
|
30418
|
-
throw 'Missing the required parameter "userId" when calling getUserPresencesMicrosoftteams';
|
|
30419
|
-
}
|
|
30420
|
-
|
|
30421
|
-
return this.apiClient.callApi(
|
|
30422
|
-
'/api/v2/users/{userId}/presences/microsoftteams',
|
|
30423
|
-
'GET',
|
|
30424
|
-
{ 'userId': userId },
|
|
30425
|
-
{ },
|
|
30426
|
-
{ },
|
|
30427
|
-
{ },
|
|
30428
|
-
null,
|
|
30429
|
-
['PureCloud OAuth'],
|
|
30430
|
-
['application/json'],
|
|
30431
|
-
['application/json']
|
|
30432
|
-
);
|
|
30433
|
-
}
|
|
30434
|
-
|
|
30435
30437
|
/**
|
|
30436
30438
|
* Get a user's Genesys Cloud presence.
|
|
30437
30439
|
* Get the default Genesys Cloud user presence source PURECLOUD
|
|
@@ -30457,31 +30459,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30457
30459
|
);
|
|
30458
30460
|
}
|
|
30459
30461
|
|
|
30460
|
-
/**
|
|
30461
|
-
* Get a user's Zoom Phone presence.
|
|
30462
|
-
* Gets the presence for a Zoom user. This will return the Zoom Phone presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.
|
|
30463
|
-
* @param {String} userId user Id
|
|
30464
|
-
*/
|
|
30465
|
-
getUserPresencesZoomphone(userId) {
|
|
30466
|
-
// verify the required parameter 'userId' is set
|
|
30467
|
-
if (userId === undefined || userId === null) {
|
|
30468
|
-
throw 'Missing the required parameter "userId" when calling getUserPresencesZoomphone';
|
|
30469
|
-
}
|
|
30470
|
-
|
|
30471
|
-
return this.apiClient.callApi(
|
|
30472
|
-
'/api/v2/users/{userId}/presences/zoomphone',
|
|
30473
|
-
'GET',
|
|
30474
|
-
{ 'userId': userId },
|
|
30475
|
-
{ },
|
|
30476
|
-
{ },
|
|
30477
|
-
{ },
|
|
30478
|
-
null,
|
|
30479
|
-
['PureCloud OAuth'],
|
|
30480
|
-
['application/json'],
|
|
30481
|
-
['application/json']
|
|
30482
|
-
);
|
|
30483
|
-
}
|
|
30484
|
-
|
|
30485
30462
|
/**
|
|
30486
30463
|
* Patch a user's Presence
|
|
30487
30464
|
* Patch a user's presence for the specified source that is not specifically listed. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
|
|
@@ -30633,7 +30610,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30633
30610
|
/**
|
|
30634
30611
|
* Quality service.
|
|
30635
30612
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
30636
|
-
* @version
|
|
30613
|
+
* @version 136.0.0
|
|
30637
30614
|
*/
|
|
30638
30615
|
|
|
30639
30616
|
/**
|
|
@@ -32211,7 +32188,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32211
32188
|
/**
|
|
32212
32189
|
* Recording service.
|
|
32213
32190
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
32214
|
-
* @version
|
|
32191
|
+
* @version 136.0.0
|
|
32215
32192
|
*/
|
|
32216
32193
|
|
|
32217
32194
|
/**
|
|
@@ -32734,6 +32711,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32734
32711
|
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
32735
32712
|
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
32736
32713
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
32714
|
+
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
32737
32715
|
*/
|
|
32738
32716
|
getRecordingCrossplatformMediaretentionpolicies(opts) {
|
|
32739
32717
|
opts = opts || {};
|
|
@@ -32743,7 +32721,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32743
32721
|
'/api/v2/recording/crossplatform/mediaretentionpolicies',
|
|
32744
32722
|
'GET',
|
|
32745
32723
|
{ },
|
|
32746
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'] },
|
|
32724
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'],'deleteDaysThreshold': opts['deleteDaysThreshold'] },
|
|
32747
32725
|
{ },
|
|
32748
32726
|
{ },
|
|
32749
32727
|
null,
|
|
@@ -32866,6 +32844,51 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32866
32844
|
);
|
|
32867
32845
|
}
|
|
32868
32846
|
|
|
32847
|
+
/**
|
|
32848
|
+
* Get the encryption key configurations
|
|
32849
|
+
*
|
|
32850
|
+
* @param {String} keyConfigurationId Key Configurations Id
|
|
32851
|
+
*/
|
|
32852
|
+
getRecordingKeyconfiguration(keyConfigurationId) {
|
|
32853
|
+
// verify the required parameter 'keyConfigurationId' is set
|
|
32854
|
+
if (keyConfigurationId === undefined || keyConfigurationId === null) {
|
|
32855
|
+
throw 'Missing the required parameter "keyConfigurationId" when calling getRecordingKeyconfiguration';
|
|
32856
|
+
}
|
|
32857
|
+
|
|
32858
|
+
return this.apiClient.callApi(
|
|
32859
|
+
'/api/v2/recording/keyconfigurations/{keyConfigurationId}',
|
|
32860
|
+
'GET',
|
|
32861
|
+
{ 'keyConfigurationId': keyConfigurationId },
|
|
32862
|
+
{ },
|
|
32863
|
+
{ },
|
|
32864
|
+
{ },
|
|
32865
|
+
null,
|
|
32866
|
+
['PureCloud OAuth'],
|
|
32867
|
+
['application/json'],
|
|
32868
|
+
['application/json']
|
|
32869
|
+
);
|
|
32870
|
+
}
|
|
32871
|
+
|
|
32872
|
+
/**
|
|
32873
|
+
* Get a list of key configurations data
|
|
32874
|
+
*
|
|
32875
|
+
*/
|
|
32876
|
+
getRecordingKeyconfigurations() {
|
|
32877
|
+
|
|
32878
|
+
return this.apiClient.callApi(
|
|
32879
|
+
'/api/v2/recording/keyconfigurations',
|
|
32880
|
+
'GET',
|
|
32881
|
+
{ },
|
|
32882
|
+
{ },
|
|
32883
|
+
{ },
|
|
32884
|
+
{ },
|
|
32885
|
+
null,
|
|
32886
|
+
['PureCloud OAuth'],
|
|
32887
|
+
['application/json'],
|
|
32888
|
+
['application/json']
|
|
32889
|
+
);
|
|
32890
|
+
}
|
|
32891
|
+
|
|
32869
32892
|
/**
|
|
32870
32893
|
* Get the local encryption settings
|
|
32871
32894
|
*
|
|
@@ -32925,6 +32948,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32925
32948
|
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
32926
32949
|
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
32927
32950
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
32951
|
+
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
32928
32952
|
*/
|
|
32929
32953
|
getRecordingMediaretentionpolicies(opts) {
|
|
32930
32954
|
opts = opts || {};
|
|
@@ -32934,7 +32958,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32934
32958
|
'/api/v2/recording/mediaretentionpolicies',
|
|
32935
32959
|
'GET',
|
|
32936
32960
|
{ },
|
|
32937
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'] },
|
|
32961
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'],'deleteDaysThreshold': opts['deleteDaysThreshold'] },
|
|
32938
32962
|
{ },
|
|
32939
32963
|
{ },
|
|
32940
32964
|
null,
|
|
@@ -33238,8 +33262,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33238
33262
|
}
|
|
33239
33263
|
|
|
33240
33264
|
/**
|
|
33241
|
-
* Create a recording bulk job
|
|
33242
|
-
*
|
|
33265
|
+
* Create a recording bulk job.
|
|
33266
|
+
* Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state.
|
|
33243
33267
|
* @param {Object} body query
|
|
33244
33268
|
*/
|
|
33245
33269
|
postRecordingJobs(body) {
|
|
@@ -33262,6 +33286,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33262
33286
|
);
|
|
33263
33287
|
}
|
|
33264
33288
|
|
|
33289
|
+
/**
|
|
33290
|
+
* Setup configurations for encryption key creation
|
|
33291
|
+
*
|
|
33292
|
+
* @param {Object} body Encryption Configuration
|
|
33293
|
+
*/
|
|
33294
|
+
postRecordingKeyconfigurations(body) {
|
|
33295
|
+
// verify the required parameter 'body' is set
|
|
33296
|
+
if (body === undefined || body === null) {
|
|
33297
|
+
throw 'Missing the required parameter "body" when calling postRecordingKeyconfigurations';
|
|
33298
|
+
}
|
|
33299
|
+
|
|
33300
|
+
return this.apiClient.callApi(
|
|
33301
|
+
'/api/v2/recording/keyconfigurations',
|
|
33302
|
+
'POST',
|
|
33303
|
+
{ },
|
|
33304
|
+
{ },
|
|
33305
|
+
{ },
|
|
33306
|
+
{ },
|
|
33307
|
+
body,
|
|
33308
|
+
['PureCloud OAuth'],
|
|
33309
|
+
['application/json'],
|
|
33310
|
+
['application/json']
|
|
33311
|
+
);
|
|
33312
|
+
}
|
|
33313
|
+
|
|
33314
|
+
/**
|
|
33315
|
+
* Validate encryption key configurations without saving it
|
|
33316
|
+
*
|
|
33317
|
+
* @param {Object} body Encryption Configuration
|
|
33318
|
+
*/
|
|
33319
|
+
postRecordingKeyconfigurationsValidate(body) {
|
|
33320
|
+
// verify the required parameter 'body' is set
|
|
33321
|
+
if (body === undefined || body === null) {
|
|
33322
|
+
throw 'Missing the required parameter "body" when calling postRecordingKeyconfigurationsValidate';
|
|
33323
|
+
}
|
|
33324
|
+
|
|
33325
|
+
return this.apiClient.callApi(
|
|
33326
|
+
'/api/v2/recording/keyconfigurations/validate',
|
|
33327
|
+
'POST',
|
|
33328
|
+
{ },
|
|
33329
|
+
{ },
|
|
33330
|
+
{ },
|
|
33331
|
+
{ },
|
|
33332
|
+
body,
|
|
33333
|
+
['PureCloud OAuth'],
|
|
33334
|
+
['application/json'],
|
|
33335
|
+
['application/json']
|
|
33336
|
+
);
|
|
33337
|
+
}
|
|
33338
|
+
|
|
33265
33339
|
/**
|
|
33266
33340
|
* create a local recording key
|
|
33267
33341
|
*
|
|
@@ -33596,6 +33670,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33596
33670
|
);
|
|
33597
33671
|
}
|
|
33598
33672
|
|
|
33673
|
+
/**
|
|
33674
|
+
* Update the encryption key configurations
|
|
33675
|
+
*
|
|
33676
|
+
* @param {String} keyConfigurationId Key Configurations Id
|
|
33677
|
+
* @param {Object} body Encryption key configuration metadata
|
|
33678
|
+
*/
|
|
33679
|
+
putRecordingKeyconfiguration(keyConfigurationId, body) {
|
|
33680
|
+
// verify the required parameter 'keyConfigurationId' is set
|
|
33681
|
+
if (keyConfigurationId === undefined || keyConfigurationId === null) {
|
|
33682
|
+
throw 'Missing the required parameter "keyConfigurationId" when calling putRecordingKeyconfiguration';
|
|
33683
|
+
}
|
|
33684
|
+
// verify the required parameter 'body' is set
|
|
33685
|
+
if (body === undefined || body === null) {
|
|
33686
|
+
throw 'Missing the required parameter "body" when calling putRecordingKeyconfiguration';
|
|
33687
|
+
}
|
|
33688
|
+
|
|
33689
|
+
return this.apiClient.callApi(
|
|
33690
|
+
'/api/v2/recording/keyconfigurations/{keyConfigurationId}',
|
|
33691
|
+
'PUT',
|
|
33692
|
+
{ 'keyConfigurationId': keyConfigurationId },
|
|
33693
|
+
{ },
|
|
33694
|
+
{ },
|
|
33695
|
+
{ },
|
|
33696
|
+
body,
|
|
33697
|
+
['PureCloud OAuth'],
|
|
33698
|
+
['application/json'],
|
|
33699
|
+
['application/json']
|
|
33700
|
+
);
|
|
33701
|
+
}
|
|
33702
|
+
|
|
33599
33703
|
/**
|
|
33600
33704
|
* Update the local encryption settings
|
|
33601
33705
|
*
|
|
@@ -33737,7 +33841,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33737
33841
|
/**
|
|
33738
33842
|
* ResponseManagement service.
|
|
33739
33843
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
33740
|
-
* @version
|
|
33844
|
+
* @version 136.0.0
|
|
33741
33845
|
*/
|
|
33742
33846
|
|
|
33743
33847
|
/**
|
|
@@ -34221,7 +34325,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34221
34325
|
/**
|
|
34222
34326
|
* Routing service.
|
|
34223
34327
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
34224
|
-
* @version
|
|
34328
|
+
* @version 136.0.0
|
|
34225
34329
|
*/
|
|
34226
34330
|
|
|
34227
34331
|
/**
|
|
@@ -34880,14 +34984,18 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34880
34984
|
/**
|
|
34881
34985
|
* Get domains
|
|
34882
34986
|
*
|
|
34987
|
+
* @param {Object} opts Optional parameters
|
|
34988
|
+
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
34883
34989
|
*/
|
|
34884
|
-
getRoutingEmailDomains() {
|
|
34990
|
+
getRoutingEmailDomains(opts) {
|
|
34991
|
+
opts = opts || {};
|
|
34992
|
+
|
|
34885
34993
|
|
|
34886
34994
|
return this.apiClient.callApi(
|
|
34887
34995
|
'/api/v2/routing/email/domains',
|
|
34888
34996
|
'GET',
|
|
34889
34997
|
{ },
|
|
34890
|
-
{
|
|
34998
|
+
{ 'excludeStatus': opts['excludeStatus'] },
|
|
34891
34999
|
{ },
|
|
34892
35000
|
{ },
|
|
34893
35001
|
null,
|
|
@@ -37144,7 +37252,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37144
37252
|
/**
|
|
37145
37253
|
* SCIM service.
|
|
37146
37254
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
37147
|
-
* @version
|
|
37255
|
+
* @version 136.0.0
|
|
37148
37256
|
*/
|
|
37149
37257
|
|
|
37150
37258
|
/**
|
|
@@ -38021,7 +38129,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38021
38129
|
/**
|
|
38022
38130
|
* Scripts service.
|
|
38023
38131
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
38024
|
-
* @version
|
|
38132
|
+
* @version 136.0.0
|
|
38025
38133
|
*/
|
|
38026
38134
|
|
|
38027
38135
|
/**
|
|
@@ -38137,6 +38245,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38137
38245
|
* @param {Object} opts.sortBy SortBy
|
|
38138
38246
|
* @param {Object} opts.sortOrder SortOrder
|
|
38139
38247
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
38248
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
38140
38249
|
*/
|
|
38141
38250
|
getScripts(opts) {
|
|
38142
38251
|
opts = opts || {};
|
|
@@ -38146,7 +38255,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38146
38255
|
'/api/v2/scripts',
|
|
38147
38256
|
'GET',
|
|
38148
38257
|
{ },
|
|
38149
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'scriptDataVersion': opts['scriptDataVersion'] },
|
|
38258
|
+
{ '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'] },
|
|
38259
|
+
{ },
|
|
38260
|
+
{ },
|
|
38261
|
+
null,
|
|
38262
|
+
['PureCloud OAuth'],
|
|
38263
|
+
['application/json'],
|
|
38264
|
+
['application/json']
|
|
38265
|
+
);
|
|
38266
|
+
}
|
|
38267
|
+
|
|
38268
|
+
/**
|
|
38269
|
+
* Get the metadata for a list of scripts
|
|
38270
|
+
*
|
|
38271
|
+
* @param {Object} opts Optional parameters
|
|
38272
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
38273
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
38274
|
+
* @param {String} opts.expand Expand
|
|
38275
|
+
* @param {String} opts.name Name filter
|
|
38276
|
+
* @param {String} opts.feature Feature filter
|
|
38277
|
+
* @param {String} opts.flowId Secure flow id filter
|
|
38278
|
+
* @param {Object} opts.sortBy SortBy
|
|
38279
|
+
* @param {Object} opts.sortOrder SortOrder
|
|
38280
|
+
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
38281
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
38282
|
+
*/
|
|
38283
|
+
getScriptsDivisionviews(opts) {
|
|
38284
|
+
opts = opts || {};
|
|
38285
|
+
|
|
38286
|
+
|
|
38287
|
+
return this.apiClient.callApi(
|
|
38288
|
+
'/api/v2/scripts/divisionviews',
|
|
38289
|
+
'GET',
|
|
38290
|
+
{ },
|
|
38291
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
38150
38292
|
{ },
|
|
38151
38293
|
{ },
|
|
38152
38294
|
null,
|
|
@@ -38167,6 +38309,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38167
38309
|
* @param {String} opts.feature Feature filter
|
|
38168
38310
|
* @param {String} opts.flowId Secure flow id filter
|
|
38169
38311
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
38312
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
38170
38313
|
*/
|
|
38171
38314
|
getScriptsPublished(opts) {
|
|
38172
38315
|
opts = opts || {};
|
|
@@ -38176,7 +38319,38 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38176
38319
|
'/api/v2/scripts/published',
|
|
38177
38320
|
'GET',
|
|
38178
38321
|
{ },
|
|
38179
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'] },
|
|
38322
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
38323
|
+
{ },
|
|
38324
|
+
{ },
|
|
38325
|
+
null,
|
|
38326
|
+
['PureCloud OAuth'],
|
|
38327
|
+
['application/json'],
|
|
38328
|
+
['application/json']
|
|
38329
|
+
);
|
|
38330
|
+
}
|
|
38331
|
+
|
|
38332
|
+
/**
|
|
38333
|
+
* Get the published scripts metadata.
|
|
38334
|
+
*
|
|
38335
|
+
* @param {Object} opts Optional parameters
|
|
38336
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
38337
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
38338
|
+
* @param {String} opts.expand Expand
|
|
38339
|
+
* @param {String} opts.name Name filter
|
|
38340
|
+
* @param {String} opts.feature Feature filter
|
|
38341
|
+
* @param {String} opts.flowId Secure flow id filter
|
|
38342
|
+
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
38343
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
38344
|
+
*/
|
|
38345
|
+
getScriptsPublishedDivisionviews(opts) {
|
|
38346
|
+
opts = opts || {};
|
|
38347
|
+
|
|
38348
|
+
|
|
38349
|
+
return this.apiClient.callApi(
|
|
38350
|
+
'/api/v2/scripts/published/divisionviews',
|
|
38351
|
+
'GET',
|
|
38352
|
+
{ },
|
|
38353
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
38180
38354
|
{ },
|
|
38181
38355
|
{ },
|
|
38182
38356
|
null,
|
|
@@ -38374,7 +38548,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38374
38548
|
/**
|
|
38375
38549
|
* Search service.
|
|
38376
38550
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
38377
|
-
* @version
|
|
38551
|
+
* @version 136.0.0
|
|
38378
38552
|
*/
|
|
38379
38553
|
|
|
38380
38554
|
/**
|
|
@@ -38909,7 +39083,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38909
39083
|
/**
|
|
38910
39084
|
* SpeechTextAnalytics service.
|
|
38911
39085
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
38912
|
-
* @version
|
|
39086
|
+
* @version 136.0.0
|
|
38913
39087
|
*/
|
|
38914
39088
|
|
|
38915
39089
|
/**
|
|
@@ -39762,7 +39936,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39762
39936
|
/**
|
|
39763
39937
|
* Stations service.
|
|
39764
39938
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
39765
|
-
* @version
|
|
39939
|
+
* @version 136.0.0
|
|
39766
39940
|
*/
|
|
39767
39941
|
|
|
39768
39942
|
/**
|
|
@@ -39909,7 +40083,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39909
40083
|
/**
|
|
39910
40084
|
* Suggest service.
|
|
39911
40085
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
39912
|
-
* @version
|
|
40086
|
+
* @version 136.0.0
|
|
39913
40087
|
*/
|
|
39914
40088
|
|
|
39915
40089
|
/**
|
|
@@ -40048,7 +40222,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40048
40222
|
/**
|
|
40049
40223
|
* Telephony service.
|
|
40050
40224
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
40051
|
-
* @version
|
|
40225
|
+
* @version 136.0.0
|
|
40052
40226
|
*/
|
|
40053
40227
|
|
|
40054
40228
|
/**
|
|
@@ -40156,7 +40330,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40156
40330
|
/**
|
|
40157
40331
|
* TelephonyProvidersEdge service.
|
|
40158
40332
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
40159
|
-
* @version
|
|
40333
|
+
* @version 136.0.0
|
|
40160
40334
|
*/
|
|
40161
40335
|
|
|
40162
40336
|
/**
|
|
@@ -41571,7 +41745,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41571
41745
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
41572
41746
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
41573
41747
|
* @param {String} opts.sortBy Sort by
|
|
41574
|
-
* @param {String} opts._number
|
|
41748
|
+
* @param {String} opts._number Deprecated, filtering by number not supported
|
|
41575
41749
|
*/
|
|
41576
41750
|
getTelephonyProvidersEdgesExtensionpools(opts) {
|
|
41577
41751
|
opts = opts || {};
|
|
@@ -43789,7 +43963,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43789
43963
|
/**
|
|
43790
43964
|
* Textbots service.
|
|
43791
43965
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
43792
|
-
* @version
|
|
43966
|
+
* @version 136.0.0
|
|
43793
43967
|
*/
|
|
43794
43968
|
|
|
43795
43969
|
/**
|
|
@@ -43917,7 +44091,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43917
44091
|
/**
|
|
43918
44092
|
* Tokens service.
|
|
43919
44093
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
43920
|
-
* @version
|
|
44094
|
+
* @version 136.0.0
|
|
43921
44095
|
*/
|
|
43922
44096
|
|
|
43923
44097
|
/**
|
|
@@ -44023,7 +44197,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44023
44197
|
/**
|
|
44024
44198
|
* Uploads service.
|
|
44025
44199
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
44026
|
-
* @version
|
|
44200
|
+
* @version 136.0.0
|
|
44027
44201
|
*/
|
|
44028
44202
|
|
|
44029
44203
|
/**
|
|
@@ -44174,7 +44348,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44174
44348
|
/**
|
|
44175
44349
|
* Usage service.
|
|
44176
44350
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
44177
|
-
* @version
|
|
44351
|
+
* @version 136.0.0
|
|
44178
44352
|
*/
|
|
44179
44353
|
|
|
44180
44354
|
/**
|
|
@@ -44245,7 +44419,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44245
44419
|
/**
|
|
44246
44420
|
* UserRecordings service.
|
|
44247
44421
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
44248
|
-
* @version
|
|
44422
|
+
* @version 136.0.0
|
|
44249
44423
|
*/
|
|
44250
44424
|
|
|
44251
44425
|
/**
|
|
@@ -44429,7 +44603,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44429
44603
|
/**
|
|
44430
44604
|
* Users service.
|
|
44431
44605
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
44432
|
-
* @version
|
|
44606
|
+
* @version 136.0.0
|
|
44433
44607
|
*/
|
|
44434
44608
|
|
|
44435
44609
|
/**
|
|
@@ -46731,7 +46905,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46731
46905
|
/**
|
|
46732
46906
|
* Utilities service.
|
|
46733
46907
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
46734
|
-
* @version
|
|
46908
|
+
* @version 136.0.0
|
|
46735
46909
|
*/
|
|
46736
46910
|
|
|
46737
46911
|
/**
|
|
@@ -46842,7 +47016,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46842
47016
|
/**
|
|
46843
47017
|
* Voicemail service.
|
|
46844
47018
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
46845
|
-
* @version
|
|
47019
|
+
* @version 136.0.0
|
|
46846
47020
|
*/
|
|
46847
47021
|
|
|
46848
47022
|
/**
|
|
@@ -47509,7 +47683,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47509
47683
|
/**
|
|
47510
47684
|
* WebChat service.
|
|
47511
47685
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
47512
|
-
* @version
|
|
47686
|
+
* @version 136.0.0
|
|
47513
47687
|
*/
|
|
47514
47688
|
|
|
47515
47689
|
/**
|
|
@@ -48053,7 +48227,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48053
48227
|
/**
|
|
48054
48228
|
* WebDeployments service.
|
|
48055
48229
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
48056
|
-
* @version
|
|
48230
|
+
* @version 136.0.0
|
|
48057
48231
|
*/
|
|
48058
48232
|
|
|
48059
48233
|
/**
|
|
@@ -48408,7 +48582,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48408
48582
|
/**
|
|
48409
48583
|
* WebMessaging service.
|
|
48410
48584
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
48411
|
-
* @version
|
|
48585
|
+
* @version 136.0.0
|
|
48412
48586
|
*/
|
|
48413
48587
|
|
|
48414
48588
|
/**
|
|
@@ -48454,7 +48628,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48454
48628
|
/**
|
|
48455
48629
|
* Widgets service.
|
|
48456
48630
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
48457
|
-
* @version
|
|
48631
|
+
* @version 136.0.0
|
|
48458
48632
|
*/
|
|
48459
48633
|
|
|
48460
48634
|
/**
|
|
@@ -48600,7 +48774,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48600
48774
|
/**
|
|
48601
48775
|
* WorkforceManagement service.
|
|
48602
48776
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
48603
|
-
* @version
|
|
48777
|
+
* @version 136.0.0
|
|
48604
48778
|
*/
|
|
48605
48779
|
|
|
48606
48780
|
/**
|
|
@@ -48798,7 +48972,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48798
48972
|
/**
|
|
48799
48973
|
* Delete a short term forecast
|
|
48800
48974
|
* Must not be tied to any schedules
|
|
48801
|
-
* @param {String} businessUnitId The
|
|
48975
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
48802
48976
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
48803
48977
|
* @param {String} forecastId The ID of the forecast
|
|
48804
48978
|
*/
|
|
@@ -48878,7 +49052,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48878
49052
|
/**
|
|
48879
49053
|
* Deletes a time off limit object
|
|
48880
49054
|
*
|
|
48881
|
-
* @param {String} managementUnitId The
|
|
49055
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
48882
49056
|
* @param {String} timeOffLimitId The ID of the time off limit object to delete
|
|
48883
49057
|
*/
|
|
48884
49058
|
deleteWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
@@ -48908,7 +49082,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48908
49082
|
/**
|
|
48909
49083
|
* Deletes a time off plan
|
|
48910
49084
|
*
|
|
48911
|
-
* @param {String} managementUnitId The management unit
|
|
49085
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
48912
49086
|
* @param {String} timeOffPlanId The ID of the time off plan to delete
|
|
48913
49087
|
*/
|
|
48914
49088
|
deleteWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
@@ -49177,7 +49351,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49177
49351
|
/**
|
|
49178
49352
|
* Get intraday planning groups for the given date
|
|
49179
49353
|
*
|
|
49180
|
-
* @param {String} businessUnitId The
|
|
49354
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
49181
49355
|
* @param {String} _date yyyy-MM-dd date string interpreted in the configured business unit time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
49182
49356
|
*/
|
|
49183
49357
|
getWorkforcemanagementBusinessunitIntradayPlanninggroups(businessUnitId, _date) {
|
|
@@ -49630,7 +49804,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49630
49804
|
/**
|
|
49631
49805
|
* Get a short term forecast
|
|
49632
49806
|
*
|
|
49633
|
-
* @param {String} businessUnitId The
|
|
49807
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49634
49808
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
49635
49809
|
* @param {String} forecastId The ID of the forecast
|
|
49636
49810
|
* @param {Object} opts Optional parameters
|
|
@@ -49669,7 +49843,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49669
49843
|
/**
|
|
49670
49844
|
* Get the result of a short term forecast calculation
|
|
49671
49845
|
* Includes modifications unless you pass the doNotApplyModifications query parameter
|
|
49672
|
-
* @param {String} businessUnitId The
|
|
49846
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49673
49847
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
49674
49848
|
* @param {String} forecastId The ID of the forecast
|
|
49675
49849
|
* @param {Object} opts Optional parameters
|
|
@@ -49709,7 +49883,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49709
49883
|
/**
|
|
49710
49884
|
* Gets the forecast generation results
|
|
49711
49885
|
*
|
|
49712
|
-
* @param {String} businessUnitId The
|
|
49886
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49713
49887
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
49714
49888
|
* @param {String} forecastId The ID of the forecast
|
|
49715
49889
|
*/
|
|
@@ -49744,7 +49918,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49744
49918
|
/**
|
|
49745
49919
|
* Get the result of a long term forecast calculation
|
|
49746
49920
|
* Includes modifications unless you pass the doNotApplyModifications query parameter
|
|
49747
|
-
* @param {String} businessUnitId The
|
|
49921
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49748
49922
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
49749
49923
|
* @param {String} forecastId The ID of the forecast
|
|
49750
49924
|
* @param {Object} opts Optional parameters
|
|
@@ -49783,7 +49957,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49783
49957
|
/**
|
|
49784
49958
|
* Gets the forecast planning group snapshot
|
|
49785
49959
|
*
|
|
49786
|
-
* @param {String} businessUnitId The
|
|
49960
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49787
49961
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
49788
49962
|
* @param {String} forecastId The ID of the forecast
|
|
49789
49963
|
*/
|
|
@@ -49818,7 +49992,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49818
49992
|
/**
|
|
49819
49993
|
* Get short term forecasts
|
|
49820
49994
|
* Use \"recent\" (without quotes) for the `weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any forecast which spans the specified week
|
|
49821
|
-
* @param {String} businessUnitId The
|
|
49995
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49822
49996
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format or 'recent' (without quotes) to fetch recent forecasts
|
|
49823
49997
|
*/
|
|
49824
49998
|
getWorkforcemanagementBusinessunitWeekShorttermforecasts(businessUnitId, weekDateId) {
|
|
@@ -50036,7 +50210,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50036
50210
|
/**
|
|
50037
50211
|
* Get a list of user schedule adherence records for the requested management unit
|
|
50038
50212
|
*
|
|
50039
|
-
* @param {String} managementUnitId The
|
|
50213
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
50040
50214
|
* @param {Object} opts Optional parameters
|
|
50041
50215
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
50042
50216
|
*/
|
|
@@ -50065,7 +50239,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50065
50239
|
/**
|
|
50066
50240
|
* Get data for agent in the management unit
|
|
50067
50241
|
*
|
|
50068
|
-
* @param {String} managementUnitId The
|
|
50242
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50069
50243
|
* @param {String} agentId The agent id
|
|
50070
50244
|
* @param {Object} opts Optional parameters
|
|
50071
50245
|
* @param {Boolean} opts.excludeCapabilities Excludes all capabilities of the agent such as queues, languages, and skills
|
|
@@ -50099,7 +50273,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50099
50273
|
/**
|
|
50100
50274
|
* Gets all the shift trades for a given agent
|
|
50101
50275
|
*
|
|
50102
|
-
* @param {String} managementUnitId The
|
|
50276
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50103
50277
|
* @param {String} agentId The agent id
|
|
50104
50278
|
*/
|
|
50105
50279
|
getWorkforcemanagementManagementunitAgentShifttrades(managementUnitId, agentId) {
|
|
@@ -50129,7 +50303,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50129
50303
|
/**
|
|
50130
50304
|
* Gets a summary of all shift trades in the matched state
|
|
50131
50305
|
*
|
|
50132
|
-
* @param {String} managementUnitId The
|
|
50306
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50133
50307
|
*/
|
|
50134
50308
|
getWorkforcemanagementManagementunitShifttradesMatched(managementUnitId) {
|
|
50135
50309
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50154,7 +50328,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50154
50328
|
/**
|
|
50155
50329
|
* Gets list of users available for whom you can send direct shift trade requests
|
|
50156
50330
|
*
|
|
50157
|
-
* @param {String} managementUnitId The
|
|
50331
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50158
50332
|
*/
|
|
50159
50333
|
getWorkforcemanagementManagementunitShifttradesUsers(managementUnitId) {
|
|
50160
50334
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50179,7 +50353,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50179
50353
|
/**
|
|
50180
50354
|
* Gets a time off limit object
|
|
50181
50355
|
* Returns properties of time off limit object, but not daily values.
|
|
50182
|
-
* @param {String} managementUnitId The
|
|
50356
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
50183
50357
|
* @param {String} timeOffLimitId The ID of the time off limit to fetch
|
|
50184
50358
|
*/
|
|
50185
50359
|
getWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
@@ -50209,7 +50383,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50209
50383
|
/**
|
|
50210
50384
|
* Gets a list of time off limit objects under management unit.
|
|
50211
50385
|
* Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.
|
|
50212
|
-
* @param {String} managementUnitId The
|
|
50386
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
50213
50387
|
*/
|
|
50214
50388
|
getWorkforcemanagementManagementunitTimeofflimits(managementUnitId) {
|
|
50215
50389
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50234,7 +50408,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50234
50408
|
/**
|
|
50235
50409
|
* Gets a time off plan
|
|
50236
50410
|
*
|
|
50237
|
-
* @param {String} managementUnitId The management unit
|
|
50411
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
50238
50412
|
* @param {String} timeOffPlanId The ID of the time off plan to fetch
|
|
50239
50413
|
*/
|
|
50240
50414
|
getWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
@@ -50264,7 +50438,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50264
50438
|
/**
|
|
50265
50439
|
* Gets a list of time off plans
|
|
50266
50440
|
*
|
|
50267
|
-
* @param {String} managementUnitId The management unit
|
|
50441
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
50268
50442
|
*/
|
|
50269
50443
|
getWorkforcemanagementManagementunitTimeoffplans(managementUnitId) {
|
|
50270
50444
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50289,7 +50463,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50289
50463
|
/**
|
|
50290
50464
|
* Get a time off request
|
|
50291
50465
|
*
|
|
50292
|
-
* @param {String} managementUnitId The
|
|
50466
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50293
50467
|
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
50294
50468
|
* @param {String} timeOffRequestId Time Off Request Id
|
|
50295
50469
|
*/
|
|
@@ -50324,7 +50498,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50324
50498
|
/**
|
|
50325
50499
|
* Retrieves time off limit, allocated and waitlisted values according to specific time off request
|
|
50326
50500
|
*
|
|
50327
|
-
* @param {String} managementUnitId The
|
|
50501
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
50328
50502
|
* @param {String} userId The userId to whom the time off request applies.
|
|
50329
50503
|
* @param {String} timeOffRequestId The ID of the time off request, which dates and activityCodeId determine limit values to retrieve
|
|
50330
50504
|
*/
|
|
@@ -50359,7 +50533,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50359
50533
|
/**
|
|
50360
50534
|
* Get a list of time off requests for a given user
|
|
50361
50535
|
*
|
|
50362
|
-
* @param {String} managementUnitId The
|
|
50536
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50363
50537
|
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
50364
50538
|
* @param {Object} opts Optional parameters
|
|
50365
50539
|
* @param {Boolean} opts.recentlyReviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
|
|
@@ -50393,7 +50567,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50393
50567
|
/**
|
|
50394
50568
|
* Get users in the management unit
|
|
50395
50569
|
*
|
|
50396
|
-
* @param {String} managementUnitId The
|
|
50570
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50397
50571
|
*/
|
|
50398
50572
|
getWorkforcemanagementManagementunitUsers(managementUnitId) {
|
|
50399
50573
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50494,7 +50668,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50494
50668
|
/**
|
|
50495
50669
|
* Gets all the shift trades for a given week
|
|
50496
50670
|
*
|
|
50497
|
-
* @param {String} managementUnitId The
|
|
50671
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50498
50672
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
50499
50673
|
* @param {Object} opts Optional parameters
|
|
50500
50674
|
* @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
|
|
@@ -50767,7 +50941,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50767
50941
|
/**
|
|
50768
50942
|
* Get a time off request for the current user
|
|
50769
50943
|
*
|
|
50770
|
-
* @param {String} timeOffRequestId
|
|
50944
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
50771
50945
|
*/
|
|
50772
50946
|
getWorkforcemanagementTimeoffrequest(timeOffRequestId) {
|
|
50773
50947
|
// verify the required parameter 'timeOffRequestId' is set
|
|
@@ -50792,7 +50966,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50792
50966
|
/**
|
|
50793
50967
|
* Get the daily waitlist positions of a time off request for the current user
|
|
50794
50968
|
*
|
|
50795
|
-
* @param {String} timeOffRequestId
|
|
50969
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
50796
50970
|
*/
|
|
50797
50971
|
getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId) {
|
|
50798
50972
|
// verify the required parameter 'timeOffRequestId' is set
|
|
@@ -51035,7 +51209,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51035
51209
|
/**
|
|
51036
51210
|
* Updates a time off limit object.
|
|
51037
51211
|
* Updates time off limit object properties, but not daily values.
|
|
51038
|
-
* @param {String} managementUnitId The
|
|
51212
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
51039
51213
|
* @param {String} timeOffLimitId The id of time off limit object to update
|
|
51040
51214
|
* @param {Object} opts Optional parameters
|
|
51041
51215
|
* @param {Object} opts.body body
|
|
@@ -51069,7 +51243,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51069
51243
|
/**
|
|
51070
51244
|
* Updates a time off plan
|
|
51071
51245
|
*
|
|
51072
|
-
* @param {String} managementUnitId The management unit
|
|
51246
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
51073
51247
|
* @param {String} timeOffPlanId The ID of the time off plan to update
|
|
51074
51248
|
* @param {Object} opts Optional parameters
|
|
51075
51249
|
* @param {Object} opts.body body
|
|
@@ -51103,7 +51277,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51103
51277
|
/**
|
|
51104
51278
|
* Update a time off request
|
|
51105
51279
|
*
|
|
51106
|
-
* @param {String} managementUnitId The
|
|
51280
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
51107
51281
|
* @param {String} userId The id of the user the requested time off request belongs to
|
|
51108
51282
|
* @param {String} timeOffRequestId The id of the time off request to update
|
|
51109
51283
|
* @param {Object} opts Optional parameters
|
|
@@ -51142,7 +51316,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51142
51316
|
/**
|
|
51143
51317
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
51144
51318
|
*
|
|
51145
|
-
* @param {String} managementUnitId The
|
|
51319
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
51146
51320
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51147
51321
|
* @param {Object} body body
|
|
51148
51322
|
* @param {String} tradeId The ID of the shift trade to update
|
|
@@ -51251,7 +51425,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51251
51425
|
/**
|
|
51252
51426
|
* Update a time off request for the current user
|
|
51253
51427
|
*
|
|
51254
|
-
* @param {String} timeOffRequestId
|
|
51428
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
51255
51429
|
* @param {Object} opts Optional parameters
|
|
51256
51430
|
* @param {Object} opts.body body
|
|
51257
51431
|
*/
|
|
@@ -51388,7 +51562,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51388
51562
|
/**
|
|
51389
51563
|
* Get intraday data for the given date for the requested planningGroupIds
|
|
51390
51564
|
*
|
|
51391
|
-
* @param {String} businessUnitId The
|
|
51565
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
51392
51566
|
* @param {Object} opts Optional parameters
|
|
51393
51567
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
51394
51568
|
* @param {Object} opts.body body
|
|
@@ -51821,7 +51995,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51821
51995
|
/**
|
|
51822
51996
|
* Copy a short term forecast
|
|
51823
51997
|
*
|
|
51824
|
-
* @param {String} businessUnitId The
|
|
51998
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51825
51999
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51826
52000
|
* @param {String} forecastId The ID of the forecast to copy
|
|
51827
52001
|
* @param {Object} body body
|
|
@@ -51865,7 +52039,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51865
52039
|
/**
|
|
51866
52040
|
* Generate a short term forecast
|
|
51867
52041
|
*
|
|
51868
|
-
* @param {String} businessUnitId The
|
|
52042
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51869
52043
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51870
52044
|
* @param {Object} body
|
|
51871
52045
|
* @param {Object} opts Optional parameters
|
|
@@ -51904,7 +52078,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51904
52078
|
/**
|
|
51905
52079
|
* Starts importing the uploaded short term forecast
|
|
51906
52080
|
* Call after uploading the forecast data to the url supplied by the /import/uploadurl route
|
|
51907
|
-
* @param {String} businessUnitId The
|
|
52081
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51908
52082
|
* @param {String} weekDateId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51909
52083
|
* @param {Object} body
|
|
51910
52084
|
*/
|
|
@@ -51939,7 +52113,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51939
52113
|
/**
|
|
51940
52114
|
* Creates a signed upload URL for importing a short term forecast
|
|
51941
52115
|
* Once the upload is complete, call the /import route to start the short term forecast import process
|
|
51942
|
-
* @param {String} businessUnitId The
|
|
52116
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51943
52117
|
* @param {String} weekDateId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51944
52118
|
* @param {Object} body body
|
|
51945
52119
|
*/
|
|
@@ -52066,7 +52240,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52066
52240
|
/**
|
|
52067
52241
|
* Query published schedules for given given time range for set of users
|
|
52068
52242
|
*
|
|
52069
|
-
* @param {String} managementUnitId The
|
|
52243
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52070
52244
|
* @param {Object} opts Optional parameters
|
|
52071
52245
|
* @param {Object} opts.body body
|
|
52072
52246
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
@@ -52097,7 +52271,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52097
52271
|
/**
|
|
52098
52272
|
* Request a historical adherence report
|
|
52099
52273
|
* The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
|
|
52100
|
-
* @param {String} managementUnitId The
|
|
52274
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
52101
52275
|
* @param {Object} opts Optional parameters
|
|
52102
52276
|
* @param {Object} opts.body body
|
|
52103
52277
|
*/
|
|
@@ -52155,7 +52329,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52155
52329
|
/**
|
|
52156
52330
|
* Query published schedules for given given time range for set of users
|
|
52157
52331
|
*
|
|
52158
|
-
* @param {String} managementUnitId The
|
|
52332
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52159
52333
|
* @param {Object} opts Optional parameters
|
|
52160
52334
|
* @param {Object} opts.body body
|
|
52161
52335
|
*/
|
|
@@ -52184,7 +52358,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52184
52358
|
/**
|
|
52185
52359
|
* Creates a new time off limit object under management unit.
|
|
52186
52360
|
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
52187
|
-
* @param {String} managementUnitId The
|
|
52361
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52188
52362
|
* @param {Object} opts Optional parameters
|
|
52189
52363
|
* @param {Object} opts.body body
|
|
52190
52364
|
*/
|
|
@@ -52213,7 +52387,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52213
52387
|
/**
|
|
52214
52388
|
* Retrieves time off limit related values based on a given set of filters.
|
|
52215
52389
|
*
|
|
52216
|
-
* @param {String} managementUnitId The
|
|
52390
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52217
52391
|
* @param {Object} opts Optional parameters
|
|
52218
52392
|
* @param {Object} opts.body body
|
|
52219
52393
|
*/
|
|
@@ -52242,7 +52416,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52242
52416
|
/**
|
|
52243
52417
|
* Creates a new time off plan
|
|
52244
52418
|
*
|
|
52245
|
-
* @param {String} managementUnitId The management unit
|
|
52419
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
52246
52420
|
* @param {Object} opts Optional parameters
|
|
52247
52421
|
* @param {Object} opts.body body
|
|
52248
52422
|
*/
|
|
@@ -52271,7 +52445,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52271
52445
|
/**
|
|
52272
52446
|
* Create a new time off request
|
|
52273
52447
|
*
|
|
52274
|
-
* @param {String} managementUnitId The
|
|
52448
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52275
52449
|
* @param {Object} opts Optional parameters
|
|
52276
52450
|
* @param {Object} opts.body body
|
|
52277
52451
|
*/
|
|
@@ -52300,7 +52474,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52300
52474
|
/**
|
|
52301
52475
|
* Fetches time off requests matching the conditions specified in the request body
|
|
52302
52476
|
* Request body requires one of the following: User ID is specified, statuses == [Pending] or date range to be specified and less than or equal to 33 days. All other fields are filters
|
|
52303
|
-
* @param {String} managementUnitId The
|
|
52477
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52304
52478
|
* @param {Object} opts Optional parameters
|
|
52305
52479
|
* @param {Object} opts.body body
|
|
52306
52480
|
*/
|
|
@@ -52329,7 +52503,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52329
52503
|
/**
|
|
52330
52504
|
* Retrieves daily waitlist position for a list of time off requests
|
|
52331
52505
|
*
|
|
52332
|
-
* @param {String} managementUnitId The
|
|
52506
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52333
52507
|
* @param {Object} opts Optional parameters
|
|
52334
52508
|
* @param {Object} opts.body body
|
|
52335
52509
|
*/
|
|
@@ -52358,7 +52532,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52358
52532
|
/**
|
|
52359
52533
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
52360
52534
|
*
|
|
52361
|
-
* @param {String} managementUnitId The
|
|
52535
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52362
52536
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
52363
52537
|
* @param {Object} body body
|
|
52364
52538
|
* @param {String} tradeId The ID of the shift trade to update
|
|
@@ -52398,7 +52572,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52398
52572
|
/**
|
|
52399
52573
|
* Adds a shift trade
|
|
52400
52574
|
*
|
|
52401
|
-
* @param {String} managementUnitId The
|
|
52575
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52402
52576
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
52403
52577
|
* @param {Object} body body
|
|
52404
52578
|
*/
|
|
@@ -52433,7 +52607,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52433
52607
|
/**
|
|
52434
52608
|
* Searches for potential shift trade matches for the current agent
|
|
52435
52609
|
*
|
|
52436
|
-
* @param {String} managementUnitId The
|
|
52610
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52437
52611
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
52438
52612
|
* @param {Object} body body
|
|
52439
52613
|
*/
|
|
@@ -52468,7 +52642,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52468
52642
|
/**
|
|
52469
52643
|
* Updates the state of a batch of shift trades
|
|
52470
52644
|
* Admin functionality is not supported with \"mine\".
|
|
52471
|
-
* @param {String} managementUnitId The
|
|
52645
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52472
52646
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
52473
52647
|
* @param {Object} body body
|
|
52474
52648
|
* @param {Object} opts Optional parameters
|
|
@@ -52789,7 +52963,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52789
52963
|
/**
|
|
52790
52964
|
* Sets daily values for a date range of time off limit object
|
|
52791
52965
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
52792
|
-
* @param {String} managementUnitId The
|
|
52966
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52793
52967
|
* @param {String} timeOffLimitId The ID of the time off limit object to set values for
|
|
52794
52968
|
* @param {Object} opts Optional parameters
|
|
52795
52969
|
* @param {Object} opts.body body
|
|
@@ -52851,7 +53025,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52851
53025
|
* </pre>
|
|
52852
53026
|
* </p>
|
|
52853
53027
|
* @module purecloud-platform-client-v2/index
|
|
52854
|
-
* @version
|
|
53028
|
+
* @version 136.0.0
|
|
52855
53029
|
*/
|
|
52856
53030
|
class platformClient {
|
|
52857
53031
|
constructor() {
|