purecloud-platform-client-v2 134.0.1 → 136.1.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 +637 -214
- package/dist/web-amd/purecloud-platform-client-v2.js +637 -214
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +637 -214
- package/dist/web-cjs/purecloud-platform-client-v2.js +647 -225
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +895 -425
- 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 +50 -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 +226 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -51
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +132 -5
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +69 -3
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +51 -51
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -395,7 +395,7 @@ class Configuration {
|
|
|
395
395
|
|
|
396
396
|
/**
|
|
397
397
|
* @module purecloud-platform-client-v2/ApiClient
|
|
398
|
-
* @version
|
|
398
|
+
* @version 136.1.0
|
|
399
399
|
*/
|
|
400
400
|
class ApiClient {
|
|
401
401
|
/**
|
|
@@ -1342,7 +1342,7 @@ class ApiClient {
|
|
|
1342
1342
|
|
|
1343
1343
|
// set header parameters
|
|
1344
1344
|
request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
|
|
1345
|
-
//request.set({ 'purecloud-sdk': '
|
|
1345
|
+
//request.set({ 'purecloud-sdk': '136.1.0' });
|
|
1346
1346
|
|
|
1347
1347
|
// set request timeout
|
|
1348
1348
|
request.timeout(that.timeout);
|
|
@@ -1442,7 +1442,7 @@ class AlertingApi {
|
|
|
1442
1442
|
/**
|
|
1443
1443
|
* Alerting service.
|
|
1444
1444
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1445
|
-
* @version
|
|
1445
|
+
* @version 136.1.0
|
|
1446
1446
|
*/
|
|
1447
1447
|
|
|
1448
1448
|
/**
|
|
@@ -1756,7 +1756,7 @@ class AnalyticsApi {
|
|
|
1756
1756
|
/**
|
|
1757
1757
|
* Analytics service.
|
|
1758
1758
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1759
|
-
* @version
|
|
1759
|
+
* @version 136.1.0
|
|
1760
1760
|
*/
|
|
1761
1761
|
|
|
1762
1762
|
/**
|
|
@@ -2938,7 +2938,7 @@ class ArchitectApi {
|
|
|
2938
2938
|
/**
|
|
2939
2939
|
* Architect service.
|
|
2940
2940
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2941
|
-
* @version
|
|
2941
|
+
* @version 136.1.0
|
|
2942
2942
|
*/
|
|
2943
2943
|
|
|
2944
2944
|
/**
|
|
@@ -4702,6 +4702,35 @@ class ArchitectApi {
|
|
|
4702
4702
|
);
|
|
4703
4703
|
}
|
|
4704
4704
|
|
|
4705
|
+
/**
|
|
4706
|
+
* Fetch Architect Job Status
|
|
4707
|
+
*
|
|
4708
|
+
* @param {String} jobId Job ID
|
|
4709
|
+
* @param {Object} opts Optional parameters
|
|
4710
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
4711
|
+
*/
|
|
4712
|
+
getFlowsJob(jobId, opts) {
|
|
4713
|
+
opts = opts || {};
|
|
4714
|
+
|
|
4715
|
+
// verify the required parameter 'jobId' is set
|
|
4716
|
+
if (jobId === undefined || jobId === null) {
|
|
4717
|
+
throw 'Missing the required parameter "jobId" when calling getFlowsJob';
|
|
4718
|
+
}
|
|
4719
|
+
|
|
4720
|
+
return this.apiClient.callApi(
|
|
4721
|
+
'/api/v2/flows/jobs/{jobId}',
|
|
4722
|
+
'GET',
|
|
4723
|
+
{ 'jobId': jobId },
|
|
4724
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
4725
|
+
{ },
|
|
4726
|
+
{ },
|
|
4727
|
+
null,
|
|
4728
|
+
['PureCloud OAuth'],
|
|
4729
|
+
['application/json'],
|
|
4730
|
+
['application/json']
|
|
4731
|
+
);
|
|
4732
|
+
}
|
|
4733
|
+
|
|
4705
4734
|
/**
|
|
4706
4735
|
* Get a flow milestone
|
|
4707
4736
|
* Returns a specified flow milestone
|
|
@@ -5504,6 +5533,26 @@ class ArchitectApi {
|
|
|
5504
5533
|
);
|
|
5505
5534
|
}
|
|
5506
5535
|
|
|
5536
|
+
/**
|
|
5537
|
+
* Register Architect Job. Returns a URL where a file, such as an Architect flow YAML file, can be PUT which will then initiate the job.
|
|
5538
|
+
*
|
|
5539
|
+
*/
|
|
5540
|
+
postFlowsJobs() {
|
|
5541
|
+
|
|
5542
|
+
return this.apiClient.callApi(
|
|
5543
|
+
'/api/v2/flows/jobs',
|
|
5544
|
+
'POST',
|
|
5545
|
+
{ },
|
|
5546
|
+
{ },
|
|
5547
|
+
{ },
|
|
5548
|
+
{ },
|
|
5549
|
+
null,
|
|
5550
|
+
['PureCloud OAuth'],
|
|
5551
|
+
['application/json'],
|
|
5552
|
+
['application/json']
|
|
5553
|
+
);
|
|
5554
|
+
}
|
|
5555
|
+
|
|
5507
5556
|
/**
|
|
5508
5557
|
* Create a flow milestone
|
|
5509
5558
|
*
|
|
@@ -5934,7 +5983,7 @@ class AuditApi {
|
|
|
5934
5983
|
/**
|
|
5935
5984
|
* Audit service.
|
|
5936
5985
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
5937
|
-
* @version
|
|
5986
|
+
* @version 136.1.0
|
|
5938
5987
|
*/
|
|
5939
5988
|
|
|
5940
5989
|
/**
|
|
@@ -6105,7 +6154,7 @@ class AuthorizationApi {
|
|
|
6105
6154
|
/**
|
|
6106
6155
|
* Authorization service.
|
|
6107
6156
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6108
|
-
* @version
|
|
6157
|
+
* @version 136.1.0
|
|
6109
6158
|
*/
|
|
6110
6159
|
|
|
6111
6160
|
/**
|
|
@@ -7288,7 +7337,7 @@ class BillingApi {
|
|
|
7288
7337
|
/**
|
|
7289
7338
|
* Billing service.
|
|
7290
7339
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7291
|
-
* @version
|
|
7340
|
+
* @version 136.1.0
|
|
7292
7341
|
*/
|
|
7293
7342
|
|
|
7294
7343
|
/**
|
|
@@ -7368,7 +7417,7 @@ class ChatApi {
|
|
|
7368
7417
|
/**
|
|
7369
7418
|
* Chat service.
|
|
7370
7419
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7371
|
-
* @version
|
|
7420
|
+
* @version 136.1.0
|
|
7372
7421
|
*/
|
|
7373
7422
|
|
|
7374
7423
|
/**
|
|
@@ -7459,7 +7508,7 @@ class CoachingApi {
|
|
|
7459
7508
|
/**
|
|
7460
7509
|
* Coaching service.
|
|
7461
7510
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7462
|
-
* @version
|
|
7511
|
+
* @version 136.1.0
|
|
7463
7512
|
*/
|
|
7464
7513
|
|
|
7465
7514
|
/**
|
|
@@ -8036,7 +8085,7 @@ class ContentManagementApi {
|
|
|
8036
8085
|
/**
|
|
8037
8086
|
* ContentManagement service.
|
|
8038
8087
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8039
|
-
* @version
|
|
8088
|
+
* @version 136.1.0
|
|
8040
8089
|
*/
|
|
8041
8090
|
|
|
8042
8091
|
/**
|
|
@@ -9176,7 +9225,7 @@ class ConversationsApi {
|
|
|
9176
9225
|
/**
|
|
9177
9226
|
* Conversations service.
|
|
9178
9227
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9179
|
-
* @version
|
|
9228
|
+
* @version 136.1.0
|
|
9180
9229
|
*/
|
|
9181
9230
|
|
|
9182
9231
|
/**
|
|
@@ -11081,7 +11130,7 @@ class ConversationsApi {
|
|
|
11081
11130
|
/**
|
|
11082
11131
|
* Get a list of Messaging Stickers
|
|
11083
11132
|
*
|
|
11084
|
-
* @param {
|
|
11133
|
+
* @param {Object} messengerType Messenger Type
|
|
11085
11134
|
* @param {Object} opts Optional parameters
|
|
11086
11135
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
11087
11136
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
@@ -11269,7 +11318,7 @@ class ConversationsApi {
|
|
|
11269
11318
|
}
|
|
11270
11319
|
|
|
11271
11320
|
/**
|
|
11272
|
-
* Update a conversation by setting
|
|
11321
|
+
* Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
11273
11322
|
*
|
|
11274
11323
|
* @param {String} conversationId conversationId
|
|
11275
11324
|
* @param {Object} body Conversation
|
|
@@ -12255,8 +12304,8 @@ class ConversationsApi {
|
|
|
12255
12304
|
}
|
|
12256
12305
|
|
|
12257
12306
|
/**
|
|
12258
|
-
* Update or activate a WhatsApp messaging integration
|
|
12259
|
-
* The following steps are required in order to fully activate a
|
|
12307
|
+
* Update or activate a WhatsApp messaging integration
|
|
12308
|
+
* The following steps are required in order to fully activate a WhatsApp Integration: Initially, you will need to get an activation code by sending: an action set to Activate, and an authenticationMethod choosing from Sms or Voice. Finally, once you have been informed of an activation code on selected authenticationMethod, you will need to confirm the code by sending: an action set to Confirm, and the confirmationCode you have received from Whatsapp.
|
|
12260
12309
|
* @param {String} integrationId Integration ID
|
|
12261
12310
|
* @param {Object} body WhatsAppIntegrationUpdateRequest
|
|
12262
12311
|
*/
|
|
@@ -13840,7 +13889,7 @@ class DataExtensionsApi {
|
|
|
13840
13889
|
/**
|
|
13841
13890
|
* DataExtensions service.
|
|
13842
13891
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
13843
|
-
* @version
|
|
13892
|
+
* @version 136.1.0
|
|
13844
13893
|
*/
|
|
13845
13894
|
|
|
13846
13895
|
/**
|
|
@@ -13926,7 +13975,7 @@ class ExternalContactsApi {
|
|
|
13926
13975
|
/**
|
|
13927
13976
|
* ExternalContacts service.
|
|
13928
13977
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
13929
|
-
* @version
|
|
13978
|
+
* @version 136.1.0
|
|
13930
13979
|
*/
|
|
13931
13980
|
|
|
13932
13981
|
/**
|
|
@@ -15669,7 +15718,7 @@ class FaxApi {
|
|
|
15669
15718
|
/**
|
|
15670
15719
|
* Fax service.
|
|
15671
15720
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
15672
|
-
* @version
|
|
15721
|
+
* @version 136.1.0
|
|
15673
15722
|
*/
|
|
15674
15723
|
|
|
15675
15724
|
/**
|
|
@@ -15840,7 +15889,7 @@ class FlowsApi {
|
|
|
15840
15889
|
/**
|
|
15841
15890
|
* Flows service.
|
|
15842
15891
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
15843
|
-
* @version
|
|
15892
|
+
* @version 136.1.0
|
|
15844
15893
|
*/
|
|
15845
15894
|
|
|
15846
15895
|
/**
|
|
@@ -15911,7 +15960,7 @@ class GamificationApi {
|
|
|
15911
15960
|
/**
|
|
15912
15961
|
* Gamification service.
|
|
15913
15962
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
15914
|
-
* @version
|
|
15963
|
+
* @version 136.1.0
|
|
15915
15964
|
*/
|
|
15916
15965
|
|
|
15917
15966
|
/**
|
|
@@ -16157,18 +16206,18 @@ class GamificationApi {
|
|
|
16157
16206
|
/**
|
|
16158
16207
|
* Performance profile by id
|
|
16159
16208
|
*
|
|
16160
|
-
* @param {String} performanceProfileId
|
|
16209
|
+
* @param {String} profileId performanceProfileId
|
|
16161
16210
|
*/
|
|
16162
|
-
getGamificationProfile(
|
|
16163
|
-
// verify the required parameter '
|
|
16164
|
-
if (
|
|
16165
|
-
throw 'Missing the required parameter "
|
|
16211
|
+
getGamificationProfile(profileId) {
|
|
16212
|
+
// verify the required parameter 'profileId' is set
|
|
16213
|
+
if (profileId === undefined || profileId === null) {
|
|
16214
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationProfile';
|
|
16166
16215
|
}
|
|
16167
16216
|
|
|
16168
16217
|
return this.apiClient.callApi(
|
|
16169
|
-
'/api/v2/gamification/profiles/{
|
|
16218
|
+
'/api/v2/gamification/profiles/{profileId}',
|
|
16170
16219
|
'GET',
|
|
16171
|
-
{ '
|
|
16220
|
+
{ 'profileId': profileId },
|
|
16172
16221
|
{ },
|
|
16173
16222
|
{ },
|
|
16174
16223
|
{ },
|
|
@@ -17011,18 +17060,18 @@ class GamificationApi {
|
|
|
17011
17060
|
/**
|
|
17012
17061
|
* Activate a performance profile
|
|
17013
17062
|
*
|
|
17014
|
-
* @param {String} performanceProfileId
|
|
17063
|
+
* @param {String} profileId performanceProfileId
|
|
17015
17064
|
*/
|
|
17016
|
-
postGamificationProfileActivate(
|
|
17017
|
-
// verify the required parameter '
|
|
17018
|
-
if (
|
|
17019
|
-
throw 'Missing the required parameter "
|
|
17065
|
+
postGamificationProfileActivate(profileId) {
|
|
17066
|
+
// verify the required parameter 'profileId' is set
|
|
17067
|
+
if (profileId === undefined || profileId === null) {
|
|
17068
|
+
throw 'Missing the required parameter "profileId" when calling postGamificationProfileActivate';
|
|
17020
17069
|
}
|
|
17021
17070
|
|
|
17022
17071
|
return this.apiClient.callApi(
|
|
17023
|
-
'/api/v2/gamification/profiles/{
|
|
17072
|
+
'/api/v2/gamification/profiles/{profileId}/activate',
|
|
17024
17073
|
'POST',
|
|
17025
|
-
{ '
|
|
17074
|
+
{ 'profileId': profileId },
|
|
17026
17075
|
{ },
|
|
17027
17076
|
{ },
|
|
17028
17077
|
{ },
|
|
@@ -17036,18 +17085,18 @@ class GamificationApi {
|
|
|
17036
17085
|
/**
|
|
17037
17086
|
* Deactivate a performance profile
|
|
17038
17087
|
*
|
|
17039
|
-
* @param {String} performanceProfileId
|
|
17088
|
+
* @param {String} profileId performanceProfileId
|
|
17040
17089
|
*/
|
|
17041
|
-
postGamificationProfileDeactivate(
|
|
17042
|
-
// verify the required parameter '
|
|
17043
|
-
if (
|
|
17044
|
-
throw 'Missing the required parameter "
|
|
17090
|
+
postGamificationProfileDeactivate(profileId) {
|
|
17091
|
+
// verify the required parameter 'profileId' is set
|
|
17092
|
+
if (profileId === undefined || profileId === null) {
|
|
17093
|
+
throw 'Missing the required parameter "profileId" when calling postGamificationProfileDeactivate';
|
|
17045
17094
|
}
|
|
17046
17095
|
|
|
17047
17096
|
return this.apiClient.callApi(
|
|
17048
|
-
'/api/v2/gamification/profiles/{
|
|
17097
|
+
'/api/v2/gamification/profiles/{profileId}/deactivate',
|
|
17049
17098
|
'POST',
|
|
17050
|
-
{ '
|
|
17099
|
+
{ 'profileId': profileId },
|
|
17051
17100
|
{ },
|
|
17052
17101
|
{ },
|
|
17053
17102
|
{ },
|
|
@@ -17249,22 +17298,22 @@ class GamificationApi {
|
|
|
17249
17298
|
/**
|
|
17250
17299
|
* Updates a performance profile
|
|
17251
17300
|
*
|
|
17252
|
-
* @param {String} performanceProfileId
|
|
17301
|
+
* @param {String} profileId performanceProfileId
|
|
17253
17302
|
* @param {Object} opts Optional parameters
|
|
17254
17303
|
* @param {Object} opts.body performanceProfile
|
|
17255
17304
|
*/
|
|
17256
|
-
putGamificationProfile(
|
|
17305
|
+
putGamificationProfile(profileId, opts) {
|
|
17257
17306
|
opts = opts || {};
|
|
17258
17307
|
|
|
17259
|
-
// verify the required parameter '
|
|
17260
|
-
if (
|
|
17261
|
-
throw 'Missing the required parameter "
|
|
17308
|
+
// verify the required parameter 'profileId' is set
|
|
17309
|
+
if (profileId === undefined || profileId === null) {
|
|
17310
|
+
throw 'Missing the required parameter "profileId" when calling putGamificationProfile';
|
|
17262
17311
|
}
|
|
17263
17312
|
|
|
17264
17313
|
return this.apiClient.callApi(
|
|
17265
|
-
'/api/v2/gamification/profiles/{
|
|
17314
|
+
'/api/v2/gamification/profiles/{profileId}',
|
|
17266
17315
|
'PUT',
|
|
17267
|
-
{ '
|
|
17316
|
+
{ 'profileId': profileId },
|
|
17268
17317
|
{ },
|
|
17269
17318
|
{ },
|
|
17270
17319
|
{ },
|
|
@@ -17341,7 +17390,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
17341
17390
|
/**
|
|
17342
17391
|
* GeneralDataProtectionRegulation service.
|
|
17343
17392
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
17344
|
-
* @version
|
|
17393
|
+
* @version 136.1.0
|
|
17345
17394
|
*/
|
|
17346
17395
|
|
|
17347
17396
|
/**
|
|
@@ -17471,7 +17520,7 @@ class GeolocationApi {
|
|
|
17471
17520
|
/**
|
|
17472
17521
|
* Geolocation service.
|
|
17473
17522
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
17474
|
-
* @version
|
|
17523
|
+
* @version 136.1.0
|
|
17475
17524
|
*/
|
|
17476
17525
|
|
|
17477
17526
|
/**
|
|
@@ -17602,7 +17651,7 @@ class GreetingsApi {
|
|
|
17602
17651
|
/**
|
|
17603
17652
|
* Greetings service.
|
|
17604
17653
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
17605
|
-
* @version
|
|
17654
|
+
* @version 136.1.0
|
|
17606
17655
|
*/
|
|
17607
17656
|
|
|
17608
17657
|
/**
|
|
@@ -18057,7 +18106,7 @@ class GroupsApi {
|
|
|
18057
18106
|
/**
|
|
18058
18107
|
* Groups service.
|
|
18059
18108
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
18060
|
-
* @version
|
|
18109
|
+
* @version 136.1.0
|
|
18061
18110
|
*/
|
|
18062
18111
|
|
|
18063
18112
|
/**
|
|
@@ -18462,7 +18511,7 @@ class IdentityProviderApi {
|
|
|
18462
18511
|
/**
|
|
18463
18512
|
* IdentityProvider service.
|
|
18464
18513
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
18465
|
-
* @version
|
|
18514
|
+
* @version 136.1.0
|
|
18466
18515
|
*/
|
|
18467
18516
|
|
|
18468
18517
|
/**
|
|
@@ -19218,7 +19267,7 @@ class IntegrationsApi {
|
|
|
19218
19267
|
/**
|
|
19219
19268
|
* Integrations service.
|
|
19220
19269
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
19221
|
-
* @version
|
|
19270
|
+
* @version 136.1.0
|
|
19222
19271
|
*/
|
|
19223
19272
|
|
|
19224
19273
|
/**
|
|
@@ -19636,9 +19685,10 @@ class IntegrationsApi {
|
|
|
19636
19685
|
* @param {String} opts.previousPage Previous page token
|
|
19637
19686
|
* @param {String} opts.sortBy Root level field name to sort on.
|
|
19638
19687
|
* @param {Object} opts.sortOrder Direction to sort 'sortBy' field. (default to asc)
|
|
19639
|
-
* @param {String} opts.category Filter by category name
|
|
19640
|
-
* @param {String} opts.name Filter by
|
|
19641
|
-
* @param {
|
|
19688
|
+
* @param {String} opts.category Filter by category name.
|
|
19689
|
+
* @param {String} opts.name Filter by partial or complete action name.
|
|
19690
|
+
* @param {String} opts.ids Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids.
|
|
19691
|
+
* @param {Object} opts.secure Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions.
|
|
19642
19692
|
* @param {Object} opts.includeAuthActions Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. (default to false)
|
|
19643
19693
|
*/
|
|
19644
19694
|
getIntegrationsActions(opts) {
|
|
@@ -19649,7 +19699,7 @@ class IntegrationsApi {
|
|
|
19649
19699
|
'/api/v2/integrations/actions',
|
|
19650
19700
|
'GET',
|
|
19651
19701
|
{ },
|
|
19652
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'category': opts['category'],'name': opts['name'],'secure': opts['secure'],'includeAuthActions': opts['includeAuthActions'] },
|
|
19702
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'category': opts['category'],'name': opts['name'],'ids': opts['ids'],'secure': opts['secure'],'includeAuthActions': opts['includeAuthActions'] },
|
|
19653
19703
|
{ },
|
|
19654
19704
|
{ },
|
|
19655
19705
|
null,
|
|
@@ -19699,9 +19749,10 @@ class IntegrationsApi {
|
|
|
19699
19749
|
* @param {String} opts.previousPage Previous page token
|
|
19700
19750
|
* @param {String} opts.sortBy Root level field name to sort on.
|
|
19701
19751
|
* @param {Object} opts.sortOrder Direction to sort 'sortBy' field. (default to asc)
|
|
19702
|
-
* @param {String} opts.category Filter by category name
|
|
19703
|
-
* @param {String} opts.name Filter by
|
|
19704
|
-
* @param {
|
|
19752
|
+
* @param {String} opts.category Filter by category name.
|
|
19753
|
+
* @param {String} opts.name Filter by partial or complete action name.
|
|
19754
|
+
* @param {String} opts.ids Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids.
|
|
19755
|
+
* @param {Object} opts.secure Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions.
|
|
19705
19756
|
* @param {Object} opts.includeAuthActions Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. (default to false)
|
|
19706
19757
|
*/
|
|
19707
19758
|
getIntegrationsActionsDrafts(opts) {
|
|
@@ -19712,7 +19763,7 @@ class IntegrationsApi {
|
|
|
19712
19763
|
'/api/v2/integrations/actions/drafts',
|
|
19713
19764
|
'GET',
|
|
19714
19765
|
{ },
|
|
19715
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'category': opts['category'],'name': opts['name'],'secure': opts['secure'],'includeAuthActions': opts['includeAuthActions'] },
|
|
19766
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'category': opts['category'],'name': opts['name'],'ids': opts['ids'],'secure': opts['secure'],'includeAuthActions': opts['includeAuthActions'] },
|
|
19716
19767
|
{ },
|
|
19717
19768
|
{ },
|
|
19718
19769
|
null,
|
|
@@ -20893,7 +20944,7 @@ class JourneyApi {
|
|
|
20893
20944
|
/**
|
|
20894
20945
|
* Journey service.
|
|
20895
20946
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
20896
|
-
* @version
|
|
20947
|
+
* @version 136.1.0
|
|
20897
20948
|
*/
|
|
20898
20949
|
|
|
20899
20950
|
/**
|
|
@@ -21604,7 +21655,7 @@ class KnowledgeApi {
|
|
|
21604
21655
|
/**
|
|
21605
21656
|
* Knowledge service.
|
|
21606
21657
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
21607
|
-
* @version
|
|
21658
|
+
* @version 136.1.0
|
|
21608
21659
|
*/
|
|
21609
21660
|
|
|
21610
21661
|
/**
|
|
@@ -22504,7 +22555,7 @@ class LanguageUnderstandingApi {
|
|
|
22504
22555
|
/**
|
|
22505
22556
|
* LanguageUnderstanding service.
|
|
22506
22557
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
22507
|
-
* @version
|
|
22558
|
+
* @version 136.1.0
|
|
22508
22559
|
*/
|
|
22509
22560
|
|
|
22510
22561
|
/**
|
|
@@ -23408,7 +23459,7 @@ class LanguagesApi {
|
|
|
23408
23459
|
/**
|
|
23409
23460
|
* Languages service.
|
|
23410
23461
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
23411
|
-
* @version
|
|
23462
|
+
* @version 136.1.0
|
|
23412
23463
|
*/
|
|
23413
23464
|
|
|
23414
23465
|
/**
|
|
@@ -23676,7 +23727,7 @@ class LearningApi {
|
|
|
23676
23727
|
/**
|
|
23677
23728
|
* Learning service.
|
|
23678
23729
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
23679
|
-
* @version
|
|
23730
|
+
* @version 136.1.0
|
|
23680
23731
|
*/
|
|
23681
23732
|
|
|
23682
23733
|
/**
|
|
@@ -24267,7 +24318,7 @@ class LicenseApi {
|
|
|
24267
24318
|
/**
|
|
24268
24319
|
* License service.
|
|
24269
24320
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
24270
|
-
* @version
|
|
24321
|
+
* @version 136.1.0
|
|
24271
24322
|
*/
|
|
24272
24323
|
|
|
24273
24324
|
/**
|
|
@@ -24505,7 +24556,7 @@ class LocationsApi {
|
|
|
24505
24556
|
/**
|
|
24506
24557
|
* Locations service.
|
|
24507
24558
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
24508
|
-
* @version
|
|
24559
|
+
* @version 136.1.0
|
|
24509
24560
|
*/
|
|
24510
24561
|
|
|
24511
24562
|
/**
|
|
@@ -24741,7 +24792,7 @@ class MessagingApi {
|
|
|
24741
24792
|
/**
|
|
24742
24793
|
* Messaging service.
|
|
24743
24794
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
24744
|
-
* @version
|
|
24795
|
+
* @version 136.1.0
|
|
24745
24796
|
*/
|
|
24746
24797
|
|
|
24747
24798
|
/**
|
|
@@ -24892,7 +24943,7 @@ class MobileDevicesApi {
|
|
|
24892
24943
|
/**
|
|
24893
24944
|
* MobileDevices service.
|
|
24894
24945
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
24895
|
-
* @version
|
|
24946
|
+
* @version 136.1.0
|
|
24896
24947
|
*/
|
|
24897
24948
|
|
|
24898
24949
|
/**
|
|
@@ -25043,7 +25094,7 @@ class NotificationsApi {
|
|
|
25043
25094
|
/**
|
|
25044
25095
|
* Notifications service.
|
|
25045
25096
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
25046
|
-
* @version
|
|
25097
|
+
* @version 136.1.0
|
|
25047
25098
|
*/
|
|
25048
25099
|
|
|
25049
25100
|
/**
|
|
@@ -25268,7 +25319,7 @@ class OAuthApi {
|
|
|
25268
25319
|
/**
|
|
25269
25320
|
* OAuth service.
|
|
25270
25321
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
25271
|
-
* @version
|
|
25322
|
+
* @version 136.1.0
|
|
25272
25323
|
*/
|
|
25273
25324
|
|
|
25274
25325
|
/**
|
|
@@ -25634,7 +25685,7 @@ class ObjectsApi {
|
|
|
25634
25685
|
/**
|
|
25635
25686
|
* Objects service.
|
|
25636
25687
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
25637
|
-
* @version
|
|
25688
|
+
* @version 136.1.0
|
|
25638
25689
|
*/
|
|
25639
25690
|
|
|
25640
25691
|
/**
|
|
@@ -25905,7 +25956,7 @@ class OrganizationApi {
|
|
|
25905
25956
|
/**
|
|
25906
25957
|
* Organization service.
|
|
25907
25958
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
25908
|
-
* @version
|
|
25959
|
+
* @version 136.1.0
|
|
25909
25960
|
*/
|
|
25910
25961
|
|
|
25911
25962
|
/**
|
|
@@ -26308,7 +26359,7 @@ class OrganizationAuthorizationApi {
|
|
|
26308
26359
|
/**
|
|
26309
26360
|
* OrganizationAuthorization service.
|
|
26310
26361
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
26311
|
-
* @version
|
|
26362
|
+
* @version 136.1.0
|
|
26312
26363
|
*/
|
|
26313
26364
|
|
|
26314
26365
|
/**
|
|
@@ -27233,7 +27284,7 @@ class OutboundApi {
|
|
|
27233
27284
|
/**
|
|
27234
27285
|
* Outbound service.
|
|
27235
27286
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
27236
|
-
* @version
|
|
27287
|
+
* @version 136.1.0
|
|
27237
27288
|
*/
|
|
27238
27289
|
|
|
27239
27290
|
/**
|
|
@@ -27583,6 +27634,31 @@ class OutboundApi {
|
|
|
27583
27634
|
);
|
|
27584
27635
|
}
|
|
27585
27636
|
|
|
27637
|
+
/**
|
|
27638
|
+
* Reset messaging campaign progress and recycle the messaging campaign
|
|
27639
|
+
*
|
|
27640
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
27641
|
+
*/
|
|
27642
|
+
deleteOutboundMessagingcampaignProgress(messagingCampaignId) {
|
|
27643
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
27644
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
27645
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling deleteOutboundMessagingcampaignProgress';
|
|
27646
|
+
}
|
|
27647
|
+
|
|
27648
|
+
return this.apiClient.callApi(
|
|
27649
|
+
'/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress',
|
|
27650
|
+
'DELETE',
|
|
27651
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
27652
|
+
{ },
|
|
27653
|
+
{ },
|
|
27654
|
+
{ },
|
|
27655
|
+
null,
|
|
27656
|
+
['PureCloud OAuth'],
|
|
27657
|
+
['application/json'],
|
|
27658
|
+
['application/json']
|
|
27659
|
+
);
|
|
27660
|
+
}
|
|
27661
|
+
|
|
27586
27662
|
/**
|
|
27587
27663
|
* Delete a Rule Set.
|
|
27588
27664
|
*
|
|
@@ -27633,6 +27709,56 @@ class OutboundApi {
|
|
|
27633
27709
|
);
|
|
27634
27710
|
}
|
|
27635
27711
|
|
|
27712
|
+
/**
|
|
27713
|
+
* Delete an email campaign schedule.
|
|
27714
|
+
*
|
|
27715
|
+
* @param {String} emailCampaignId Email Campaign ID
|
|
27716
|
+
*/
|
|
27717
|
+
deleteOutboundSchedulesEmailcampaign(emailCampaignId) {
|
|
27718
|
+
// verify the required parameter 'emailCampaignId' is set
|
|
27719
|
+
if (emailCampaignId === undefined || emailCampaignId === null) {
|
|
27720
|
+
throw 'Missing the required parameter "emailCampaignId" when calling deleteOutboundSchedulesEmailcampaign';
|
|
27721
|
+
}
|
|
27722
|
+
|
|
27723
|
+
return this.apiClient.callApi(
|
|
27724
|
+
'/api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}',
|
|
27725
|
+
'DELETE',
|
|
27726
|
+
{ 'emailCampaignId': emailCampaignId },
|
|
27727
|
+
{ },
|
|
27728
|
+
{ },
|
|
27729
|
+
{ },
|
|
27730
|
+
null,
|
|
27731
|
+
['PureCloud OAuth'],
|
|
27732
|
+
['application/json'],
|
|
27733
|
+
['application/json']
|
|
27734
|
+
);
|
|
27735
|
+
}
|
|
27736
|
+
|
|
27737
|
+
/**
|
|
27738
|
+
* Delete a messaging campaign schedule.
|
|
27739
|
+
*
|
|
27740
|
+
* @param {String} messagingCampaignId Messaging Campaign ID
|
|
27741
|
+
*/
|
|
27742
|
+
deleteOutboundSchedulesMessagingcampaign(messagingCampaignId) {
|
|
27743
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
27744
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
27745
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling deleteOutboundSchedulesMessagingcampaign';
|
|
27746
|
+
}
|
|
27747
|
+
|
|
27748
|
+
return this.apiClient.callApi(
|
|
27749
|
+
'/api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}',
|
|
27750
|
+
'DELETE',
|
|
27751
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
27752
|
+
{ },
|
|
27753
|
+
{ },
|
|
27754
|
+
{ },
|
|
27755
|
+
null,
|
|
27756
|
+
['PureCloud OAuth'],
|
|
27757
|
+
['application/json'],
|
|
27758
|
+
['application/json']
|
|
27759
|
+
);
|
|
27760
|
+
}
|
|
27761
|
+
|
|
27636
27762
|
/**
|
|
27637
27763
|
* Delete a dialer sequence schedule.
|
|
27638
27764
|
*
|
|
@@ -28969,6 +29095,96 @@ class OutboundApi {
|
|
|
28969
29095
|
);
|
|
28970
29096
|
}
|
|
28971
29097
|
|
|
29098
|
+
/**
|
|
29099
|
+
* Get an email campaign schedule.
|
|
29100
|
+
*
|
|
29101
|
+
* @param {String} emailCampaignId Email Campaign ID
|
|
29102
|
+
*/
|
|
29103
|
+
getOutboundSchedulesEmailcampaign(emailCampaignId) {
|
|
29104
|
+
// verify the required parameter 'emailCampaignId' is set
|
|
29105
|
+
if (emailCampaignId === undefined || emailCampaignId === null) {
|
|
29106
|
+
throw 'Missing the required parameter "emailCampaignId" when calling getOutboundSchedulesEmailcampaign';
|
|
29107
|
+
}
|
|
29108
|
+
|
|
29109
|
+
return this.apiClient.callApi(
|
|
29110
|
+
'/api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}',
|
|
29111
|
+
'GET',
|
|
29112
|
+
{ 'emailCampaignId': emailCampaignId },
|
|
29113
|
+
{ },
|
|
29114
|
+
{ },
|
|
29115
|
+
{ },
|
|
29116
|
+
null,
|
|
29117
|
+
['PureCloud OAuth'],
|
|
29118
|
+
['application/json'],
|
|
29119
|
+
['application/json']
|
|
29120
|
+
);
|
|
29121
|
+
}
|
|
29122
|
+
|
|
29123
|
+
/**
|
|
29124
|
+
* Query for a list of email campaign schedules.
|
|
29125
|
+
*
|
|
29126
|
+
*/
|
|
29127
|
+
getOutboundSchedulesEmailcampaigns() {
|
|
29128
|
+
|
|
29129
|
+
return this.apiClient.callApi(
|
|
29130
|
+
'/api/v2/outbound/schedules/emailcampaigns',
|
|
29131
|
+
'GET',
|
|
29132
|
+
{ },
|
|
29133
|
+
{ },
|
|
29134
|
+
{ },
|
|
29135
|
+
{ },
|
|
29136
|
+
null,
|
|
29137
|
+
['PureCloud OAuth'],
|
|
29138
|
+
['application/json'],
|
|
29139
|
+
['application/json']
|
|
29140
|
+
);
|
|
29141
|
+
}
|
|
29142
|
+
|
|
29143
|
+
/**
|
|
29144
|
+
* Get a messaging campaign schedule.
|
|
29145
|
+
*
|
|
29146
|
+
* @param {String} messagingCampaignId Messaging Campaign ID
|
|
29147
|
+
*/
|
|
29148
|
+
getOutboundSchedulesMessagingcampaign(messagingCampaignId) {
|
|
29149
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
29150
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
29151
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling getOutboundSchedulesMessagingcampaign';
|
|
29152
|
+
}
|
|
29153
|
+
|
|
29154
|
+
return this.apiClient.callApi(
|
|
29155
|
+
'/api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}',
|
|
29156
|
+
'GET',
|
|
29157
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
29158
|
+
{ },
|
|
29159
|
+
{ },
|
|
29160
|
+
{ },
|
|
29161
|
+
null,
|
|
29162
|
+
['PureCloud OAuth'],
|
|
29163
|
+
['application/json'],
|
|
29164
|
+
['application/json']
|
|
29165
|
+
);
|
|
29166
|
+
}
|
|
29167
|
+
|
|
29168
|
+
/**
|
|
29169
|
+
* Query for a list of messaging campaign schedules.
|
|
29170
|
+
*
|
|
29171
|
+
*/
|
|
29172
|
+
getOutboundSchedulesMessagingcampaigns() {
|
|
29173
|
+
|
|
29174
|
+
return this.apiClient.callApi(
|
|
29175
|
+
'/api/v2/outbound/schedules/messagingcampaigns',
|
|
29176
|
+
'GET',
|
|
29177
|
+
{ },
|
|
29178
|
+
{ },
|
|
29179
|
+
{ },
|
|
29180
|
+
{ },
|
|
29181
|
+
null,
|
|
29182
|
+
['PureCloud OAuth'],
|
|
29183
|
+
['application/json'],
|
|
29184
|
+
['application/json']
|
|
29185
|
+
);
|
|
29186
|
+
}
|
|
29187
|
+
|
|
28972
29188
|
/**
|
|
28973
29189
|
* Get a dialer sequence schedule.
|
|
28974
29190
|
*
|
|
@@ -30172,6 +30388,66 @@ class OutboundApi {
|
|
|
30172
30388
|
);
|
|
30173
30389
|
}
|
|
30174
30390
|
|
|
30391
|
+
/**
|
|
30392
|
+
* Update an email campaign schedule.
|
|
30393
|
+
*
|
|
30394
|
+
* @param {String} emailCampaignId Email Campaign ID
|
|
30395
|
+
* @param {Object} body EmailCampaignSchedule
|
|
30396
|
+
*/
|
|
30397
|
+
putOutboundSchedulesEmailcampaign(emailCampaignId, body) {
|
|
30398
|
+
// verify the required parameter 'emailCampaignId' is set
|
|
30399
|
+
if (emailCampaignId === undefined || emailCampaignId === null) {
|
|
30400
|
+
throw 'Missing the required parameter "emailCampaignId" when calling putOutboundSchedulesEmailcampaign';
|
|
30401
|
+
}
|
|
30402
|
+
// verify the required parameter 'body' is set
|
|
30403
|
+
if (body === undefined || body === null) {
|
|
30404
|
+
throw 'Missing the required parameter "body" when calling putOutboundSchedulesEmailcampaign';
|
|
30405
|
+
}
|
|
30406
|
+
|
|
30407
|
+
return this.apiClient.callApi(
|
|
30408
|
+
'/api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}',
|
|
30409
|
+
'PUT',
|
|
30410
|
+
{ 'emailCampaignId': emailCampaignId },
|
|
30411
|
+
{ },
|
|
30412
|
+
{ },
|
|
30413
|
+
{ },
|
|
30414
|
+
body,
|
|
30415
|
+
['PureCloud OAuth'],
|
|
30416
|
+
['application/json'],
|
|
30417
|
+
['application/json']
|
|
30418
|
+
);
|
|
30419
|
+
}
|
|
30420
|
+
|
|
30421
|
+
/**
|
|
30422
|
+
* Update a new messaging campaign schedule.
|
|
30423
|
+
*
|
|
30424
|
+
* @param {String} messagingCampaignId Messaging Campaign ID
|
|
30425
|
+
* @param {Object} body MessagingCampaignSchedule
|
|
30426
|
+
*/
|
|
30427
|
+
putOutboundSchedulesMessagingcampaign(messagingCampaignId, body) {
|
|
30428
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
30429
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
30430
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling putOutboundSchedulesMessagingcampaign';
|
|
30431
|
+
}
|
|
30432
|
+
// verify the required parameter 'body' is set
|
|
30433
|
+
if (body === undefined || body === null) {
|
|
30434
|
+
throw 'Missing the required parameter "body" when calling putOutboundSchedulesMessagingcampaign';
|
|
30435
|
+
}
|
|
30436
|
+
|
|
30437
|
+
return this.apiClient.callApi(
|
|
30438
|
+
'/api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}',
|
|
30439
|
+
'PUT',
|
|
30440
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
30441
|
+
{ },
|
|
30442
|
+
{ },
|
|
30443
|
+
{ },
|
|
30444
|
+
body,
|
|
30445
|
+
['PureCloud OAuth'],
|
|
30446
|
+
['application/json'],
|
|
30447
|
+
['application/json']
|
|
30448
|
+
);
|
|
30449
|
+
}
|
|
30450
|
+
|
|
30175
30451
|
/**
|
|
30176
30452
|
* Update a new sequence schedule.
|
|
30177
30453
|
*
|
|
@@ -30263,7 +30539,7 @@ class PresenceApi {
|
|
|
30263
30539
|
/**
|
|
30264
30540
|
* Presence service.
|
|
30265
30541
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
30266
|
-
* @version
|
|
30542
|
+
* @version 136.1.0
|
|
30267
30543
|
*/
|
|
30268
30544
|
|
|
30269
30545
|
/**
|
|
@@ -30409,31 +30685,6 @@ class PresenceApi {
|
|
|
30409
30685
|
);
|
|
30410
30686
|
}
|
|
30411
30687
|
|
|
30412
|
-
/**
|
|
30413
|
-
* Get a user's Microsoft Teams presence.
|
|
30414
|
-
* Gets the presence for a Microsoft Teams user. This will return the Microsoft Teams presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.
|
|
30415
|
-
* @param {String} userId user Id
|
|
30416
|
-
*/
|
|
30417
|
-
getUserPresencesMicrosoftteams(userId) {
|
|
30418
|
-
// verify the required parameter 'userId' is set
|
|
30419
|
-
if (userId === undefined || userId === null) {
|
|
30420
|
-
throw 'Missing the required parameter "userId" when calling getUserPresencesMicrosoftteams';
|
|
30421
|
-
}
|
|
30422
|
-
|
|
30423
|
-
return this.apiClient.callApi(
|
|
30424
|
-
'/api/v2/users/{userId}/presences/microsoftteams',
|
|
30425
|
-
'GET',
|
|
30426
|
-
{ 'userId': userId },
|
|
30427
|
-
{ },
|
|
30428
|
-
{ },
|
|
30429
|
-
{ },
|
|
30430
|
-
null,
|
|
30431
|
-
['PureCloud OAuth'],
|
|
30432
|
-
['application/json'],
|
|
30433
|
-
['application/json']
|
|
30434
|
-
);
|
|
30435
|
-
}
|
|
30436
|
-
|
|
30437
30688
|
/**
|
|
30438
30689
|
* Get a user's Genesys Cloud presence.
|
|
30439
30690
|
* Get the default Genesys Cloud user presence source PURECLOUD
|
|
@@ -30459,31 +30710,6 @@ class PresenceApi {
|
|
|
30459
30710
|
);
|
|
30460
30711
|
}
|
|
30461
30712
|
|
|
30462
|
-
/**
|
|
30463
|
-
* Get a user's Zoom Phone presence.
|
|
30464
|
-
* Gets the presence for a Zoom user. This will return the Zoom Phone presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.
|
|
30465
|
-
* @param {String} userId user Id
|
|
30466
|
-
*/
|
|
30467
|
-
getUserPresencesZoomphone(userId) {
|
|
30468
|
-
// verify the required parameter 'userId' is set
|
|
30469
|
-
if (userId === undefined || userId === null) {
|
|
30470
|
-
throw 'Missing the required parameter "userId" when calling getUserPresencesZoomphone';
|
|
30471
|
-
}
|
|
30472
|
-
|
|
30473
|
-
return this.apiClient.callApi(
|
|
30474
|
-
'/api/v2/users/{userId}/presences/zoomphone',
|
|
30475
|
-
'GET',
|
|
30476
|
-
{ 'userId': userId },
|
|
30477
|
-
{ },
|
|
30478
|
-
{ },
|
|
30479
|
-
{ },
|
|
30480
|
-
null,
|
|
30481
|
-
['PureCloud OAuth'],
|
|
30482
|
-
['application/json'],
|
|
30483
|
-
['application/json']
|
|
30484
|
-
);
|
|
30485
|
-
}
|
|
30486
|
-
|
|
30487
30713
|
/**
|
|
30488
30714
|
* Patch a user's Presence
|
|
30489
30715
|
* Patch a user's presence for the specified source that is not specifically listed. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
|
|
@@ -30635,7 +30861,7 @@ class QualityApi {
|
|
|
30635
30861
|
/**
|
|
30636
30862
|
* Quality service.
|
|
30637
30863
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
30638
|
-
* @version
|
|
30864
|
+
* @version 136.1.0
|
|
30639
30865
|
*/
|
|
30640
30866
|
|
|
30641
30867
|
/**
|
|
@@ -32213,7 +32439,7 @@ class RecordingApi {
|
|
|
32213
32439
|
/**
|
|
32214
32440
|
* Recording service.
|
|
32215
32441
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
32216
|
-
* @version
|
|
32442
|
+
* @version 136.1.0
|
|
32217
32443
|
*/
|
|
32218
32444
|
|
|
32219
32445
|
/**
|
|
@@ -32736,6 +32962,7 @@ class RecordingApi {
|
|
|
32736
32962
|
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
32737
32963
|
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
32738
32964
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
32965
|
+
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
32739
32966
|
*/
|
|
32740
32967
|
getRecordingCrossplatformMediaretentionpolicies(opts) {
|
|
32741
32968
|
opts = opts || {};
|
|
@@ -32745,7 +32972,7 @@ class RecordingApi {
|
|
|
32745
32972
|
'/api/v2/recording/crossplatform/mediaretentionpolicies',
|
|
32746
32973
|
'GET',
|
|
32747
32974
|
{ },
|
|
32748
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'] },
|
|
32975
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'],'deleteDaysThreshold': opts['deleteDaysThreshold'] },
|
|
32749
32976
|
{ },
|
|
32750
32977
|
{ },
|
|
32751
32978
|
null,
|
|
@@ -32868,6 +33095,51 @@ class RecordingApi {
|
|
|
32868
33095
|
);
|
|
32869
33096
|
}
|
|
32870
33097
|
|
|
33098
|
+
/**
|
|
33099
|
+
* Get the encryption key configurations
|
|
33100
|
+
*
|
|
33101
|
+
* @param {String} keyConfigurationId Key Configurations Id
|
|
33102
|
+
*/
|
|
33103
|
+
getRecordingKeyconfiguration(keyConfigurationId) {
|
|
33104
|
+
// verify the required parameter 'keyConfigurationId' is set
|
|
33105
|
+
if (keyConfigurationId === undefined || keyConfigurationId === null) {
|
|
33106
|
+
throw 'Missing the required parameter "keyConfigurationId" when calling getRecordingKeyconfiguration';
|
|
33107
|
+
}
|
|
33108
|
+
|
|
33109
|
+
return this.apiClient.callApi(
|
|
33110
|
+
'/api/v2/recording/keyconfigurations/{keyConfigurationId}',
|
|
33111
|
+
'GET',
|
|
33112
|
+
{ 'keyConfigurationId': keyConfigurationId },
|
|
33113
|
+
{ },
|
|
33114
|
+
{ },
|
|
33115
|
+
{ },
|
|
33116
|
+
null,
|
|
33117
|
+
['PureCloud OAuth'],
|
|
33118
|
+
['application/json'],
|
|
33119
|
+
['application/json']
|
|
33120
|
+
);
|
|
33121
|
+
}
|
|
33122
|
+
|
|
33123
|
+
/**
|
|
33124
|
+
* Get a list of key configurations data
|
|
33125
|
+
*
|
|
33126
|
+
*/
|
|
33127
|
+
getRecordingKeyconfigurations() {
|
|
33128
|
+
|
|
33129
|
+
return this.apiClient.callApi(
|
|
33130
|
+
'/api/v2/recording/keyconfigurations',
|
|
33131
|
+
'GET',
|
|
33132
|
+
{ },
|
|
33133
|
+
{ },
|
|
33134
|
+
{ },
|
|
33135
|
+
{ },
|
|
33136
|
+
null,
|
|
33137
|
+
['PureCloud OAuth'],
|
|
33138
|
+
['application/json'],
|
|
33139
|
+
['application/json']
|
|
33140
|
+
);
|
|
33141
|
+
}
|
|
33142
|
+
|
|
32871
33143
|
/**
|
|
32872
33144
|
* Get the local encryption settings
|
|
32873
33145
|
*
|
|
@@ -32927,6 +33199,7 @@ class RecordingApi {
|
|
|
32927
33199
|
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
32928
33200
|
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
32929
33201
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
33202
|
+
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
32930
33203
|
*/
|
|
32931
33204
|
getRecordingMediaretentionpolicies(opts) {
|
|
32932
33205
|
opts = opts || {};
|
|
@@ -32936,7 +33209,7 @@ class RecordingApi {
|
|
|
32936
33209
|
'/api/v2/recording/mediaretentionpolicies',
|
|
32937
33210
|
'GET',
|
|
32938
33211
|
{ },
|
|
32939
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'] },
|
|
33212
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'],'deleteDaysThreshold': opts['deleteDaysThreshold'] },
|
|
32940
33213
|
{ },
|
|
32941
33214
|
{ },
|
|
32942
33215
|
null,
|
|
@@ -33240,8 +33513,8 @@ class RecordingApi {
|
|
|
33240
33513
|
}
|
|
33241
33514
|
|
|
33242
33515
|
/**
|
|
33243
|
-
* Create a recording bulk job
|
|
33244
|
-
*
|
|
33516
|
+
* Create a recording bulk job.
|
|
33517
|
+
* Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state.
|
|
33245
33518
|
* @param {Object} body query
|
|
33246
33519
|
*/
|
|
33247
33520
|
postRecordingJobs(body) {
|
|
@@ -33264,6 +33537,56 @@ class RecordingApi {
|
|
|
33264
33537
|
);
|
|
33265
33538
|
}
|
|
33266
33539
|
|
|
33540
|
+
/**
|
|
33541
|
+
* Setup configurations for encryption key creation
|
|
33542
|
+
*
|
|
33543
|
+
* @param {Object} body Encryption Configuration
|
|
33544
|
+
*/
|
|
33545
|
+
postRecordingKeyconfigurations(body) {
|
|
33546
|
+
// verify the required parameter 'body' is set
|
|
33547
|
+
if (body === undefined || body === null) {
|
|
33548
|
+
throw 'Missing the required parameter "body" when calling postRecordingKeyconfigurations';
|
|
33549
|
+
}
|
|
33550
|
+
|
|
33551
|
+
return this.apiClient.callApi(
|
|
33552
|
+
'/api/v2/recording/keyconfigurations',
|
|
33553
|
+
'POST',
|
|
33554
|
+
{ },
|
|
33555
|
+
{ },
|
|
33556
|
+
{ },
|
|
33557
|
+
{ },
|
|
33558
|
+
body,
|
|
33559
|
+
['PureCloud OAuth'],
|
|
33560
|
+
['application/json'],
|
|
33561
|
+
['application/json']
|
|
33562
|
+
);
|
|
33563
|
+
}
|
|
33564
|
+
|
|
33565
|
+
/**
|
|
33566
|
+
* Validate encryption key configurations without saving it
|
|
33567
|
+
*
|
|
33568
|
+
* @param {Object} body Encryption Configuration
|
|
33569
|
+
*/
|
|
33570
|
+
postRecordingKeyconfigurationsValidate(body) {
|
|
33571
|
+
// verify the required parameter 'body' is set
|
|
33572
|
+
if (body === undefined || body === null) {
|
|
33573
|
+
throw 'Missing the required parameter "body" when calling postRecordingKeyconfigurationsValidate';
|
|
33574
|
+
}
|
|
33575
|
+
|
|
33576
|
+
return this.apiClient.callApi(
|
|
33577
|
+
'/api/v2/recording/keyconfigurations/validate',
|
|
33578
|
+
'POST',
|
|
33579
|
+
{ },
|
|
33580
|
+
{ },
|
|
33581
|
+
{ },
|
|
33582
|
+
{ },
|
|
33583
|
+
body,
|
|
33584
|
+
['PureCloud OAuth'],
|
|
33585
|
+
['application/json'],
|
|
33586
|
+
['application/json']
|
|
33587
|
+
);
|
|
33588
|
+
}
|
|
33589
|
+
|
|
33267
33590
|
/**
|
|
33268
33591
|
* create a local recording key
|
|
33269
33592
|
*
|
|
@@ -33598,6 +33921,36 @@ class RecordingApi {
|
|
|
33598
33921
|
);
|
|
33599
33922
|
}
|
|
33600
33923
|
|
|
33924
|
+
/**
|
|
33925
|
+
* Update the encryption key configurations
|
|
33926
|
+
*
|
|
33927
|
+
* @param {String} keyConfigurationId Key Configurations Id
|
|
33928
|
+
* @param {Object} body Encryption key configuration metadata
|
|
33929
|
+
*/
|
|
33930
|
+
putRecordingKeyconfiguration(keyConfigurationId, body) {
|
|
33931
|
+
// verify the required parameter 'keyConfigurationId' is set
|
|
33932
|
+
if (keyConfigurationId === undefined || keyConfigurationId === null) {
|
|
33933
|
+
throw 'Missing the required parameter "keyConfigurationId" when calling putRecordingKeyconfiguration';
|
|
33934
|
+
}
|
|
33935
|
+
// verify the required parameter 'body' is set
|
|
33936
|
+
if (body === undefined || body === null) {
|
|
33937
|
+
throw 'Missing the required parameter "body" when calling putRecordingKeyconfiguration';
|
|
33938
|
+
}
|
|
33939
|
+
|
|
33940
|
+
return this.apiClient.callApi(
|
|
33941
|
+
'/api/v2/recording/keyconfigurations/{keyConfigurationId}',
|
|
33942
|
+
'PUT',
|
|
33943
|
+
{ 'keyConfigurationId': keyConfigurationId },
|
|
33944
|
+
{ },
|
|
33945
|
+
{ },
|
|
33946
|
+
{ },
|
|
33947
|
+
body,
|
|
33948
|
+
['PureCloud OAuth'],
|
|
33949
|
+
['application/json'],
|
|
33950
|
+
['application/json']
|
|
33951
|
+
);
|
|
33952
|
+
}
|
|
33953
|
+
|
|
33601
33954
|
/**
|
|
33602
33955
|
* Update the local encryption settings
|
|
33603
33956
|
*
|
|
@@ -33739,7 +34092,7 @@ class ResponseManagementApi {
|
|
|
33739
34092
|
/**
|
|
33740
34093
|
* ResponseManagement service.
|
|
33741
34094
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
33742
|
-
* @version
|
|
34095
|
+
* @version 136.1.0
|
|
33743
34096
|
*/
|
|
33744
34097
|
|
|
33745
34098
|
/**
|
|
@@ -34223,7 +34576,7 @@ class RoutingApi {
|
|
|
34223
34576
|
/**
|
|
34224
34577
|
* Routing service.
|
|
34225
34578
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
34226
|
-
* @version
|
|
34579
|
+
* @version 136.1.0
|
|
34227
34580
|
*/
|
|
34228
34581
|
|
|
34229
34582
|
/**
|
|
@@ -34882,14 +35235,18 @@ class RoutingApi {
|
|
|
34882
35235
|
/**
|
|
34883
35236
|
* Get domains
|
|
34884
35237
|
*
|
|
35238
|
+
* @param {Object} opts Optional parameters
|
|
35239
|
+
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
34885
35240
|
*/
|
|
34886
|
-
getRoutingEmailDomains() {
|
|
35241
|
+
getRoutingEmailDomains(opts) {
|
|
35242
|
+
opts = opts || {};
|
|
35243
|
+
|
|
34887
35244
|
|
|
34888
35245
|
return this.apiClient.callApi(
|
|
34889
35246
|
'/api/v2/routing/email/domains',
|
|
34890
35247
|
'GET',
|
|
34891
35248
|
{ },
|
|
34892
|
-
{
|
|
35249
|
+
{ 'excludeStatus': opts['excludeStatus'] },
|
|
34893
35250
|
{ },
|
|
34894
35251
|
{ },
|
|
34895
35252
|
null,
|
|
@@ -37146,7 +37503,7 @@ class SCIMApi {
|
|
|
37146
37503
|
/**
|
|
37147
37504
|
* SCIM service.
|
|
37148
37505
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
37149
|
-
* @version
|
|
37506
|
+
* @version 136.1.0
|
|
37150
37507
|
*/
|
|
37151
37508
|
|
|
37152
37509
|
/**
|
|
@@ -38023,7 +38380,7 @@ class ScriptsApi {
|
|
|
38023
38380
|
/**
|
|
38024
38381
|
* Scripts service.
|
|
38025
38382
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
38026
|
-
* @version
|
|
38383
|
+
* @version 136.1.0
|
|
38027
38384
|
*/
|
|
38028
38385
|
|
|
38029
38386
|
/**
|
|
@@ -38139,6 +38496,7 @@ class ScriptsApi {
|
|
|
38139
38496
|
* @param {Object} opts.sortBy SortBy
|
|
38140
38497
|
* @param {Object} opts.sortOrder SortOrder
|
|
38141
38498
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
38499
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
38142
38500
|
*/
|
|
38143
38501
|
getScripts(opts) {
|
|
38144
38502
|
opts = opts || {};
|
|
@@ -38148,7 +38506,40 @@ class ScriptsApi {
|
|
|
38148
38506
|
'/api/v2/scripts',
|
|
38149
38507
|
'GET',
|
|
38150
38508
|
{ },
|
|
38151
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'scriptDataVersion': opts['scriptDataVersion'] },
|
|
38509
|
+
{ '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'] },
|
|
38510
|
+
{ },
|
|
38511
|
+
{ },
|
|
38512
|
+
null,
|
|
38513
|
+
['PureCloud OAuth'],
|
|
38514
|
+
['application/json'],
|
|
38515
|
+
['application/json']
|
|
38516
|
+
);
|
|
38517
|
+
}
|
|
38518
|
+
|
|
38519
|
+
/**
|
|
38520
|
+
* Get the metadata for a list of scripts
|
|
38521
|
+
*
|
|
38522
|
+
* @param {Object} opts Optional parameters
|
|
38523
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
38524
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
38525
|
+
* @param {String} opts.expand Expand
|
|
38526
|
+
* @param {String} opts.name Name filter
|
|
38527
|
+
* @param {String} opts.feature Feature filter
|
|
38528
|
+
* @param {String} opts.flowId Secure flow id filter
|
|
38529
|
+
* @param {Object} opts.sortBy SortBy
|
|
38530
|
+
* @param {Object} opts.sortOrder SortOrder
|
|
38531
|
+
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
38532
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
38533
|
+
*/
|
|
38534
|
+
getScriptsDivisionviews(opts) {
|
|
38535
|
+
opts = opts || {};
|
|
38536
|
+
|
|
38537
|
+
|
|
38538
|
+
return this.apiClient.callApi(
|
|
38539
|
+
'/api/v2/scripts/divisionviews',
|
|
38540
|
+
'GET',
|
|
38541
|
+
{ },
|
|
38542
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
38152
38543
|
{ },
|
|
38153
38544
|
{ },
|
|
38154
38545
|
null,
|
|
@@ -38169,6 +38560,7 @@ class ScriptsApi {
|
|
|
38169
38560
|
* @param {String} opts.feature Feature filter
|
|
38170
38561
|
* @param {String} opts.flowId Secure flow id filter
|
|
38171
38562
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
38563
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
38172
38564
|
*/
|
|
38173
38565
|
getScriptsPublished(opts) {
|
|
38174
38566
|
opts = opts || {};
|
|
@@ -38178,7 +38570,38 @@ class ScriptsApi {
|
|
|
38178
38570
|
'/api/v2/scripts/published',
|
|
38179
38571
|
'GET',
|
|
38180
38572
|
{ },
|
|
38181
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'] },
|
|
38573
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
38574
|
+
{ },
|
|
38575
|
+
{ },
|
|
38576
|
+
null,
|
|
38577
|
+
['PureCloud OAuth'],
|
|
38578
|
+
['application/json'],
|
|
38579
|
+
['application/json']
|
|
38580
|
+
);
|
|
38581
|
+
}
|
|
38582
|
+
|
|
38583
|
+
/**
|
|
38584
|
+
* Get the published scripts metadata.
|
|
38585
|
+
*
|
|
38586
|
+
* @param {Object} opts Optional parameters
|
|
38587
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
38588
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
38589
|
+
* @param {String} opts.expand Expand
|
|
38590
|
+
* @param {String} opts.name Name filter
|
|
38591
|
+
* @param {String} opts.feature Feature filter
|
|
38592
|
+
* @param {String} opts.flowId Secure flow id filter
|
|
38593
|
+
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
38594
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
38595
|
+
*/
|
|
38596
|
+
getScriptsPublishedDivisionviews(opts) {
|
|
38597
|
+
opts = opts || {};
|
|
38598
|
+
|
|
38599
|
+
|
|
38600
|
+
return this.apiClient.callApi(
|
|
38601
|
+
'/api/v2/scripts/published/divisionviews',
|
|
38602
|
+
'GET',
|
|
38603
|
+
{ },
|
|
38604
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
38182
38605
|
{ },
|
|
38183
38606
|
{ },
|
|
38184
38607
|
null,
|
|
@@ -38376,7 +38799,7 @@ class SearchApi {
|
|
|
38376
38799
|
/**
|
|
38377
38800
|
* Search service.
|
|
38378
38801
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
38379
|
-
* @version
|
|
38802
|
+
* @version 136.1.0
|
|
38380
38803
|
*/
|
|
38381
38804
|
|
|
38382
38805
|
/**
|
|
@@ -38911,7 +39334,7 @@ class SpeechTextAnalyticsApi {
|
|
|
38911
39334
|
/**
|
|
38912
39335
|
* SpeechTextAnalytics service.
|
|
38913
39336
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
38914
|
-
* @version
|
|
39337
|
+
* @version 136.1.0
|
|
38915
39338
|
*/
|
|
38916
39339
|
|
|
38917
39340
|
/**
|
|
@@ -39764,7 +40187,7 @@ class StationsApi {
|
|
|
39764
40187
|
/**
|
|
39765
40188
|
* Stations service.
|
|
39766
40189
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
39767
|
-
* @version
|
|
40190
|
+
* @version 136.1.0
|
|
39768
40191
|
*/
|
|
39769
40192
|
|
|
39770
40193
|
/**
|
|
@@ -39911,7 +40334,7 @@ class SuggestApi {
|
|
|
39911
40334
|
/**
|
|
39912
40335
|
* Suggest service.
|
|
39913
40336
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
39914
|
-
* @version
|
|
40337
|
+
* @version 136.1.0
|
|
39915
40338
|
*/
|
|
39916
40339
|
|
|
39917
40340
|
/**
|
|
@@ -40050,7 +40473,7 @@ class TelephonyApi {
|
|
|
40050
40473
|
/**
|
|
40051
40474
|
* Telephony service.
|
|
40052
40475
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
40053
|
-
* @version
|
|
40476
|
+
* @version 136.1.0
|
|
40054
40477
|
*/
|
|
40055
40478
|
|
|
40056
40479
|
/**
|
|
@@ -40158,7 +40581,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
40158
40581
|
/**
|
|
40159
40582
|
* TelephonyProvidersEdge service.
|
|
40160
40583
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
40161
|
-
* @version
|
|
40584
|
+
* @version 136.1.0
|
|
40162
40585
|
*/
|
|
40163
40586
|
|
|
40164
40587
|
/**
|
|
@@ -41573,7 +41996,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
41573
41996
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
41574
41997
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
41575
41998
|
* @param {String} opts.sortBy Sort by
|
|
41576
|
-
* @param {String} opts._number
|
|
41999
|
+
* @param {String} opts._number Deprecated, filtering by number not supported
|
|
41577
42000
|
*/
|
|
41578
42001
|
getTelephonyProvidersEdgesExtensionpools(opts) {
|
|
41579
42002
|
opts = opts || {};
|
|
@@ -43791,7 +44214,7 @@ class TextbotsApi {
|
|
|
43791
44214
|
/**
|
|
43792
44215
|
* Textbots service.
|
|
43793
44216
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
43794
|
-
* @version
|
|
44217
|
+
* @version 136.1.0
|
|
43795
44218
|
*/
|
|
43796
44219
|
|
|
43797
44220
|
/**
|
|
@@ -43919,7 +44342,7 @@ class TokensApi {
|
|
|
43919
44342
|
/**
|
|
43920
44343
|
* Tokens service.
|
|
43921
44344
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
43922
|
-
* @version
|
|
44345
|
+
* @version 136.1.0
|
|
43923
44346
|
*/
|
|
43924
44347
|
|
|
43925
44348
|
/**
|
|
@@ -44025,7 +44448,7 @@ class UploadsApi {
|
|
|
44025
44448
|
/**
|
|
44026
44449
|
* Uploads service.
|
|
44027
44450
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
44028
|
-
* @version
|
|
44451
|
+
* @version 136.1.0
|
|
44029
44452
|
*/
|
|
44030
44453
|
|
|
44031
44454
|
/**
|
|
@@ -44176,7 +44599,7 @@ class UsageApi {
|
|
|
44176
44599
|
/**
|
|
44177
44600
|
* Usage service.
|
|
44178
44601
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
44179
|
-
* @version
|
|
44602
|
+
* @version 136.1.0
|
|
44180
44603
|
*/
|
|
44181
44604
|
|
|
44182
44605
|
/**
|
|
@@ -44247,7 +44670,7 @@ class UserRecordingsApi {
|
|
|
44247
44670
|
/**
|
|
44248
44671
|
* UserRecordings service.
|
|
44249
44672
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
44250
|
-
* @version
|
|
44673
|
+
* @version 136.1.0
|
|
44251
44674
|
*/
|
|
44252
44675
|
|
|
44253
44676
|
/**
|
|
@@ -44431,7 +44854,7 @@ class UsersApi {
|
|
|
44431
44854
|
/**
|
|
44432
44855
|
* Users service.
|
|
44433
44856
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
44434
|
-
* @version
|
|
44857
|
+
* @version 136.1.0
|
|
44435
44858
|
*/
|
|
44436
44859
|
|
|
44437
44860
|
/**
|
|
@@ -46733,7 +47156,7 @@ class UtilitiesApi {
|
|
|
46733
47156
|
/**
|
|
46734
47157
|
* Utilities service.
|
|
46735
47158
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
46736
|
-
* @version
|
|
47159
|
+
* @version 136.1.0
|
|
46737
47160
|
*/
|
|
46738
47161
|
|
|
46739
47162
|
/**
|
|
@@ -46844,7 +47267,7 @@ class VoicemailApi {
|
|
|
46844
47267
|
/**
|
|
46845
47268
|
* Voicemail service.
|
|
46846
47269
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
46847
|
-
* @version
|
|
47270
|
+
* @version 136.1.0
|
|
46848
47271
|
*/
|
|
46849
47272
|
|
|
46850
47273
|
/**
|
|
@@ -47511,7 +47934,7 @@ class WebChatApi {
|
|
|
47511
47934
|
/**
|
|
47512
47935
|
* WebChat service.
|
|
47513
47936
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
47514
|
-
* @version
|
|
47937
|
+
* @version 136.1.0
|
|
47515
47938
|
*/
|
|
47516
47939
|
|
|
47517
47940
|
/**
|
|
@@ -48055,7 +48478,7 @@ class WebDeploymentsApi {
|
|
|
48055
48478
|
/**
|
|
48056
48479
|
* WebDeployments service.
|
|
48057
48480
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
48058
|
-
* @version
|
|
48481
|
+
* @version 136.1.0
|
|
48059
48482
|
*/
|
|
48060
48483
|
|
|
48061
48484
|
/**
|
|
@@ -48410,7 +48833,7 @@ class WebMessagingApi {
|
|
|
48410
48833
|
/**
|
|
48411
48834
|
* WebMessaging service.
|
|
48412
48835
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
48413
|
-
* @version
|
|
48836
|
+
* @version 136.1.0
|
|
48414
48837
|
*/
|
|
48415
48838
|
|
|
48416
48839
|
/**
|
|
@@ -48456,7 +48879,7 @@ class WidgetsApi {
|
|
|
48456
48879
|
/**
|
|
48457
48880
|
* Widgets service.
|
|
48458
48881
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
48459
|
-
* @version
|
|
48882
|
+
* @version 136.1.0
|
|
48460
48883
|
*/
|
|
48461
48884
|
|
|
48462
48885
|
/**
|
|
@@ -48602,7 +49025,7 @@ class WorkforceManagementApi {
|
|
|
48602
49025
|
/**
|
|
48603
49026
|
* WorkforceManagement service.
|
|
48604
49027
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
48605
|
-
* @version
|
|
49028
|
+
* @version 136.1.0
|
|
48606
49029
|
*/
|
|
48607
49030
|
|
|
48608
49031
|
/**
|
|
@@ -48800,7 +49223,7 @@ class WorkforceManagementApi {
|
|
|
48800
49223
|
/**
|
|
48801
49224
|
* Delete a short term forecast
|
|
48802
49225
|
* Must not be tied to any schedules
|
|
48803
|
-
* @param {String} businessUnitId The
|
|
49226
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
48804
49227
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
48805
49228
|
* @param {String} forecastId The ID of the forecast
|
|
48806
49229
|
*/
|
|
@@ -48880,7 +49303,7 @@ class WorkforceManagementApi {
|
|
|
48880
49303
|
/**
|
|
48881
49304
|
* Deletes a time off limit object
|
|
48882
49305
|
*
|
|
48883
|
-
* @param {String} managementUnitId The
|
|
49306
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
48884
49307
|
* @param {String} timeOffLimitId The ID of the time off limit object to delete
|
|
48885
49308
|
*/
|
|
48886
49309
|
deleteWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
@@ -48910,7 +49333,7 @@ class WorkforceManagementApi {
|
|
|
48910
49333
|
/**
|
|
48911
49334
|
* Deletes a time off plan
|
|
48912
49335
|
*
|
|
48913
|
-
* @param {String} managementUnitId The management unit
|
|
49336
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
48914
49337
|
* @param {String} timeOffPlanId The ID of the time off plan to delete
|
|
48915
49338
|
*/
|
|
48916
49339
|
deleteWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
@@ -49179,7 +49602,7 @@ class WorkforceManagementApi {
|
|
|
49179
49602
|
/**
|
|
49180
49603
|
* Get intraday planning groups for the given date
|
|
49181
49604
|
*
|
|
49182
|
-
* @param {String} businessUnitId The
|
|
49605
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
49183
49606
|
* @param {String} _date yyyy-MM-dd date string interpreted in the configured business unit time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
49184
49607
|
*/
|
|
49185
49608
|
getWorkforcemanagementBusinessunitIntradayPlanninggroups(businessUnitId, _date) {
|
|
@@ -49632,7 +50055,7 @@ class WorkforceManagementApi {
|
|
|
49632
50055
|
/**
|
|
49633
50056
|
* Get a short term forecast
|
|
49634
50057
|
*
|
|
49635
|
-
* @param {String} businessUnitId The
|
|
50058
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49636
50059
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
49637
50060
|
* @param {String} forecastId The ID of the forecast
|
|
49638
50061
|
* @param {Object} opts Optional parameters
|
|
@@ -49671,7 +50094,7 @@ class WorkforceManagementApi {
|
|
|
49671
50094
|
/**
|
|
49672
50095
|
* Get the result of a short term forecast calculation
|
|
49673
50096
|
* Includes modifications unless you pass the doNotApplyModifications query parameter
|
|
49674
|
-
* @param {String} businessUnitId The
|
|
50097
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49675
50098
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
49676
50099
|
* @param {String} forecastId The ID of the forecast
|
|
49677
50100
|
* @param {Object} opts Optional parameters
|
|
@@ -49711,7 +50134,7 @@ class WorkforceManagementApi {
|
|
|
49711
50134
|
/**
|
|
49712
50135
|
* Gets the forecast generation results
|
|
49713
50136
|
*
|
|
49714
|
-
* @param {String} businessUnitId The
|
|
50137
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49715
50138
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
49716
50139
|
* @param {String} forecastId The ID of the forecast
|
|
49717
50140
|
*/
|
|
@@ -49746,7 +50169,7 @@ class WorkforceManagementApi {
|
|
|
49746
50169
|
/**
|
|
49747
50170
|
* Get the result of a long term forecast calculation
|
|
49748
50171
|
* Includes modifications unless you pass the doNotApplyModifications query parameter
|
|
49749
|
-
* @param {String} businessUnitId The
|
|
50172
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49750
50173
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
49751
50174
|
* @param {String} forecastId The ID of the forecast
|
|
49752
50175
|
* @param {Object} opts Optional parameters
|
|
@@ -49785,7 +50208,7 @@ class WorkforceManagementApi {
|
|
|
49785
50208
|
/**
|
|
49786
50209
|
* Gets the forecast planning group snapshot
|
|
49787
50210
|
*
|
|
49788
|
-
* @param {String} businessUnitId The
|
|
50211
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49789
50212
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
49790
50213
|
* @param {String} forecastId The ID of the forecast
|
|
49791
50214
|
*/
|
|
@@ -49820,7 +50243,7 @@ class WorkforceManagementApi {
|
|
|
49820
50243
|
/**
|
|
49821
50244
|
* Get short term forecasts
|
|
49822
50245
|
* Use \"recent\" (without quotes) for the `weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any forecast which spans the specified week
|
|
49823
|
-
* @param {String} businessUnitId The
|
|
50246
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
49824
50247
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format or 'recent' (without quotes) to fetch recent forecasts
|
|
49825
50248
|
*/
|
|
49826
50249
|
getWorkforcemanagementBusinessunitWeekShorttermforecasts(businessUnitId, weekDateId) {
|
|
@@ -50038,7 +50461,7 @@ class WorkforceManagementApi {
|
|
|
50038
50461
|
/**
|
|
50039
50462
|
* Get a list of user schedule adherence records for the requested management unit
|
|
50040
50463
|
*
|
|
50041
|
-
* @param {String} managementUnitId The
|
|
50464
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
50042
50465
|
* @param {Object} opts Optional parameters
|
|
50043
50466
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
50044
50467
|
*/
|
|
@@ -50067,7 +50490,7 @@ class WorkforceManagementApi {
|
|
|
50067
50490
|
/**
|
|
50068
50491
|
* Get data for agent in the management unit
|
|
50069
50492
|
*
|
|
50070
|
-
* @param {String} managementUnitId The
|
|
50493
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50071
50494
|
* @param {String} agentId The agent id
|
|
50072
50495
|
* @param {Object} opts Optional parameters
|
|
50073
50496
|
* @param {Boolean} opts.excludeCapabilities Excludes all capabilities of the agent such as queues, languages, and skills
|
|
@@ -50101,7 +50524,7 @@ class WorkforceManagementApi {
|
|
|
50101
50524
|
/**
|
|
50102
50525
|
* Gets all the shift trades for a given agent
|
|
50103
50526
|
*
|
|
50104
|
-
* @param {String} managementUnitId The
|
|
50527
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50105
50528
|
* @param {String} agentId The agent id
|
|
50106
50529
|
*/
|
|
50107
50530
|
getWorkforcemanagementManagementunitAgentShifttrades(managementUnitId, agentId) {
|
|
@@ -50131,7 +50554,7 @@ class WorkforceManagementApi {
|
|
|
50131
50554
|
/**
|
|
50132
50555
|
* Gets a summary of all shift trades in the matched state
|
|
50133
50556
|
*
|
|
50134
|
-
* @param {String} managementUnitId The
|
|
50557
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50135
50558
|
*/
|
|
50136
50559
|
getWorkforcemanagementManagementunitShifttradesMatched(managementUnitId) {
|
|
50137
50560
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50156,7 +50579,7 @@ class WorkforceManagementApi {
|
|
|
50156
50579
|
/**
|
|
50157
50580
|
* Gets list of users available for whom you can send direct shift trade requests
|
|
50158
50581
|
*
|
|
50159
|
-
* @param {String} managementUnitId The
|
|
50582
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50160
50583
|
*/
|
|
50161
50584
|
getWorkforcemanagementManagementunitShifttradesUsers(managementUnitId) {
|
|
50162
50585
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50181,7 +50604,7 @@ class WorkforceManagementApi {
|
|
|
50181
50604
|
/**
|
|
50182
50605
|
* Gets a time off limit object
|
|
50183
50606
|
* Returns properties of time off limit object, but not daily values.
|
|
50184
|
-
* @param {String} managementUnitId The
|
|
50607
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
50185
50608
|
* @param {String} timeOffLimitId The ID of the time off limit to fetch
|
|
50186
50609
|
*/
|
|
50187
50610
|
getWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
@@ -50211,7 +50634,7 @@ class WorkforceManagementApi {
|
|
|
50211
50634
|
/**
|
|
50212
50635
|
* Gets a list of time off limit objects under management unit.
|
|
50213
50636
|
* Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.
|
|
50214
|
-
* @param {String} managementUnitId The
|
|
50637
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
50215
50638
|
*/
|
|
50216
50639
|
getWorkforcemanagementManagementunitTimeofflimits(managementUnitId) {
|
|
50217
50640
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50236,7 +50659,7 @@ class WorkforceManagementApi {
|
|
|
50236
50659
|
/**
|
|
50237
50660
|
* Gets a time off plan
|
|
50238
50661
|
*
|
|
50239
|
-
* @param {String} managementUnitId The management unit
|
|
50662
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
50240
50663
|
* @param {String} timeOffPlanId The ID of the time off plan to fetch
|
|
50241
50664
|
*/
|
|
50242
50665
|
getWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
@@ -50266,7 +50689,7 @@ class WorkforceManagementApi {
|
|
|
50266
50689
|
/**
|
|
50267
50690
|
* Gets a list of time off plans
|
|
50268
50691
|
*
|
|
50269
|
-
* @param {String} managementUnitId The management unit
|
|
50692
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
50270
50693
|
*/
|
|
50271
50694
|
getWorkforcemanagementManagementunitTimeoffplans(managementUnitId) {
|
|
50272
50695
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50291,7 +50714,7 @@ class WorkforceManagementApi {
|
|
|
50291
50714
|
/**
|
|
50292
50715
|
* Get a time off request
|
|
50293
50716
|
*
|
|
50294
|
-
* @param {String} managementUnitId The
|
|
50717
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50295
50718
|
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
50296
50719
|
* @param {String} timeOffRequestId Time Off Request Id
|
|
50297
50720
|
*/
|
|
@@ -50326,7 +50749,7 @@ class WorkforceManagementApi {
|
|
|
50326
50749
|
/**
|
|
50327
50750
|
* Retrieves time off limit, allocated and waitlisted values according to specific time off request
|
|
50328
50751
|
*
|
|
50329
|
-
* @param {String} managementUnitId The
|
|
50752
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
50330
50753
|
* @param {String} userId The userId to whom the time off request applies.
|
|
50331
50754
|
* @param {String} timeOffRequestId The ID of the time off request, which dates and activityCodeId determine limit values to retrieve
|
|
50332
50755
|
*/
|
|
@@ -50361,7 +50784,7 @@ class WorkforceManagementApi {
|
|
|
50361
50784
|
/**
|
|
50362
50785
|
* Get a list of time off requests for a given user
|
|
50363
50786
|
*
|
|
50364
|
-
* @param {String} managementUnitId The
|
|
50787
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50365
50788
|
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
50366
50789
|
* @param {Object} opts Optional parameters
|
|
50367
50790
|
* @param {Boolean} opts.recentlyReviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
|
|
@@ -50395,7 +50818,7 @@ class WorkforceManagementApi {
|
|
|
50395
50818
|
/**
|
|
50396
50819
|
* Get users in the management unit
|
|
50397
50820
|
*
|
|
50398
|
-
* @param {String} managementUnitId The
|
|
50821
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50399
50822
|
*/
|
|
50400
50823
|
getWorkforcemanagementManagementunitUsers(managementUnitId) {
|
|
50401
50824
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -50496,7 +50919,7 @@ class WorkforceManagementApi {
|
|
|
50496
50919
|
/**
|
|
50497
50920
|
* Gets all the shift trades for a given week
|
|
50498
50921
|
*
|
|
50499
|
-
* @param {String} managementUnitId The
|
|
50922
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
50500
50923
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
50501
50924
|
* @param {Object} opts Optional parameters
|
|
50502
50925
|
* @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
|
|
@@ -50769,7 +51192,7 @@ class WorkforceManagementApi {
|
|
|
50769
51192
|
/**
|
|
50770
51193
|
* Get a time off request for the current user
|
|
50771
51194
|
*
|
|
50772
|
-
* @param {String} timeOffRequestId
|
|
51195
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
50773
51196
|
*/
|
|
50774
51197
|
getWorkforcemanagementTimeoffrequest(timeOffRequestId) {
|
|
50775
51198
|
// verify the required parameter 'timeOffRequestId' is set
|
|
@@ -50794,7 +51217,7 @@ class WorkforceManagementApi {
|
|
|
50794
51217
|
/**
|
|
50795
51218
|
* Get the daily waitlist positions of a time off request for the current user
|
|
50796
51219
|
*
|
|
50797
|
-
* @param {String} timeOffRequestId
|
|
51220
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
50798
51221
|
*/
|
|
50799
51222
|
getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId) {
|
|
50800
51223
|
// verify the required parameter 'timeOffRequestId' is set
|
|
@@ -51037,7 +51460,7 @@ class WorkforceManagementApi {
|
|
|
51037
51460
|
/**
|
|
51038
51461
|
* Updates a time off limit object.
|
|
51039
51462
|
* Updates time off limit object properties, but not daily values.
|
|
51040
|
-
* @param {String} managementUnitId The
|
|
51463
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
51041
51464
|
* @param {String} timeOffLimitId The id of time off limit object to update
|
|
51042
51465
|
* @param {Object} opts Optional parameters
|
|
51043
51466
|
* @param {Object} opts.body body
|
|
@@ -51071,7 +51494,7 @@ class WorkforceManagementApi {
|
|
|
51071
51494
|
/**
|
|
51072
51495
|
* Updates a time off plan
|
|
51073
51496
|
*
|
|
51074
|
-
* @param {String} managementUnitId The management unit
|
|
51497
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
51075
51498
|
* @param {String} timeOffPlanId The ID of the time off plan to update
|
|
51076
51499
|
* @param {Object} opts Optional parameters
|
|
51077
51500
|
* @param {Object} opts.body body
|
|
@@ -51105,7 +51528,7 @@ class WorkforceManagementApi {
|
|
|
51105
51528
|
/**
|
|
51106
51529
|
* Update a time off request
|
|
51107
51530
|
*
|
|
51108
|
-
* @param {String} managementUnitId The
|
|
51531
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
51109
51532
|
* @param {String} userId The id of the user the requested time off request belongs to
|
|
51110
51533
|
* @param {String} timeOffRequestId The id of the time off request to update
|
|
51111
51534
|
* @param {Object} opts Optional parameters
|
|
@@ -51144,7 +51567,7 @@ class WorkforceManagementApi {
|
|
|
51144
51567
|
/**
|
|
51145
51568
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
51146
51569
|
*
|
|
51147
|
-
* @param {String} managementUnitId The
|
|
51570
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
51148
51571
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51149
51572
|
* @param {Object} body body
|
|
51150
51573
|
* @param {String} tradeId The ID of the shift trade to update
|
|
@@ -51253,7 +51676,7 @@ class WorkforceManagementApi {
|
|
|
51253
51676
|
/**
|
|
51254
51677
|
* Update a time off request for the current user
|
|
51255
51678
|
*
|
|
51256
|
-
* @param {String} timeOffRequestId
|
|
51679
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
51257
51680
|
* @param {Object} opts Optional parameters
|
|
51258
51681
|
* @param {Object} opts.body body
|
|
51259
51682
|
*/
|
|
@@ -51390,7 +51813,7 @@ class WorkforceManagementApi {
|
|
|
51390
51813
|
/**
|
|
51391
51814
|
* Get intraday data for the given date for the requested planningGroupIds
|
|
51392
51815
|
*
|
|
51393
|
-
* @param {String} businessUnitId The
|
|
51816
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
51394
51817
|
* @param {Object} opts Optional parameters
|
|
51395
51818
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
51396
51819
|
* @param {Object} opts.body body
|
|
@@ -51823,7 +52246,7 @@ class WorkforceManagementApi {
|
|
|
51823
52246
|
/**
|
|
51824
52247
|
* Copy a short term forecast
|
|
51825
52248
|
*
|
|
51826
|
-
* @param {String} businessUnitId The
|
|
52249
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51827
52250
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51828
52251
|
* @param {String} forecastId The ID of the forecast to copy
|
|
51829
52252
|
* @param {Object} body body
|
|
@@ -51867,7 +52290,7 @@ class WorkforceManagementApi {
|
|
|
51867
52290
|
/**
|
|
51868
52291
|
* Generate a short term forecast
|
|
51869
52292
|
*
|
|
51870
|
-
* @param {String} businessUnitId The
|
|
52293
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51871
52294
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51872
52295
|
* @param {Object} body
|
|
51873
52296
|
* @param {Object} opts Optional parameters
|
|
@@ -51906,7 +52329,7 @@ class WorkforceManagementApi {
|
|
|
51906
52329
|
/**
|
|
51907
52330
|
* Starts importing the uploaded short term forecast
|
|
51908
52331
|
* Call after uploading the forecast data to the url supplied by the /import/uploadurl route
|
|
51909
|
-
* @param {String} businessUnitId The
|
|
52332
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51910
52333
|
* @param {String} weekDateId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51911
52334
|
* @param {Object} body
|
|
51912
52335
|
*/
|
|
@@ -51941,7 +52364,7 @@ class WorkforceManagementApi {
|
|
|
51941
52364
|
/**
|
|
51942
52365
|
* Creates a signed upload URL for importing a short term forecast
|
|
51943
52366
|
* Once the upload is complete, call the /import route to start the short term forecast import process
|
|
51944
|
-
* @param {String} businessUnitId The
|
|
52367
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51945
52368
|
* @param {String} weekDateId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51946
52369
|
* @param {Object} body body
|
|
51947
52370
|
*/
|
|
@@ -52068,7 +52491,7 @@ class WorkforceManagementApi {
|
|
|
52068
52491
|
/**
|
|
52069
52492
|
* Query published schedules for given given time range for set of users
|
|
52070
52493
|
*
|
|
52071
|
-
* @param {String} managementUnitId The
|
|
52494
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52072
52495
|
* @param {Object} opts Optional parameters
|
|
52073
52496
|
* @param {Object} opts.body body
|
|
52074
52497
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
@@ -52099,7 +52522,7 @@ class WorkforceManagementApi {
|
|
|
52099
52522
|
/**
|
|
52100
52523
|
* Request a historical adherence report
|
|
52101
52524
|
* The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
|
|
52102
|
-
* @param {String} managementUnitId The
|
|
52525
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
52103
52526
|
* @param {Object} opts Optional parameters
|
|
52104
52527
|
* @param {Object} opts.body body
|
|
52105
52528
|
*/
|
|
@@ -52157,7 +52580,7 @@ class WorkforceManagementApi {
|
|
|
52157
52580
|
/**
|
|
52158
52581
|
* Query published schedules for given given time range for set of users
|
|
52159
52582
|
*
|
|
52160
|
-
* @param {String} managementUnitId The
|
|
52583
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52161
52584
|
* @param {Object} opts Optional parameters
|
|
52162
52585
|
* @param {Object} opts.body body
|
|
52163
52586
|
*/
|
|
@@ -52186,7 +52609,7 @@ class WorkforceManagementApi {
|
|
|
52186
52609
|
/**
|
|
52187
52610
|
* Creates a new time off limit object under management unit.
|
|
52188
52611
|
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
52189
|
-
* @param {String} managementUnitId The
|
|
52612
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52190
52613
|
* @param {Object} opts Optional parameters
|
|
52191
52614
|
* @param {Object} opts.body body
|
|
52192
52615
|
*/
|
|
@@ -52215,7 +52638,7 @@ class WorkforceManagementApi {
|
|
|
52215
52638
|
/**
|
|
52216
52639
|
* Retrieves time off limit related values based on a given set of filters.
|
|
52217
52640
|
*
|
|
52218
|
-
* @param {String} managementUnitId The
|
|
52641
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52219
52642
|
* @param {Object} opts Optional parameters
|
|
52220
52643
|
* @param {Object} opts.body body
|
|
52221
52644
|
*/
|
|
@@ -52244,7 +52667,7 @@ class WorkforceManagementApi {
|
|
|
52244
52667
|
/**
|
|
52245
52668
|
* Creates a new time off plan
|
|
52246
52669
|
*
|
|
52247
|
-
* @param {String} managementUnitId The management unit
|
|
52670
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
52248
52671
|
* @param {Object} opts Optional parameters
|
|
52249
52672
|
* @param {Object} opts.body body
|
|
52250
52673
|
*/
|
|
@@ -52273,7 +52696,7 @@ class WorkforceManagementApi {
|
|
|
52273
52696
|
/**
|
|
52274
52697
|
* Create a new time off request
|
|
52275
52698
|
*
|
|
52276
|
-
* @param {String} managementUnitId The
|
|
52699
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52277
52700
|
* @param {Object} opts Optional parameters
|
|
52278
52701
|
* @param {Object} opts.body body
|
|
52279
52702
|
*/
|
|
@@ -52302,7 +52725,7 @@ class WorkforceManagementApi {
|
|
|
52302
52725
|
/**
|
|
52303
52726
|
* Fetches time off requests matching the conditions specified in the request body
|
|
52304
52727
|
* Request body requires one of the following: User ID is specified, statuses == [Pending] or date range to be specified and less than or equal to 33 days. All other fields are filters
|
|
52305
|
-
* @param {String} managementUnitId The
|
|
52728
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52306
52729
|
* @param {Object} opts Optional parameters
|
|
52307
52730
|
* @param {Object} opts.body body
|
|
52308
52731
|
*/
|
|
@@ -52331,7 +52754,7 @@ class WorkforceManagementApi {
|
|
|
52331
52754
|
/**
|
|
52332
52755
|
* Retrieves daily waitlist position for a list of time off requests
|
|
52333
52756
|
*
|
|
52334
|
-
* @param {String} managementUnitId The
|
|
52757
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52335
52758
|
* @param {Object} opts Optional parameters
|
|
52336
52759
|
* @param {Object} opts.body body
|
|
52337
52760
|
*/
|
|
@@ -52360,7 +52783,7 @@ class WorkforceManagementApi {
|
|
|
52360
52783
|
/**
|
|
52361
52784
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
52362
52785
|
*
|
|
52363
|
-
* @param {String} managementUnitId The
|
|
52786
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52364
52787
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
52365
52788
|
* @param {Object} body body
|
|
52366
52789
|
* @param {String} tradeId The ID of the shift trade to update
|
|
@@ -52400,7 +52823,7 @@ class WorkforceManagementApi {
|
|
|
52400
52823
|
/**
|
|
52401
52824
|
* Adds a shift trade
|
|
52402
52825
|
*
|
|
52403
|
-
* @param {String} managementUnitId The
|
|
52826
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52404
52827
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
52405
52828
|
* @param {Object} body body
|
|
52406
52829
|
*/
|
|
@@ -52435,7 +52858,7 @@ class WorkforceManagementApi {
|
|
|
52435
52858
|
/**
|
|
52436
52859
|
* Searches for potential shift trade matches for the current agent
|
|
52437
52860
|
*
|
|
52438
|
-
* @param {String} managementUnitId The
|
|
52861
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52439
52862
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
52440
52863
|
* @param {Object} body body
|
|
52441
52864
|
*/
|
|
@@ -52470,7 +52893,7 @@ class WorkforceManagementApi {
|
|
|
52470
52893
|
/**
|
|
52471
52894
|
* Updates the state of a batch of shift trades
|
|
52472
52895
|
* Admin functionality is not supported with \"mine\".
|
|
52473
|
-
* @param {String} managementUnitId The
|
|
52896
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52474
52897
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
52475
52898
|
* @param {Object} body body
|
|
52476
52899
|
* @param {Object} opts Optional parameters
|
|
@@ -52791,7 +53214,7 @@ class WorkforceManagementApi {
|
|
|
52791
53214
|
/**
|
|
52792
53215
|
* Sets daily values for a date range of time off limit object
|
|
52793
53216
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
52794
|
-
* @param {String} managementUnitId The
|
|
53217
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52795
53218
|
* @param {String} timeOffLimitId The ID of the time off limit object to set values for
|
|
52796
53219
|
* @param {Object} opts Optional parameters
|
|
52797
53220
|
* @param {Object} opts.body body
|
|
@@ -52853,7 +53276,7 @@ class WorkforceManagementApi {
|
|
|
52853
53276
|
* </pre>
|
|
52854
53277
|
* </p>
|
|
52855
53278
|
* @module purecloud-platform-client-v2/index
|
|
52856
|
-
* @version
|
|
53279
|
+
* @version 136.1.0
|
|
52857
53280
|
*/
|
|
52858
53281
|
class platformClient {
|
|
52859
53282
|
constructor() {
|