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
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -2265,7 +2265,7 @@ class Configuration {
|
|
|
2265
2265
|
|
|
2266
2266
|
/**
|
|
2267
2267
|
* @module purecloud-platform-client-v2/ApiClient
|
|
2268
|
-
* @version
|
|
2268
|
+
* @version 136.1.0
|
|
2269
2269
|
*/
|
|
2270
2270
|
class ApiClient {
|
|
2271
2271
|
/**
|
|
@@ -3205,7 +3205,7 @@ class ApiClient {
|
|
|
3205
3205
|
|
|
3206
3206
|
// set header parameters
|
|
3207
3207
|
request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
|
|
3208
|
-
//request.set({ 'purecloud-sdk': '
|
|
3208
|
+
//request.set({ 'purecloud-sdk': '136.1.0' });
|
|
3209
3209
|
|
|
3210
3210
|
// set request timeout
|
|
3211
3211
|
request.timeout(that.timeout);
|
|
@@ -3305,7 +3305,7 @@ class AlertingApi {
|
|
|
3305
3305
|
/**
|
|
3306
3306
|
* Alerting service.
|
|
3307
3307
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3308
|
-
* @version
|
|
3308
|
+
* @version 136.1.0
|
|
3309
3309
|
*/
|
|
3310
3310
|
|
|
3311
3311
|
/**
|
|
@@ -3619,7 +3619,7 @@ class AnalyticsApi {
|
|
|
3619
3619
|
/**
|
|
3620
3620
|
* Analytics service.
|
|
3621
3621
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3622
|
-
* @version
|
|
3622
|
+
* @version 136.1.0
|
|
3623
3623
|
*/
|
|
3624
3624
|
|
|
3625
3625
|
/**
|
|
@@ -4801,7 +4801,7 @@ class ArchitectApi {
|
|
|
4801
4801
|
/**
|
|
4802
4802
|
* Architect service.
|
|
4803
4803
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4804
|
-
* @version
|
|
4804
|
+
* @version 136.1.0
|
|
4805
4805
|
*/
|
|
4806
4806
|
|
|
4807
4807
|
/**
|
|
@@ -6565,6 +6565,35 @@ class ArchitectApi {
|
|
|
6565
6565
|
);
|
|
6566
6566
|
}
|
|
6567
6567
|
|
|
6568
|
+
/**
|
|
6569
|
+
* Fetch Architect Job Status
|
|
6570
|
+
*
|
|
6571
|
+
* @param {String} jobId Job ID
|
|
6572
|
+
* @param {Object} opts Optional parameters
|
|
6573
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
6574
|
+
*/
|
|
6575
|
+
getFlowsJob(jobId, opts) {
|
|
6576
|
+
opts = opts || {};
|
|
6577
|
+
|
|
6578
|
+
// verify the required parameter 'jobId' is set
|
|
6579
|
+
if (jobId === undefined || jobId === null) {
|
|
6580
|
+
throw 'Missing the required parameter "jobId" when calling getFlowsJob';
|
|
6581
|
+
}
|
|
6582
|
+
|
|
6583
|
+
return this.apiClient.callApi(
|
|
6584
|
+
'/api/v2/flows/jobs/{jobId}',
|
|
6585
|
+
'GET',
|
|
6586
|
+
{ 'jobId': jobId },
|
|
6587
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
6588
|
+
{ },
|
|
6589
|
+
{ },
|
|
6590
|
+
null,
|
|
6591
|
+
['PureCloud OAuth'],
|
|
6592
|
+
['application/json'],
|
|
6593
|
+
['application/json']
|
|
6594
|
+
);
|
|
6595
|
+
}
|
|
6596
|
+
|
|
6568
6597
|
/**
|
|
6569
6598
|
* Get a flow milestone
|
|
6570
6599
|
* Returns a specified flow milestone
|
|
@@ -7367,6 +7396,26 @@ class ArchitectApi {
|
|
|
7367
7396
|
);
|
|
7368
7397
|
}
|
|
7369
7398
|
|
|
7399
|
+
/**
|
|
7400
|
+
* 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.
|
|
7401
|
+
*
|
|
7402
|
+
*/
|
|
7403
|
+
postFlowsJobs() {
|
|
7404
|
+
|
|
7405
|
+
return this.apiClient.callApi(
|
|
7406
|
+
'/api/v2/flows/jobs',
|
|
7407
|
+
'POST',
|
|
7408
|
+
{ },
|
|
7409
|
+
{ },
|
|
7410
|
+
{ },
|
|
7411
|
+
{ },
|
|
7412
|
+
null,
|
|
7413
|
+
['PureCloud OAuth'],
|
|
7414
|
+
['application/json'],
|
|
7415
|
+
['application/json']
|
|
7416
|
+
);
|
|
7417
|
+
}
|
|
7418
|
+
|
|
7370
7419
|
/**
|
|
7371
7420
|
* Create a flow milestone
|
|
7372
7421
|
*
|
|
@@ -7797,7 +7846,7 @@ class AuditApi {
|
|
|
7797
7846
|
/**
|
|
7798
7847
|
* Audit service.
|
|
7799
7848
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
7800
|
-
* @version
|
|
7849
|
+
* @version 136.1.0
|
|
7801
7850
|
*/
|
|
7802
7851
|
|
|
7803
7852
|
/**
|
|
@@ -7968,7 +8017,7 @@ class AuthorizationApi {
|
|
|
7968
8017
|
/**
|
|
7969
8018
|
* Authorization service.
|
|
7970
8019
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
7971
|
-
* @version
|
|
8020
|
+
* @version 136.1.0
|
|
7972
8021
|
*/
|
|
7973
8022
|
|
|
7974
8023
|
/**
|
|
@@ -9151,7 +9200,7 @@ class BillingApi {
|
|
|
9151
9200
|
/**
|
|
9152
9201
|
* Billing service.
|
|
9153
9202
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9154
|
-
* @version
|
|
9203
|
+
* @version 136.1.0
|
|
9155
9204
|
*/
|
|
9156
9205
|
|
|
9157
9206
|
/**
|
|
@@ -9231,7 +9280,7 @@ class ChatApi {
|
|
|
9231
9280
|
/**
|
|
9232
9281
|
* Chat service.
|
|
9233
9282
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
9234
|
-
* @version
|
|
9283
|
+
* @version 136.1.0
|
|
9235
9284
|
*/
|
|
9236
9285
|
|
|
9237
9286
|
/**
|
|
@@ -9322,7 +9371,7 @@ class CoachingApi {
|
|
|
9322
9371
|
/**
|
|
9323
9372
|
* Coaching service.
|
|
9324
9373
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9325
|
-
* @version
|
|
9374
|
+
* @version 136.1.0
|
|
9326
9375
|
*/
|
|
9327
9376
|
|
|
9328
9377
|
/**
|
|
@@ -9899,7 +9948,7 @@ class ContentManagementApi {
|
|
|
9899
9948
|
/**
|
|
9900
9949
|
* ContentManagement service.
|
|
9901
9950
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
9902
|
-
* @version
|
|
9951
|
+
* @version 136.1.0
|
|
9903
9952
|
*/
|
|
9904
9953
|
|
|
9905
9954
|
/**
|
|
@@ -11039,7 +11088,7 @@ class ConversationsApi {
|
|
|
11039
11088
|
/**
|
|
11040
11089
|
* Conversations service.
|
|
11041
11090
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
11042
|
-
* @version
|
|
11091
|
+
* @version 136.1.0
|
|
11043
11092
|
*/
|
|
11044
11093
|
|
|
11045
11094
|
/**
|
|
@@ -12944,7 +12993,7 @@ class ConversationsApi {
|
|
|
12944
12993
|
/**
|
|
12945
12994
|
* Get a list of Messaging Stickers
|
|
12946
12995
|
*
|
|
12947
|
-
* @param {
|
|
12996
|
+
* @param {Object} messengerType Messenger Type
|
|
12948
12997
|
* @param {Object} opts Optional parameters
|
|
12949
12998
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
12950
12999
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
@@ -13132,7 +13181,7 @@ class ConversationsApi {
|
|
|
13132
13181
|
}
|
|
13133
13182
|
|
|
13134
13183
|
/**
|
|
13135
|
-
* Update a conversation by setting
|
|
13184
|
+
* Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
13136
13185
|
*
|
|
13137
13186
|
* @param {String} conversationId conversationId
|
|
13138
13187
|
* @param {Object} body Conversation
|
|
@@ -14118,8 +14167,8 @@ class ConversationsApi {
|
|
|
14118
14167
|
}
|
|
14119
14168
|
|
|
14120
14169
|
/**
|
|
14121
|
-
* Update or activate a WhatsApp messaging integration
|
|
14122
|
-
* The following steps are required in order to fully activate a
|
|
14170
|
+
* Update or activate a WhatsApp messaging integration
|
|
14171
|
+
* The following steps are required in order to fully activate a WhatsApp Integration: Initially, you will need to get an activation code by sending: an action set to Activate, and an authenticationMethod choosing from Sms or Voice. Finally, once you have been informed of an activation code on selected authenticationMethod, you will need to confirm the code by sending: an action set to Confirm, and the confirmationCode you have received from Whatsapp.
|
|
14123
14172
|
* @param {String} integrationId Integration ID
|
|
14124
14173
|
* @param {Object} body WhatsAppIntegrationUpdateRequest
|
|
14125
14174
|
*/
|
|
@@ -15703,7 +15752,7 @@ class DataExtensionsApi {
|
|
|
15703
15752
|
/**
|
|
15704
15753
|
* DataExtensions service.
|
|
15705
15754
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
15706
|
-
* @version
|
|
15755
|
+
* @version 136.1.0
|
|
15707
15756
|
*/
|
|
15708
15757
|
|
|
15709
15758
|
/**
|
|
@@ -15789,7 +15838,7 @@ class ExternalContactsApi {
|
|
|
15789
15838
|
/**
|
|
15790
15839
|
* ExternalContacts service.
|
|
15791
15840
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
15792
|
-
* @version
|
|
15841
|
+
* @version 136.1.0
|
|
15793
15842
|
*/
|
|
15794
15843
|
|
|
15795
15844
|
/**
|
|
@@ -17532,7 +17581,7 @@ class FaxApi {
|
|
|
17532
17581
|
/**
|
|
17533
17582
|
* Fax service.
|
|
17534
17583
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
17535
|
-
* @version
|
|
17584
|
+
* @version 136.1.0
|
|
17536
17585
|
*/
|
|
17537
17586
|
|
|
17538
17587
|
/**
|
|
@@ -17703,7 +17752,7 @@ class FlowsApi {
|
|
|
17703
17752
|
/**
|
|
17704
17753
|
* Flows service.
|
|
17705
17754
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
17706
|
-
* @version
|
|
17755
|
+
* @version 136.1.0
|
|
17707
17756
|
*/
|
|
17708
17757
|
|
|
17709
17758
|
/**
|
|
@@ -17774,7 +17823,7 @@ class GamificationApi {
|
|
|
17774
17823
|
/**
|
|
17775
17824
|
* Gamification service.
|
|
17776
17825
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
17777
|
-
* @version
|
|
17826
|
+
* @version 136.1.0
|
|
17778
17827
|
*/
|
|
17779
17828
|
|
|
17780
17829
|
/**
|
|
@@ -18020,18 +18069,18 @@ class GamificationApi {
|
|
|
18020
18069
|
/**
|
|
18021
18070
|
* Performance profile by id
|
|
18022
18071
|
*
|
|
18023
|
-
* @param {String} performanceProfileId
|
|
18072
|
+
* @param {String} profileId performanceProfileId
|
|
18024
18073
|
*/
|
|
18025
|
-
getGamificationProfile(
|
|
18026
|
-
// verify the required parameter '
|
|
18027
|
-
if (
|
|
18028
|
-
throw 'Missing the required parameter "
|
|
18074
|
+
getGamificationProfile(profileId) {
|
|
18075
|
+
// verify the required parameter 'profileId' is set
|
|
18076
|
+
if (profileId === undefined || profileId === null) {
|
|
18077
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationProfile';
|
|
18029
18078
|
}
|
|
18030
18079
|
|
|
18031
18080
|
return this.apiClient.callApi(
|
|
18032
|
-
'/api/v2/gamification/profiles/{
|
|
18081
|
+
'/api/v2/gamification/profiles/{profileId}',
|
|
18033
18082
|
'GET',
|
|
18034
|
-
{ '
|
|
18083
|
+
{ 'profileId': profileId },
|
|
18035
18084
|
{ },
|
|
18036
18085
|
{ },
|
|
18037
18086
|
{ },
|
|
@@ -18874,18 +18923,18 @@ class GamificationApi {
|
|
|
18874
18923
|
/**
|
|
18875
18924
|
* Activate a performance profile
|
|
18876
18925
|
*
|
|
18877
|
-
* @param {String} performanceProfileId
|
|
18926
|
+
* @param {String} profileId performanceProfileId
|
|
18878
18927
|
*/
|
|
18879
|
-
postGamificationProfileActivate(
|
|
18880
|
-
// verify the required parameter '
|
|
18881
|
-
if (
|
|
18882
|
-
throw 'Missing the required parameter "
|
|
18928
|
+
postGamificationProfileActivate(profileId) {
|
|
18929
|
+
// verify the required parameter 'profileId' is set
|
|
18930
|
+
if (profileId === undefined || profileId === null) {
|
|
18931
|
+
throw 'Missing the required parameter "profileId" when calling postGamificationProfileActivate';
|
|
18883
18932
|
}
|
|
18884
18933
|
|
|
18885
18934
|
return this.apiClient.callApi(
|
|
18886
|
-
'/api/v2/gamification/profiles/{
|
|
18935
|
+
'/api/v2/gamification/profiles/{profileId}/activate',
|
|
18887
18936
|
'POST',
|
|
18888
|
-
{ '
|
|
18937
|
+
{ 'profileId': profileId },
|
|
18889
18938
|
{ },
|
|
18890
18939
|
{ },
|
|
18891
18940
|
{ },
|
|
@@ -18899,18 +18948,18 @@ class GamificationApi {
|
|
|
18899
18948
|
/**
|
|
18900
18949
|
* Deactivate a performance profile
|
|
18901
18950
|
*
|
|
18902
|
-
* @param {String} performanceProfileId
|
|
18951
|
+
* @param {String} profileId performanceProfileId
|
|
18903
18952
|
*/
|
|
18904
|
-
postGamificationProfileDeactivate(
|
|
18905
|
-
// verify the required parameter '
|
|
18906
|
-
if (
|
|
18907
|
-
throw 'Missing the required parameter "
|
|
18953
|
+
postGamificationProfileDeactivate(profileId) {
|
|
18954
|
+
// verify the required parameter 'profileId' is set
|
|
18955
|
+
if (profileId === undefined || profileId === null) {
|
|
18956
|
+
throw 'Missing the required parameter "profileId" when calling postGamificationProfileDeactivate';
|
|
18908
18957
|
}
|
|
18909
18958
|
|
|
18910
18959
|
return this.apiClient.callApi(
|
|
18911
|
-
'/api/v2/gamification/profiles/{
|
|
18960
|
+
'/api/v2/gamification/profiles/{profileId}/deactivate',
|
|
18912
18961
|
'POST',
|
|
18913
|
-
{ '
|
|
18962
|
+
{ 'profileId': profileId },
|
|
18914
18963
|
{ },
|
|
18915
18964
|
{ },
|
|
18916
18965
|
{ },
|
|
@@ -19112,22 +19161,22 @@ class GamificationApi {
|
|
|
19112
19161
|
/**
|
|
19113
19162
|
* Updates a performance profile
|
|
19114
19163
|
*
|
|
19115
|
-
* @param {String} performanceProfileId
|
|
19164
|
+
* @param {String} profileId performanceProfileId
|
|
19116
19165
|
* @param {Object} opts Optional parameters
|
|
19117
19166
|
* @param {Object} opts.body performanceProfile
|
|
19118
19167
|
*/
|
|
19119
|
-
putGamificationProfile(
|
|
19168
|
+
putGamificationProfile(profileId, opts) {
|
|
19120
19169
|
opts = opts || {};
|
|
19121
19170
|
|
|
19122
|
-
// verify the required parameter '
|
|
19123
|
-
if (
|
|
19124
|
-
throw 'Missing the required parameter "
|
|
19171
|
+
// verify the required parameter 'profileId' is set
|
|
19172
|
+
if (profileId === undefined || profileId === null) {
|
|
19173
|
+
throw 'Missing the required parameter "profileId" when calling putGamificationProfile';
|
|
19125
19174
|
}
|
|
19126
19175
|
|
|
19127
19176
|
return this.apiClient.callApi(
|
|
19128
|
-
'/api/v2/gamification/profiles/{
|
|
19177
|
+
'/api/v2/gamification/profiles/{profileId}',
|
|
19129
19178
|
'PUT',
|
|
19130
|
-
{ '
|
|
19179
|
+
{ 'profileId': profileId },
|
|
19131
19180
|
{ },
|
|
19132
19181
|
{ },
|
|
19133
19182
|
{ },
|
|
@@ -19204,7 +19253,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
19204
19253
|
/**
|
|
19205
19254
|
* GeneralDataProtectionRegulation service.
|
|
19206
19255
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
19207
|
-
* @version
|
|
19256
|
+
* @version 136.1.0
|
|
19208
19257
|
*/
|
|
19209
19258
|
|
|
19210
19259
|
/**
|
|
@@ -19334,7 +19383,7 @@ class GeolocationApi {
|
|
|
19334
19383
|
/**
|
|
19335
19384
|
* Geolocation service.
|
|
19336
19385
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
19337
|
-
* @version
|
|
19386
|
+
* @version 136.1.0
|
|
19338
19387
|
*/
|
|
19339
19388
|
|
|
19340
19389
|
/**
|
|
@@ -19465,7 +19514,7 @@ class GreetingsApi {
|
|
|
19465
19514
|
/**
|
|
19466
19515
|
* Greetings service.
|
|
19467
19516
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
19468
|
-
* @version
|
|
19517
|
+
* @version 136.1.0
|
|
19469
19518
|
*/
|
|
19470
19519
|
|
|
19471
19520
|
/**
|
|
@@ -19920,7 +19969,7 @@ class GroupsApi {
|
|
|
19920
19969
|
/**
|
|
19921
19970
|
* Groups service.
|
|
19922
19971
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
19923
|
-
* @version
|
|
19972
|
+
* @version 136.1.0
|
|
19924
19973
|
*/
|
|
19925
19974
|
|
|
19926
19975
|
/**
|
|
@@ -20325,7 +20374,7 @@ class IdentityProviderApi {
|
|
|
20325
20374
|
/**
|
|
20326
20375
|
* IdentityProvider service.
|
|
20327
20376
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
20328
|
-
* @version
|
|
20377
|
+
* @version 136.1.0
|
|
20329
20378
|
*/
|
|
20330
20379
|
|
|
20331
20380
|
/**
|
|
@@ -21081,7 +21130,7 @@ class IntegrationsApi {
|
|
|
21081
21130
|
/**
|
|
21082
21131
|
* Integrations service.
|
|
21083
21132
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
21084
|
-
* @version
|
|
21133
|
+
* @version 136.1.0
|
|
21085
21134
|
*/
|
|
21086
21135
|
|
|
21087
21136
|
/**
|
|
@@ -21499,9 +21548,10 @@ class IntegrationsApi {
|
|
|
21499
21548
|
* @param {String} opts.previousPage Previous page token
|
|
21500
21549
|
* @param {String} opts.sortBy Root level field name to sort on.
|
|
21501
21550
|
* @param {Object} opts.sortOrder Direction to sort 'sortBy' field. (default to asc)
|
|
21502
|
-
* @param {String} opts.category Filter by category name
|
|
21503
|
-
* @param {String} opts.name Filter by
|
|
21504
|
-
* @param {
|
|
21551
|
+
* @param {String} opts.category Filter by category name.
|
|
21552
|
+
* @param {String} opts.name Filter by partial or complete action name.
|
|
21553
|
+
* @param {String} opts.ids Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids.
|
|
21554
|
+
* @param {Object} opts.secure Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions.
|
|
21505
21555
|
* @param {Object} opts.includeAuthActions Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. (default to false)
|
|
21506
21556
|
*/
|
|
21507
21557
|
getIntegrationsActions(opts) {
|
|
@@ -21512,7 +21562,7 @@ class IntegrationsApi {
|
|
|
21512
21562
|
'/api/v2/integrations/actions',
|
|
21513
21563
|
'GET',
|
|
21514
21564
|
{ },
|
|
21515
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'category': opts['category'],'name': opts['name'],'secure': opts['secure'],'includeAuthActions': opts['includeAuthActions'] },
|
|
21565
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'category': opts['category'],'name': opts['name'],'ids': opts['ids'],'secure': opts['secure'],'includeAuthActions': opts['includeAuthActions'] },
|
|
21516
21566
|
{ },
|
|
21517
21567
|
{ },
|
|
21518
21568
|
null,
|
|
@@ -21562,9 +21612,10 @@ class IntegrationsApi {
|
|
|
21562
21612
|
* @param {String} opts.previousPage Previous page token
|
|
21563
21613
|
* @param {String} opts.sortBy Root level field name to sort on.
|
|
21564
21614
|
* @param {Object} opts.sortOrder Direction to sort 'sortBy' field. (default to asc)
|
|
21565
|
-
* @param {String} opts.category Filter by category name
|
|
21566
|
-
* @param {String} opts.name Filter by
|
|
21567
|
-
* @param {
|
|
21615
|
+
* @param {String} opts.category Filter by category name.
|
|
21616
|
+
* @param {String} opts.name Filter by partial or complete action name.
|
|
21617
|
+
* @param {String} opts.ids Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids.
|
|
21618
|
+
* @param {Object} opts.secure Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions.
|
|
21568
21619
|
* @param {Object} opts.includeAuthActions Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. (default to false)
|
|
21569
21620
|
*/
|
|
21570
21621
|
getIntegrationsActionsDrafts(opts) {
|
|
@@ -21575,7 +21626,7 @@ class IntegrationsApi {
|
|
|
21575
21626
|
'/api/v2/integrations/actions/drafts',
|
|
21576
21627
|
'GET',
|
|
21577
21628
|
{ },
|
|
21578
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'category': opts['category'],'name': opts['name'],'secure': opts['secure'],'includeAuthActions': opts['includeAuthActions'] },
|
|
21629
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'category': opts['category'],'name': opts['name'],'ids': opts['ids'],'secure': opts['secure'],'includeAuthActions': opts['includeAuthActions'] },
|
|
21579
21630
|
{ },
|
|
21580
21631
|
{ },
|
|
21581
21632
|
null,
|
|
@@ -22756,7 +22807,7 @@ class JourneyApi {
|
|
|
22756
22807
|
/**
|
|
22757
22808
|
* Journey service.
|
|
22758
22809
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
22759
|
-
* @version
|
|
22810
|
+
* @version 136.1.0
|
|
22760
22811
|
*/
|
|
22761
22812
|
|
|
22762
22813
|
/**
|
|
@@ -23467,7 +23518,7 @@ class KnowledgeApi {
|
|
|
23467
23518
|
/**
|
|
23468
23519
|
* Knowledge service.
|
|
23469
23520
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
23470
|
-
* @version
|
|
23521
|
+
* @version 136.1.0
|
|
23471
23522
|
*/
|
|
23472
23523
|
|
|
23473
23524
|
/**
|
|
@@ -24367,7 +24418,7 @@ class LanguageUnderstandingApi {
|
|
|
24367
24418
|
/**
|
|
24368
24419
|
* LanguageUnderstanding service.
|
|
24369
24420
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
24370
|
-
* @version
|
|
24421
|
+
* @version 136.1.0
|
|
24371
24422
|
*/
|
|
24372
24423
|
|
|
24373
24424
|
/**
|
|
@@ -25271,7 +25322,7 @@ class LanguagesApi {
|
|
|
25271
25322
|
/**
|
|
25272
25323
|
* Languages service.
|
|
25273
25324
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
25274
|
-
* @version
|
|
25325
|
+
* @version 136.1.0
|
|
25275
25326
|
*/
|
|
25276
25327
|
|
|
25277
25328
|
/**
|
|
@@ -25539,7 +25590,7 @@ class LearningApi {
|
|
|
25539
25590
|
/**
|
|
25540
25591
|
* Learning service.
|
|
25541
25592
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
25542
|
-
* @version
|
|
25593
|
+
* @version 136.1.0
|
|
25543
25594
|
*/
|
|
25544
25595
|
|
|
25545
25596
|
/**
|
|
@@ -26130,7 +26181,7 @@ class LicenseApi {
|
|
|
26130
26181
|
/**
|
|
26131
26182
|
* License service.
|
|
26132
26183
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
26133
|
-
* @version
|
|
26184
|
+
* @version 136.1.0
|
|
26134
26185
|
*/
|
|
26135
26186
|
|
|
26136
26187
|
/**
|
|
@@ -26368,7 +26419,7 @@ class LocationsApi {
|
|
|
26368
26419
|
/**
|
|
26369
26420
|
* Locations service.
|
|
26370
26421
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
26371
|
-
* @version
|
|
26422
|
+
* @version 136.1.0
|
|
26372
26423
|
*/
|
|
26373
26424
|
|
|
26374
26425
|
/**
|
|
@@ -26604,7 +26655,7 @@ class MessagingApi {
|
|
|
26604
26655
|
/**
|
|
26605
26656
|
* Messaging service.
|
|
26606
26657
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
26607
|
-
* @version
|
|
26658
|
+
* @version 136.1.0
|
|
26608
26659
|
*/
|
|
26609
26660
|
|
|
26610
26661
|
/**
|
|
@@ -26755,7 +26806,7 @@ class MobileDevicesApi {
|
|
|
26755
26806
|
/**
|
|
26756
26807
|
* MobileDevices service.
|
|
26757
26808
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
26758
|
-
* @version
|
|
26809
|
+
* @version 136.1.0
|
|
26759
26810
|
*/
|
|
26760
26811
|
|
|
26761
26812
|
/**
|
|
@@ -26906,7 +26957,7 @@ class NotificationsApi {
|
|
|
26906
26957
|
/**
|
|
26907
26958
|
* Notifications service.
|
|
26908
26959
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
26909
|
-
* @version
|
|
26960
|
+
* @version 136.1.0
|
|
26910
26961
|
*/
|
|
26911
26962
|
|
|
26912
26963
|
/**
|
|
@@ -27131,7 +27182,7 @@ class OAuthApi {
|
|
|
27131
27182
|
/**
|
|
27132
27183
|
* OAuth service.
|
|
27133
27184
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
27134
|
-
* @version
|
|
27185
|
+
* @version 136.1.0
|
|
27135
27186
|
*/
|
|
27136
27187
|
|
|
27137
27188
|
/**
|
|
@@ -27497,7 +27548,7 @@ class ObjectsApi {
|
|
|
27497
27548
|
/**
|
|
27498
27549
|
* Objects service.
|
|
27499
27550
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
27500
|
-
* @version
|
|
27551
|
+
* @version 136.1.0
|
|
27501
27552
|
*/
|
|
27502
27553
|
|
|
27503
27554
|
/**
|
|
@@ -27768,7 +27819,7 @@ class OrganizationApi {
|
|
|
27768
27819
|
/**
|
|
27769
27820
|
* Organization service.
|
|
27770
27821
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
27771
|
-
* @version
|
|
27822
|
+
* @version 136.1.0
|
|
27772
27823
|
*/
|
|
27773
27824
|
|
|
27774
27825
|
/**
|
|
@@ -28171,7 +28222,7 @@ class OrganizationAuthorizationApi {
|
|
|
28171
28222
|
/**
|
|
28172
28223
|
* OrganizationAuthorization service.
|
|
28173
28224
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
28174
|
-
* @version
|
|
28225
|
+
* @version 136.1.0
|
|
28175
28226
|
*/
|
|
28176
28227
|
|
|
28177
28228
|
/**
|
|
@@ -29096,7 +29147,7 @@ class OutboundApi {
|
|
|
29096
29147
|
/**
|
|
29097
29148
|
* Outbound service.
|
|
29098
29149
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
29099
|
-
* @version
|
|
29150
|
+
* @version 136.1.0
|
|
29100
29151
|
*/
|
|
29101
29152
|
|
|
29102
29153
|
/**
|
|
@@ -29446,6 +29497,31 @@ class OutboundApi {
|
|
|
29446
29497
|
);
|
|
29447
29498
|
}
|
|
29448
29499
|
|
|
29500
|
+
/**
|
|
29501
|
+
* Reset messaging campaign progress and recycle the messaging campaign
|
|
29502
|
+
*
|
|
29503
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
29504
|
+
*/
|
|
29505
|
+
deleteOutboundMessagingcampaignProgress(messagingCampaignId) {
|
|
29506
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
29507
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
29508
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling deleteOutboundMessagingcampaignProgress';
|
|
29509
|
+
}
|
|
29510
|
+
|
|
29511
|
+
return this.apiClient.callApi(
|
|
29512
|
+
'/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress',
|
|
29513
|
+
'DELETE',
|
|
29514
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
29515
|
+
{ },
|
|
29516
|
+
{ },
|
|
29517
|
+
{ },
|
|
29518
|
+
null,
|
|
29519
|
+
['PureCloud OAuth'],
|
|
29520
|
+
['application/json'],
|
|
29521
|
+
['application/json']
|
|
29522
|
+
);
|
|
29523
|
+
}
|
|
29524
|
+
|
|
29449
29525
|
/**
|
|
29450
29526
|
* Delete a Rule Set.
|
|
29451
29527
|
*
|
|
@@ -29496,6 +29572,56 @@ class OutboundApi {
|
|
|
29496
29572
|
);
|
|
29497
29573
|
}
|
|
29498
29574
|
|
|
29575
|
+
/**
|
|
29576
|
+
* Delete an email campaign schedule.
|
|
29577
|
+
*
|
|
29578
|
+
* @param {String} emailCampaignId Email Campaign ID
|
|
29579
|
+
*/
|
|
29580
|
+
deleteOutboundSchedulesEmailcampaign(emailCampaignId) {
|
|
29581
|
+
// verify the required parameter 'emailCampaignId' is set
|
|
29582
|
+
if (emailCampaignId === undefined || emailCampaignId === null) {
|
|
29583
|
+
throw 'Missing the required parameter "emailCampaignId" when calling deleteOutboundSchedulesEmailcampaign';
|
|
29584
|
+
}
|
|
29585
|
+
|
|
29586
|
+
return this.apiClient.callApi(
|
|
29587
|
+
'/api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}',
|
|
29588
|
+
'DELETE',
|
|
29589
|
+
{ 'emailCampaignId': emailCampaignId },
|
|
29590
|
+
{ },
|
|
29591
|
+
{ },
|
|
29592
|
+
{ },
|
|
29593
|
+
null,
|
|
29594
|
+
['PureCloud OAuth'],
|
|
29595
|
+
['application/json'],
|
|
29596
|
+
['application/json']
|
|
29597
|
+
);
|
|
29598
|
+
}
|
|
29599
|
+
|
|
29600
|
+
/**
|
|
29601
|
+
* Delete a messaging campaign schedule.
|
|
29602
|
+
*
|
|
29603
|
+
* @param {String} messagingCampaignId Messaging Campaign ID
|
|
29604
|
+
*/
|
|
29605
|
+
deleteOutboundSchedulesMessagingcampaign(messagingCampaignId) {
|
|
29606
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
29607
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
29608
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling deleteOutboundSchedulesMessagingcampaign';
|
|
29609
|
+
}
|
|
29610
|
+
|
|
29611
|
+
return this.apiClient.callApi(
|
|
29612
|
+
'/api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}',
|
|
29613
|
+
'DELETE',
|
|
29614
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
29615
|
+
{ },
|
|
29616
|
+
{ },
|
|
29617
|
+
{ },
|
|
29618
|
+
null,
|
|
29619
|
+
['PureCloud OAuth'],
|
|
29620
|
+
['application/json'],
|
|
29621
|
+
['application/json']
|
|
29622
|
+
);
|
|
29623
|
+
}
|
|
29624
|
+
|
|
29499
29625
|
/**
|
|
29500
29626
|
* Delete a dialer sequence schedule.
|
|
29501
29627
|
*
|
|
@@ -30832,6 +30958,96 @@ class OutboundApi {
|
|
|
30832
30958
|
);
|
|
30833
30959
|
}
|
|
30834
30960
|
|
|
30961
|
+
/**
|
|
30962
|
+
* Get an email campaign schedule.
|
|
30963
|
+
*
|
|
30964
|
+
* @param {String} emailCampaignId Email Campaign ID
|
|
30965
|
+
*/
|
|
30966
|
+
getOutboundSchedulesEmailcampaign(emailCampaignId) {
|
|
30967
|
+
// verify the required parameter 'emailCampaignId' is set
|
|
30968
|
+
if (emailCampaignId === undefined || emailCampaignId === null) {
|
|
30969
|
+
throw 'Missing the required parameter "emailCampaignId" when calling getOutboundSchedulesEmailcampaign';
|
|
30970
|
+
}
|
|
30971
|
+
|
|
30972
|
+
return this.apiClient.callApi(
|
|
30973
|
+
'/api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}',
|
|
30974
|
+
'GET',
|
|
30975
|
+
{ 'emailCampaignId': emailCampaignId },
|
|
30976
|
+
{ },
|
|
30977
|
+
{ },
|
|
30978
|
+
{ },
|
|
30979
|
+
null,
|
|
30980
|
+
['PureCloud OAuth'],
|
|
30981
|
+
['application/json'],
|
|
30982
|
+
['application/json']
|
|
30983
|
+
);
|
|
30984
|
+
}
|
|
30985
|
+
|
|
30986
|
+
/**
|
|
30987
|
+
* Query for a list of email campaign schedules.
|
|
30988
|
+
*
|
|
30989
|
+
*/
|
|
30990
|
+
getOutboundSchedulesEmailcampaigns() {
|
|
30991
|
+
|
|
30992
|
+
return this.apiClient.callApi(
|
|
30993
|
+
'/api/v2/outbound/schedules/emailcampaigns',
|
|
30994
|
+
'GET',
|
|
30995
|
+
{ },
|
|
30996
|
+
{ },
|
|
30997
|
+
{ },
|
|
30998
|
+
{ },
|
|
30999
|
+
null,
|
|
31000
|
+
['PureCloud OAuth'],
|
|
31001
|
+
['application/json'],
|
|
31002
|
+
['application/json']
|
|
31003
|
+
);
|
|
31004
|
+
}
|
|
31005
|
+
|
|
31006
|
+
/**
|
|
31007
|
+
* Get a messaging campaign schedule.
|
|
31008
|
+
*
|
|
31009
|
+
* @param {String} messagingCampaignId Messaging Campaign ID
|
|
31010
|
+
*/
|
|
31011
|
+
getOutboundSchedulesMessagingcampaign(messagingCampaignId) {
|
|
31012
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
31013
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
31014
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling getOutboundSchedulesMessagingcampaign';
|
|
31015
|
+
}
|
|
31016
|
+
|
|
31017
|
+
return this.apiClient.callApi(
|
|
31018
|
+
'/api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}',
|
|
31019
|
+
'GET',
|
|
31020
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
31021
|
+
{ },
|
|
31022
|
+
{ },
|
|
31023
|
+
{ },
|
|
31024
|
+
null,
|
|
31025
|
+
['PureCloud OAuth'],
|
|
31026
|
+
['application/json'],
|
|
31027
|
+
['application/json']
|
|
31028
|
+
);
|
|
31029
|
+
}
|
|
31030
|
+
|
|
31031
|
+
/**
|
|
31032
|
+
* Query for a list of messaging campaign schedules.
|
|
31033
|
+
*
|
|
31034
|
+
*/
|
|
31035
|
+
getOutboundSchedulesMessagingcampaigns() {
|
|
31036
|
+
|
|
31037
|
+
return this.apiClient.callApi(
|
|
31038
|
+
'/api/v2/outbound/schedules/messagingcampaigns',
|
|
31039
|
+
'GET',
|
|
31040
|
+
{ },
|
|
31041
|
+
{ },
|
|
31042
|
+
{ },
|
|
31043
|
+
{ },
|
|
31044
|
+
null,
|
|
31045
|
+
['PureCloud OAuth'],
|
|
31046
|
+
['application/json'],
|
|
31047
|
+
['application/json']
|
|
31048
|
+
);
|
|
31049
|
+
}
|
|
31050
|
+
|
|
30835
31051
|
/**
|
|
30836
31052
|
* Get a dialer sequence schedule.
|
|
30837
31053
|
*
|
|
@@ -32035,6 +32251,66 @@ class OutboundApi {
|
|
|
32035
32251
|
);
|
|
32036
32252
|
}
|
|
32037
32253
|
|
|
32254
|
+
/**
|
|
32255
|
+
* Update an email campaign schedule.
|
|
32256
|
+
*
|
|
32257
|
+
* @param {String} emailCampaignId Email Campaign ID
|
|
32258
|
+
* @param {Object} body EmailCampaignSchedule
|
|
32259
|
+
*/
|
|
32260
|
+
putOutboundSchedulesEmailcampaign(emailCampaignId, body) {
|
|
32261
|
+
// verify the required parameter 'emailCampaignId' is set
|
|
32262
|
+
if (emailCampaignId === undefined || emailCampaignId === null) {
|
|
32263
|
+
throw 'Missing the required parameter "emailCampaignId" when calling putOutboundSchedulesEmailcampaign';
|
|
32264
|
+
}
|
|
32265
|
+
// verify the required parameter 'body' is set
|
|
32266
|
+
if (body === undefined || body === null) {
|
|
32267
|
+
throw 'Missing the required parameter "body" when calling putOutboundSchedulesEmailcampaign';
|
|
32268
|
+
}
|
|
32269
|
+
|
|
32270
|
+
return this.apiClient.callApi(
|
|
32271
|
+
'/api/v2/outbound/schedules/emailcampaigns/{emailCampaignId}',
|
|
32272
|
+
'PUT',
|
|
32273
|
+
{ 'emailCampaignId': emailCampaignId },
|
|
32274
|
+
{ },
|
|
32275
|
+
{ },
|
|
32276
|
+
{ },
|
|
32277
|
+
body,
|
|
32278
|
+
['PureCloud OAuth'],
|
|
32279
|
+
['application/json'],
|
|
32280
|
+
['application/json']
|
|
32281
|
+
);
|
|
32282
|
+
}
|
|
32283
|
+
|
|
32284
|
+
/**
|
|
32285
|
+
* Update a new messaging campaign schedule.
|
|
32286
|
+
*
|
|
32287
|
+
* @param {String} messagingCampaignId Messaging Campaign ID
|
|
32288
|
+
* @param {Object} body MessagingCampaignSchedule
|
|
32289
|
+
*/
|
|
32290
|
+
putOutboundSchedulesMessagingcampaign(messagingCampaignId, body) {
|
|
32291
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
32292
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
32293
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling putOutboundSchedulesMessagingcampaign';
|
|
32294
|
+
}
|
|
32295
|
+
// verify the required parameter 'body' is set
|
|
32296
|
+
if (body === undefined || body === null) {
|
|
32297
|
+
throw 'Missing the required parameter "body" when calling putOutboundSchedulesMessagingcampaign';
|
|
32298
|
+
}
|
|
32299
|
+
|
|
32300
|
+
return this.apiClient.callApi(
|
|
32301
|
+
'/api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId}',
|
|
32302
|
+
'PUT',
|
|
32303
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
32304
|
+
{ },
|
|
32305
|
+
{ },
|
|
32306
|
+
{ },
|
|
32307
|
+
body,
|
|
32308
|
+
['PureCloud OAuth'],
|
|
32309
|
+
['application/json'],
|
|
32310
|
+
['application/json']
|
|
32311
|
+
);
|
|
32312
|
+
}
|
|
32313
|
+
|
|
32038
32314
|
/**
|
|
32039
32315
|
* Update a new sequence schedule.
|
|
32040
32316
|
*
|
|
@@ -32126,7 +32402,7 @@ class PresenceApi {
|
|
|
32126
32402
|
/**
|
|
32127
32403
|
* Presence service.
|
|
32128
32404
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
32129
|
-
* @version
|
|
32405
|
+
* @version 136.1.0
|
|
32130
32406
|
*/
|
|
32131
32407
|
|
|
32132
32408
|
/**
|
|
@@ -32272,31 +32548,6 @@ class PresenceApi {
|
|
|
32272
32548
|
);
|
|
32273
32549
|
}
|
|
32274
32550
|
|
|
32275
|
-
/**
|
|
32276
|
-
* Get a user's Microsoft Teams presence.
|
|
32277
|
-
* Gets the presence for a Microsoft Teams user. This will return the Microsoft Teams presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.
|
|
32278
|
-
* @param {String} userId user Id
|
|
32279
|
-
*/
|
|
32280
|
-
getUserPresencesMicrosoftteams(userId) {
|
|
32281
|
-
// verify the required parameter 'userId' is set
|
|
32282
|
-
if (userId === undefined || userId === null) {
|
|
32283
|
-
throw 'Missing the required parameter "userId" when calling getUserPresencesMicrosoftteams';
|
|
32284
|
-
}
|
|
32285
|
-
|
|
32286
|
-
return this.apiClient.callApi(
|
|
32287
|
-
'/api/v2/users/{userId}/presences/microsoftteams',
|
|
32288
|
-
'GET',
|
|
32289
|
-
{ 'userId': userId },
|
|
32290
|
-
{ },
|
|
32291
|
-
{ },
|
|
32292
|
-
{ },
|
|
32293
|
-
null,
|
|
32294
|
-
['PureCloud OAuth'],
|
|
32295
|
-
['application/json'],
|
|
32296
|
-
['application/json']
|
|
32297
|
-
);
|
|
32298
|
-
}
|
|
32299
|
-
|
|
32300
32551
|
/**
|
|
32301
32552
|
* Get a user's Genesys Cloud presence.
|
|
32302
32553
|
* Get the default Genesys Cloud user presence source PURECLOUD
|
|
@@ -32322,31 +32573,6 @@ class PresenceApi {
|
|
|
32322
32573
|
);
|
|
32323
32574
|
}
|
|
32324
32575
|
|
|
32325
|
-
/**
|
|
32326
|
-
* Get a user's Zoom Phone presence.
|
|
32327
|
-
* Gets the presence for a Zoom user. This will return the Zoom Phone presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.
|
|
32328
|
-
* @param {String} userId user Id
|
|
32329
|
-
*/
|
|
32330
|
-
getUserPresencesZoomphone(userId) {
|
|
32331
|
-
// verify the required parameter 'userId' is set
|
|
32332
|
-
if (userId === undefined || userId === null) {
|
|
32333
|
-
throw 'Missing the required parameter "userId" when calling getUserPresencesZoomphone';
|
|
32334
|
-
}
|
|
32335
|
-
|
|
32336
|
-
return this.apiClient.callApi(
|
|
32337
|
-
'/api/v2/users/{userId}/presences/zoomphone',
|
|
32338
|
-
'GET',
|
|
32339
|
-
{ 'userId': userId },
|
|
32340
|
-
{ },
|
|
32341
|
-
{ },
|
|
32342
|
-
{ },
|
|
32343
|
-
null,
|
|
32344
|
-
['PureCloud OAuth'],
|
|
32345
|
-
['application/json'],
|
|
32346
|
-
['application/json']
|
|
32347
|
-
);
|
|
32348
|
-
}
|
|
32349
|
-
|
|
32350
32576
|
/**
|
|
32351
32577
|
* Patch a user's Presence
|
|
32352
32578
|
* Patch a user's presence for the specified source that is not specifically listed. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
|
|
@@ -32498,7 +32724,7 @@ class QualityApi {
|
|
|
32498
32724
|
/**
|
|
32499
32725
|
* Quality service.
|
|
32500
32726
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
32501
|
-
* @version
|
|
32727
|
+
* @version 136.1.0
|
|
32502
32728
|
*/
|
|
32503
32729
|
|
|
32504
32730
|
/**
|
|
@@ -34076,7 +34302,7 @@ class RecordingApi {
|
|
|
34076
34302
|
/**
|
|
34077
34303
|
* Recording service.
|
|
34078
34304
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
34079
|
-
* @version
|
|
34305
|
+
* @version 136.1.0
|
|
34080
34306
|
*/
|
|
34081
34307
|
|
|
34082
34308
|
/**
|
|
@@ -34599,6 +34825,7 @@ class RecordingApi {
|
|
|
34599
34825
|
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
34600
34826
|
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
34601
34827
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
34828
|
+
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
34602
34829
|
*/
|
|
34603
34830
|
getRecordingCrossplatformMediaretentionpolicies(opts) {
|
|
34604
34831
|
opts = opts || {};
|
|
@@ -34608,7 +34835,7 @@ class RecordingApi {
|
|
|
34608
34835
|
'/api/v2/recording/crossplatform/mediaretentionpolicies',
|
|
34609
34836
|
'GET',
|
|
34610
34837
|
{ },
|
|
34611
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'] },
|
|
34838
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'],'deleteDaysThreshold': opts['deleteDaysThreshold'] },
|
|
34612
34839
|
{ },
|
|
34613
34840
|
{ },
|
|
34614
34841
|
null,
|
|
@@ -34731,6 +34958,51 @@ class RecordingApi {
|
|
|
34731
34958
|
);
|
|
34732
34959
|
}
|
|
34733
34960
|
|
|
34961
|
+
/**
|
|
34962
|
+
* Get the encryption key configurations
|
|
34963
|
+
*
|
|
34964
|
+
* @param {String} keyConfigurationId Key Configurations Id
|
|
34965
|
+
*/
|
|
34966
|
+
getRecordingKeyconfiguration(keyConfigurationId) {
|
|
34967
|
+
// verify the required parameter 'keyConfigurationId' is set
|
|
34968
|
+
if (keyConfigurationId === undefined || keyConfigurationId === null) {
|
|
34969
|
+
throw 'Missing the required parameter "keyConfigurationId" when calling getRecordingKeyconfiguration';
|
|
34970
|
+
}
|
|
34971
|
+
|
|
34972
|
+
return this.apiClient.callApi(
|
|
34973
|
+
'/api/v2/recording/keyconfigurations/{keyConfigurationId}',
|
|
34974
|
+
'GET',
|
|
34975
|
+
{ 'keyConfigurationId': keyConfigurationId },
|
|
34976
|
+
{ },
|
|
34977
|
+
{ },
|
|
34978
|
+
{ },
|
|
34979
|
+
null,
|
|
34980
|
+
['PureCloud OAuth'],
|
|
34981
|
+
['application/json'],
|
|
34982
|
+
['application/json']
|
|
34983
|
+
);
|
|
34984
|
+
}
|
|
34985
|
+
|
|
34986
|
+
/**
|
|
34987
|
+
* Get a list of key configurations data
|
|
34988
|
+
*
|
|
34989
|
+
*/
|
|
34990
|
+
getRecordingKeyconfigurations() {
|
|
34991
|
+
|
|
34992
|
+
return this.apiClient.callApi(
|
|
34993
|
+
'/api/v2/recording/keyconfigurations',
|
|
34994
|
+
'GET',
|
|
34995
|
+
{ },
|
|
34996
|
+
{ },
|
|
34997
|
+
{ },
|
|
34998
|
+
{ },
|
|
34999
|
+
null,
|
|
35000
|
+
['PureCloud OAuth'],
|
|
35001
|
+
['application/json'],
|
|
35002
|
+
['application/json']
|
|
35003
|
+
);
|
|
35004
|
+
}
|
|
35005
|
+
|
|
34734
35006
|
/**
|
|
34735
35007
|
* Get the local encryption settings
|
|
34736
35008
|
*
|
|
@@ -34790,6 +35062,7 @@ class RecordingApi {
|
|
|
34790
35062
|
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
34791
35063
|
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
34792
35064
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
35065
|
+
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
34793
35066
|
*/
|
|
34794
35067
|
getRecordingMediaretentionpolicies(opts) {
|
|
34795
35068
|
opts = opts || {};
|
|
@@ -34799,7 +35072,7 @@ class RecordingApi {
|
|
|
34799
35072
|
'/api/v2/recording/mediaretentionpolicies',
|
|
34800
35073
|
'GET',
|
|
34801
35074
|
{ },
|
|
34802
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'] },
|
|
35075
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'],'deleteDaysThreshold': opts['deleteDaysThreshold'] },
|
|
34803
35076
|
{ },
|
|
34804
35077
|
{ },
|
|
34805
35078
|
null,
|
|
@@ -35103,8 +35376,8 @@ class RecordingApi {
|
|
|
35103
35376
|
}
|
|
35104
35377
|
|
|
35105
35378
|
/**
|
|
35106
|
-
* Create a recording bulk job
|
|
35107
|
-
*
|
|
35379
|
+
* Create a recording bulk job.
|
|
35380
|
+
* Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state.
|
|
35108
35381
|
* @param {Object} body query
|
|
35109
35382
|
*/
|
|
35110
35383
|
postRecordingJobs(body) {
|
|
@@ -35127,6 +35400,56 @@ class RecordingApi {
|
|
|
35127
35400
|
);
|
|
35128
35401
|
}
|
|
35129
35402
|
|
|
35403
|
+
/**
|
|
35404
|
+
* Setup configurations for encryption key creation
|
|
35405
|
+
*
|
|
35406
|
+
* @param {Object} body Encryption Configuration
|
|
35407
|
+
*/
|
|
35408
|
+
postRecordingKeyconfigurations(body) {
|
|
35409
|
+
// verify the required parameter 'body' is set
|
|
35410
|
+
if (body === undefined || body === null) {
|
|
35411
|
+
throw 'Missing the required parameter "body" when calling postRecordingKeyconfigurations';
|
|
35412
|
+
}
|
|
35413
|
+
|
|
35414
|
+
return this.apiClient.callApi(
|
|
35415
|
+
'/api/v2/recording/keyconfigurations',
|
|
35416
|
+
'POST',
|
|
35417
|
+
{ },
|
|
35418
|
+
{ },
|
|
35419
|
+
{ },
|
|
35420
|
+
{ },
|
|
35421
|
+
body,
|
|
35422
|
+
['PureCloud OAuth'],
|
|
35423
|
+
['application/json'],
|
|
35424
|
+
['application/json']
|
|
35425
|
+
);
|
|
35426
|
+
}
|
|
35427
|
+
|
|
35428
|
+
/**
|
|
35429
|
+
* Validate encryption key configurations without saving it
|
|
35430
|
+
*
|
|
35431
|
+
* @param {Object} body Encryption Configuration
|
|
35432
|
+
*/
|
|
35433
|
+
postRecordingKeyconfigurationsValidate(body) {
|
|
35434
|
+
// verify the required parameter 'body' is set
|
|
35435
|
+
if (body === undefined || body === null) {
|
|
35436
|
+
throw 'Missing the required parameter "body" when calling postRecordingKeyconfigurationsValidate';
|
|
35437
|
+
}
|
|
35438
|
+
|
|
35439
|
+
return this.apiClient.callApi(
|
|
35440
|
+
'/api/v2/recording/keyconfigurations/validate',
|
|
35441
|
+
'POST',
|
|
35442
|
+
{ },
|
|
35443
|
+
{ },
|
|
35444
|
+
{ },
|
|
35445
|
+
{ },
|
|
35446
|
+
body,
|
|
35447
|
+
['PureCloud OAuth'],
|
|
35448
|
+
['application/json'],
|
|
35449
|
+
['application/json']
|
|
35450
|
+
);
|
|
35451
|
+
}
|
|
35452
|
+
|
|
35130
35453
|
/**
|
|
35131
35454
|
* create a local recording key
|
|
35132
35455
|
*
|
|
@@ -35461,6 +35784,36 @@ class RecordingApi {
|
|
|
35461
35784
|
);
|
|
35462
35785
|
}
|
|
35463
35786
|
|
|
35787
|
+
/**
|
|
35788
|
+
* Update the encryption key configurations
|
|
35789
|
+
*
|
|
35790
|
+
* @param {String} keyConfigurationId Key Configurations Id
|
|
35791
|
+
* @param {Object} body Encryption key configuration metadata
|
|
35792
|
+
*/
|
|
35793
|
+
putRecordingKeyconfiguration(keyConfigurationId, body) {
|
|
35794
|
+
// verify the required parameter 'keyConfigurationId' is set
|
|
35795
|
+
if (keyConfigurationId === undefined || keyConfigurationId === null) {
|
|
35796
|
+
throw 'Missing the required parameter "keyConfigurationId" when calling putRecordingKeyconfiguration';
|
|
35797
|
+
}
|
|
35798
|
+
// verify the required parameter 'body' is set
|
|
35799
|
+
if (body === undefined || body === null) {
|
|
35800
|
+
throw 'Missing the required parameter "body" when calling putRecordingKeyconfiguration';
|
|
35801
|
+
}
|
|
35802
|
+
|
|
35803
|
+
return this.apiClient.callApi(
|
|
35804
|
+
'/api/v2/recording/keyconfigurations/{keyConfigurationId}',
|
|
35805
|
+
'PUT',
|
|
35806
|
+
{ 'keyConfigurationId': keyConfigurationId },
|
|
35807
|
+
{ },
|
|
35808
|
+
{ },
|
|
35809
|
+
{ },
|
|
35810
|
+
body,
|
|
35811
|
+
['PureCloud OAuth'],
|
|
35812
|
+
['application/json'],
|
|
35813
|
+
['application/json']
|
|
35814
|
+
);
|
|
35815
|
+
}
|
|
35816
|
+
|
|
35464
35817
|
/**
|
|
35465
35818
|
* Update the local encryption settings
|
|
35466
35819
|
*
|
|
@@ -35602,7 +35955,7 @@ class ResponseManagementApi {
|
|
|
35602
35955
|
/**
|
|
35603
35956
|
* ResponseManagement service.
|
|
35604
35957
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
35605
|
-
* @version
|
|
35958
|
+
* @version 136.1.0
|
|
35606
35959
|
*/
|
|
35607
35960
|
|
|
35608
35961
|
/**
|
|
@@ -36086,7 +36439,7 @@ class RoutingApi {
|
|
|
36086
36439
|
/**
|
|
36087
36440
|
* Routing service.
|
|
36088
36441
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
36089
|
-
* @version
|
|
36442
|
+
* @version 136.1.0
|
|
36090
36443
|
*/
|
|
36091
36444
|
|
|
36092
36445
|
/**
|
|
@@ -36745,14 +37098,18 @@ class RoutingApi {
|
|
|
36745
37098
|
/**
|
|
36746
37099
|
* Get domains
|
|
36747
37100
|
*
|
|
37101
|
+
* @param {Object} opts Optional parameters
|
|
37102
|
+
* @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
|
|
36748
37103
|
*/
|
|
36749
|
-
getRoutingEmailDomains() {
|
|
37104
|
+
getRoutingEmailDomains(opts) {
|
|
37105
|
+
opts = opts || {};
|
|
37106
|
+
|
|
36750
37107
|
|
|
36751
37108
|
return this.apiClient.callApi(
|
|
36752
37109
|
'/api/v2/routing/email/domains',
|
|
36753
37110
|
'GET',
|
|
36754
37111
|
{ },
|
|
36755
|
-
{
|
|
37112
|
+
{ 'excludeStatus': opts['excludeStatus'] },
|
|
36756
37113
|
{ },
|
|
36757
37114
|
{ },
|
|
36758
37115
|
null,
|
|
@@ -39009,7 +39366,7 @@ class SCIMApi {
|
|
|
39009
39366
|
/**
|
|
39010
39367
|
* SCIM service.
|
|
39011
39368
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
39012
|
-
* @version
|
|
39369
|
+
* @version 136.1.0
|
|
39013
39370
|
*/
|
|
39014
39371
|
|
|
39015
39372
|
/**
|
|
@@ -39886,7 +40243,7 @@ class ScriptsApi {
|
|
|
39886
40243
|
/**
|
|
39887
40244
|
* Scripts service.
|
|
39888
40245
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
39889
|
-
* @version
|
|
40246
|
+
* @version 136.1.0
|
|
39890
40247
|
*/
|
|
39891
40248
|
|
|
39892
40249
|
/**
|
|
@@ -40002,6 +40359,7 @@ class ScriptsApi {
|
|
|
40002
40359
|
* @param {Object} opts.sortBy SortBy
|
|
40003
40360
|
* @param {Object} opts.sortOrder SortOrder
|
|
40004
40361
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
40362
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
40005
40363
|
*/
|
|
40006
40364
|
getScripts(opts) {
|
|
40007
40365
|
opts = opts || {};
|
|
@@ -40011,7 +40369,40 @@ class ScriptsApi {
|
|
|
40011
40369
|
'/api/v2/scripts',
|
|
40012
40370
|
'GET',
|
|
40013
40371
|
{ },
|
|
40014
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'scriptDataVersion': opts['scriptDataVersion'] },
|
|
40372
|
+
{ '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'] },
|
|
40373
|
+
{ },
|
|
40374
|
+
{ },
|
|
40375
|
+
null,
|
|
40376
|
+
['PureCloud OAuth'],
|
|
40377
|
+
['application/json'],
|
|
40378
|
+
['application/json']
|
|
40379
|
+
);
|
|
40380
|
+
}
|
|
40381
|
+
|
|
40382
|
+
/**
|
|
40383
|
+
* Get the metadata for a list of scripts
|
|
40384
|
+
*
|
|
40385
|
+
* @param {Object} opts Optional parameters
|
|
40386
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
40387
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
40388
|
+
* @param {String} opts.expand Expand
|
|
40389
|
+
* @param {String} opts.name Name filter
|
|
40390
|
+
* @param {String} opts.feature Feature filter
|
|
40391
|
+
* @param {String} opts.flowId Secure flow id filter
|
|
40392
|
+
* @param {Object} opts.sortBy SortBy
|
|
40393
|
+
* @param {Object} opts.sortOrder SortOrder
|
|
40394
|
+
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
40395
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
40396
|
+
*/
|
|
40397
|
+
getScriptsDivisionviews(opts) {
|
|
40398
|
+
opts = opts || {};
|
|
40399
|
+
|
|
40400
|
+
|
|
40401
|
+
return this.apiClient.callApi(
|
|
40402
|
+
'/api/v2/scripts/divisionviews',
|
|
40403
|
+
'GET',
|
|
40404
|
+
{ },
|
|
40405
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
40015
40406
|
{ },
|
|
40016
40407
|
{ },
|
|
40017
40408
|
null,
|
|
@@ -40032,6 +40423,7 @@ class ScriptsApi {
|
|
|
40032
40423
|
* @param {String} opts.feature Feature filter
|
|
40033
40424
|
* @param {String} opts.flowId Secure flow id filter
|
|
40034
40425
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
40426
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
40035
40427
|
*/
|
|
40036
40428
|
getScriptsPublished(opts) {
|
|
40037
40429
|
opts = opts || {};
|
|
@@ -40041,7 +40433,38 @@ class ScriptsApi {
|
|
|
40041
40433
|
'/api/v2/scripts/published',
|
|
40042
40434
|
'GET',
|
|
40043
40435
|
{ },
|
|
40044
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'] },
|
|
40436
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
40437
|
+
{ },
|
|
40438
|
+
{ },
|
|
40439
|
+
null,
|
|
40440
|
+
['PureCloud OAuth'],
|
|
40441
|
+
['application/json'],
|
|
40442
|
+
['application/json']
|
|
40443
|
+
);
|
|
40444
|
+
}
|
|
40445
|
+
|
|
40446
|
+
/**
|
|
40447
|
+
* Get the published scripts metadata.
|
|
40448
|
+
*
|
|
40449
|
+
* @param {Object} opts Optional parameters
|
|
40450
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
40451
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
40452
|
+
* @param {String} opts.expand Expand
|
|
40453
|
+
* @param {String} opts.name Name filter
|
|
40454
|
+
* @param {String} opts.feature Feature filter
|
|
40455
|
+
* @param {String} opts.flowId Secure flow id filter
|
|
40456
|
+
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
40457
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
40458
|
+
*/
|
|
40459
|
+
getScriptsPublishedDivisionviews(opts) {
|
|
40460
|
+
opts = opts || {};
|
|
40461
|
+
|
|
40462
|
+
|
|
40463
|
+
return this.apiClient.callApi(
|
|
40464
|
+
'/api/v2/scripts/published/divisionviews',
|
|
40465
|
+
'GET',
|
|
40466
|
+
{ },
|
|
40467
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
40045
40468
|
{ },
|
|
40046
40469
|
{ },
|
|
40047
40470
|
null,
|
|
@@ -40239,7 +40662,7 @@ class SearchApi {
|
|
|
40239
40662
|
/**
|
|
40240
40663
|
* Search service.
|
|
40241
40664
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
40242
|
-
* @version
|
|
40665
|
+
* @version 136.1.0
|
|
40243
40666
|
*/
|
|
40244
40667
|
|
|
40245
40668
|
/**
|
|
@@ -40774,7 +41197,7 @@ class SpeechTextAnalyticsApi {
|
|
|
40774
41197
|
/**
|
|
40775
41198
|
* SpeechTextAnalytics service.
|
|
40776
41199
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
40777
|
-
* @version
|
|
41200
|
+
* @version 136.1.0
|
|
40778
41201
|
*/
|
|
40779
41202
|
|
|
40780
41203
|
/**
|
|
@@ -41627,7 +42050,7 @@ class StationsApi {
|
|
|
41627
42050
|
/**
|
|
41628
42051
|
* Stations service.
|
|
41629
42052
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
41630
|
-
* @version
|
|
42053
|
+
* @version 136.1.0
|
|
41631
42054
|
*/
|
|
41632
42055
|
|
|
41633
42056
|
/**
|
|
@@ -41774,7 +42197,7 @@ class SuggestApi {
|
|
|
41774
42197
|
/**
|
|
41775
42198
|
* Suggest service.
|
|
41776
42199
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
41777
|
-
* @version
|
|
42200
|
+
* @version 136.1.0
|
|
41778
42201
|
*/
|
|
41779
42202
|
|
|
41780
42203
|
/**
|
|
@@ -41913,7 +42336,7 @@ class TelephonyApi {
|
|
|
41913
42336
|
/**
|
|
41914
42337
|
* Telephony service.
|
|
41915
42338
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
41916
|
-
* @version
|
|
42339
|
+
* @version 136.1.0
|
|
41917
42340
|
*/
|
|
41918
42341
|
|
|
41919
42342
|
/**
|
|
@@ -42021,7 +42444,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
42021
42444
|
/**
|
|
42022
42445
|
* TelephonyProvidersEdge service.
|
|
42023
42446
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
42024
|
-
* @version
|
|
42447
|
+
* @version 136.1.0
|
|
42025
42448
|
*/
|
|
42026
42449
|
|
|
42027
42450
|
/**
|
|
@@ -43436,7 +43859,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
43436
43859
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
43437
43860
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
43438
43861
|
* @param {String} opts.sortBy Sort by
|
|
43439
|
-
* @param {String} opts._number
|
|
43862
|
+
* @param {String} opts._number Deprecated, filtering by number not supported
|
|
43440
43863
|
*/
|
|
43441
43864
|
getTelephonyProvidersEdgesExtensionpools(opts) {
|
|
43442
43865
|
opts = opts || {};
|
|
@@ -45654,7 +46077,7 @@ class TextbotsApi {
|
|
|
45654
46077
|
/**
|
|
45655
46078
|
* Textbots service.
|
|
45656
46079
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
45657
|
-
* @version
|
|
46080
|
+
* @version 136.1.0
|
|
45658
46081
|
*/
|
|
45659
46082
|
|
|
45660
46083
|
/**
|
|
@@ -45782,7 +46205,7 @@ class TokensApi {
|
|
|
45782
46205
|
/**
|
|
45783
46206
|
* Tokens service.
|
|
45784
46207
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
45785
|
-
* @version
|
|
46208
|
+
* @version 136.1.0
|
|
45786
46209
|
*/
|
|
45787
46210
|
|
|
45788
46211
|
/**
|
|
@@ -45888,7 +46311,7 @@ class UploadsApi {
|
|
|
45888
46311
|
/**
|
|
45889
46312
|
* Uploads service.
|
|
45890
46313
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
45891
|
-
* @version
|
|
46314
|
+
* @version 136.1.0
|
|
45892
46315
|
*/
|
|
45893
46316
|
|
|
45894
46317
|
/**
|
|
@@ -46039,7 +46462,7 @@ class UsageApi {
|
|
|
46039
46462
|
/**
|
|
46040
46463
|
* Usage service.
|
|
46041
46464
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
46042
|
-
* @version
|
|
46465
|
+
* @version 136.1.0
|
|
46043
46466
|
*/
|
|
46044
46467
|
|
|
46045
46468
|
/**
|
|
@@ -46110,7 +46533,7 @@ class UserRecordingsApi {
|
|
|
46110
46533
|
/**
|
|
46111
46534
|
* UserRecordings service.
|
|
46112
46535
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
46113
|
-
* @version
|
|
46536
|
+
* @version 136.1.0
|
|
46114
46537
|
*/
|
|
46115
46538
|
|
|
46116
46539
|
/**
|
|
@@ -46294,7 +46717,7 @@ class UsersApi {
|
|
|
46294
46717
|
/**
|
|
46295
46718
|
* Users service.
|
|
46296
46719
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
46297
|
-
* @version
|
|
46720
|
+
* @version 136.1.0
|
|
46298
46721
|
*/
|
|
46299
46722
|
|
|
46300
46723
|
/**
|
|
@@ -48596,7 +49019,7 @@ class UtilitiesApi {
|
|
|
48596
49019
|
/**
|
|
48597
49020
|
* Utilities service.
|
|
48598
49021
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
48599
|
-
* @version
|
|
49022
|
+
* @version 136.1.0
|
|
48600
49023
|
*/
|
|
48601
49024
|
|
|
48602
49025
|
/**
|
|
@@ -48707,7 +49130,7 @@ class VoicemailApi {
|
|
|
48707
49130
|
/**
|
|
48708
49131
|
* Voicemail service.
|
|
48709
49132
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
48710
|
-
* @version
|
|
49133
|
+
* @version 136.1.0
|
|
48711
49134
|
*/
|
|
48712
49135
|
|
|
48713
49136
|
/**
|
|
@@ -49374,7 +49797,7 @@ class WebChatApi {
|
|
|
49374
49797
|
/**
|
|
49375
49798
|
* WebChat service.
|
|
49376
49799
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
49377
|
-
* @version
|
|
49800
|
+
* @version 136.1.0
|
|
49378
49801
|
*/
|
|
49379
49802
|
|
|
49380
49803
|
/**
|
|
@@ -49918,7 +50341,7 @@ class WebDeploymentsApi {
|
|
|
49918
50341
|
/**
|
|
49919
50342
|
* WebDeployments service.
|
|
49920
50343
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
49921
|
-
* @version
|
|
50344
|
+
* @version 136.1.0
|
|
49922
50345
|
*/
|
|
49923
50346
|
|
|
49924
50347
|
/**
|
|
@@ -50273,7 +50696,7 @@ class WebMessagingApi {
|
|
|
50273
50696
|
/**
|
|
50274
50697
|
* WebMessaging service.
|
|
50275
50698
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
50276
|
-
* @version
|
|
50699
|
+
* @version 136.1.0
|
|
50277
50700
|
*/
|
|
50278
50701
|
|
|
50279
50702
|
/**
|
|
@@ -50319,7 +50742,7 @@ class WidgetsApi {
|
|
|
50319
50742
|
/**
|
|
50320
50743
|
* Widgets service.
|
|
50321
50744
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
50322
|
-
* @version
|
|
50745
|
+
* @version 136.1.0
|
|
50323
50746
|
*/
|
|
50324
50747
|
|
|
50325
50748
|
/**
|
|
@@ -50465,7 +50888,7 @@ class WorkforceManagementApi {
|
|
|
50465
50888
|
/**
|
|
50466
50889
|
* WorkforceManagement service.
|
|
50467
50890
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
50468
|
-
* @version
|
|
50891
|
+
* @version 136.1.0
|
|
50469
50892
|
*/
|
|
50470
50893
|
|
|
50471
50894
|
/**
|
|
@@ -50663,7 +51086,7 @@ class WorkforceManagementApi {
|
|
|
50663
51086
|
/**
|
|
50664
51087
|
* Delete a short term forecast
|
|
50665
51088
|
* Must not be tied to any schedules
|
|
50666
|
-
* @param {String} businessUnitId The
|
|
51089
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
50667
51090
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
50668
51091
|
* @param {String} forecastId The ID of the forecast
|
|
50669
51092
|
*/
|
|
@@ -50743,7 +51166,7 @@ class WorkforceManagementApi {
|
|
|
50743
51166
|
/**
|
|
50744
51167
|
* Deletes a time off limit object
|
|
50745
51168
|
*
|
|
50746
|
-
* @param {String} managementUnitId The
|
|
51169
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
50747
51170
|
* @param {String} timeOffLimitId The ID of the time off limit object to delete
|
|
50748
51171
|
*/
|
|
50749
51172
|
deleteWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
@@ -50773,7 +51196,7 @@ class WorkforceManagementApi {
|
|
|
50773
51196
|
/**
|
|
50774
51197
|
* Deletes a time off plan
|
|
50775
51198
|
*
|
|
50776
|
-
* @param {String} managementUnitId The management unit
|
|
51199
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
50777
51200
|
* @param {String} timeOffPlanId The ID of the time off plan to delete
|
|
50778
51201
|
*/
|
|
50779
51202
|
deleteWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
@@ -51042,7 +51465,7 @@ class WorkforceManagementApi {
|
|
|
51042
51465
|
/**
|
|
51043
51466
|
* Get intraday planning groups for the given date
|
|
51044
51467
|
*
|
|
51045
|
-
* @param {String} businessUnitId The
|
|
51468
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
51046
51469
|
* @param {String} _date yyyy-MM-dd date string interpreted in the configured business unit time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51047
51470
|
*/
|
|
51048
51471
|
getWorkforcemanagementBusinessunitIntradayPlanninggroups(businessUnitId, _date) {
|
|
@@ -51495,7 +51918,7 @@ class WorkforceManagementApi {
|
|
|
51495
51918
|
/**
|
|
51496
51919
|
* Get a short term forecast
|
|
51497
51920
|
*
|
|
51498
|
-
* @param {String} businessUnitId The
|
|
51921
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51499
51922
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51500
51923
|
* @param {String} forecastId The ID of the forecast
|
|
51501
51924
|
* @param {Object} opts Optional parameters
|
|
@@ -51534,7 +51957,7 @@ class WorkforceManagementApi {
|
|
|
51534
51957
|
/**
|
|
51535
51958
|
* Get the result of a short term forecast calculation
|
|
51536
51959
|
* Includes modifications unless you pass the doNotApplyModifications query parameter
|
|
51537
|
-
* @param {String} businessUnitId The
|
|
51960
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51538
51961
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51539
51962
|
* @param {String} forecastId The ID of the forecast
|
|
51540
51963
|
* @param {Object} opts Optional parameters
|
|
@@ -51574,7 +51997,7 @@ class WorkforceManagementApi {
|
|
|
51574
51997
|
/**
|
|
51575
51998
|
* Gets the forecast generation results
|
|
51576
51999
|
*
|
|
51577
|
-
* @param {String} businessUnitId The
|
|
52000
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51578
52001
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51579
52002
|
* @param {String} forecastId The ID of the forecast
|
|
51580
52003
|
*/
|
|
@@ -51609,7 +52032,7 @@ class WorkforceManagementApi {
|
|
|
51609
52032
|
/**
|
|
51610
52033
|
* Get the result of a long term forecast calculation
|
|
51611
52034
|
* Includes modifications unless you pass the doNotApplyModifications query parameter
|
|
51612
|
-
* @param {String} businessUnitId The
|
|
52035
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51613
52036
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51614
52037
|
* @param {String} forecastId The ID of the forecast
|
|
51615
52038
|
* @param {Object} opts Optional parameters
|
|
@@ -51648,7 +52071,7 @@ class WorkforceManagementApi {
|
|
|
51648
52071
|
/**
|
|
51649
52072
|
* Gets the forecast planning group snapshot
|
|
51650
52073
|
*
|
|
51651
|
-
* @param {String} businessUnitId The
|
|
52074
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51652
52075
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51653
52076
|
* @param {String} forecastId The ID of the forecast
|
|
51654
52077
|
*/
|
|
@@ -51683,7 +52106,7 @@ class WorkforceManagementApi {
|
|
|
51683
52106
|
/**
|
|
51684
52107
|
* Get short term forecasts
|
|
51685
52108
|
* Use \"recent\" (without quotes) for the `weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any forecast which spans the specified week
|
|
51686
|
-
* @param {String} businessUnitId The
|
|
52109
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51687
52110
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format or 'recent' (without quotes) to fetch recent forecasts
|
|
51688
52111
|
*/
|
|
51689
52112
|
getWorkforcemanagementBusinessunitWeekShorttermforecasts(businessUnitId, weekDateId) {
|
|
@@ -51901,7 +52324,7 @@ class WorkforceManagementApi {
|
|
|
51901
52324
|
/**
|
|
51902
52325
|
* Get a list of user schedule adherence records for the requested management unit
|
|
51903
52326
|
*
|
|
51904
|
-
* @param {String} managementUnitId The
|
|
52327
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
51905
52328
|
* @param {Object} opts Optional parameters
|
|
51906
52329
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
51907
52330
|
*/
|
|
@@ -51930,7 +52353,7 @@ class WorkforceManagementApi {
|
|
|
51930
52353
|
/**
|
|
51931
52354
|
* Get data for agent in the management unit
|
|
51932
52355
|
*
|
|
51933
|
-
* @param {String} managementUnitId The
|
|
52356
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
51934
52357
|
* @param {String} agentId The agent id
|
|
51935
52358
|
* @param {Object} opts Optional parameters
|
|
51936
52359
|
* @param {Boolean} opts.excludeCapabilities Excludes all capabilities of the agent such as queues, languages, and skills
|
|
@@ -51964,7 +52387,7 @@ class WorkforceManagementApi {
|
|
|
51964
52387
|
/**
|
|
51965
52388
|
* Gets all the shift trades for a given agent
|
|
51966
52389
|
*
|
|
51967
|
-
* @param {String} managementUnitId The
|
|
52390
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
51968
52391
|
* @param {String} agentId The agent id
|
|
51969
52392
|
*/
|
|
51970
52393
|
getWorkforcemanagementManagementunitAgentShifttrades(managementUnitId, agentId) {
|
|
@@ -51994,7 +52417,7 @@ class WorkforceManagementApi {
|
|
|
51994
52417
|
/**
|
|
51995
52418
|
* Gets a summary of all shift trades in the matched state
|
|
51996
52419
|
*
|
|
51997
|
-
* @param {String} managementUnitId The
|
|
52420
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
51998
52421
|
*/
|
|
51999
52422
|
getWorkforcemanagementManagementunitShifttradesMatched(managementUnitId) {
|
|
52000
52423
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -52019,7 +52442,7 @@ class WorkforceManagementApi {
|
|
|
52019
52442
|
/**
|
|
52020
52443
|
* Gets list of users available for whom you can send direct shift trade requests
|
|
52021
52444
|
*
|
|
52022
|
-
* @param {String} managementUnitId The
|
|
52445
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52023
52446
|
*/
|
|
52024
52447
|
getWorkforcemanagementManagementunitShifttradesUsers(managementUnitId) {
|
|
52025
52448
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -52044,7 +52467,7 @@ class WorkforceManagementApi {
|
|
|
52044
52467
|
/**
|
|
52045
52468
|
* Gets a time off limit object
|
|
52046
52469
|
* Returns properties of time off limit object, but not daily values.
|
|
52047
|
-
* @param {String} managementUnitId The
|
|
52470
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52048
52471
|
* @param {String} timeOffLimitId The ID of the time off limit to fetch
|
|
52049
52472
|
*/
|
|
52050
52473
|
getWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
@@ -52074,7 +52497,7 @@ class WorkforceManagementApi {
|
|
|
52074
52497
|
/**
|
|
52075
52498
|
* Gets a list of time off limit objects under management unit.
|
|
52076
52499
|
* Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.
|
|
52077
|
-
* @param {String} managementUnitId The
|
|
52500
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52078
52501
|
*/
|
|
52079
52502
|
getWorkforcemanagementManagementunitTimeofflimits(managementUnitId) {
|
|
52080
52503
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -52099,7 +52522,7 @@ class WorkforceManagementApi {
|
|
|
52099
52522
|
/**
|
|
52100
52523
|
* Gets a time off plan
|
|
52101
52524
|
*
|
|
52102
|
-
* @param {String} managementUnitId The management unit
|
|
52525
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
52103
52526
|
* @param {String} timeOffPlanId The ID of the time off plan to fetch
|
|
52104
52527
|
*/
|
|
52105
52528
|
getWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
@@ -52129,7 +52552,7 @@ class WorkforceManagementApi {
|
|
|
52129
52552
|
/**
|
|
52130
52553
|
* Gets a list of time off plans
|
|
52131
52554
|
*
|
|
52132
|
-
* @param {String} managementUnitId The management unit
|
|
52555
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
52133
52556
|
*/
|
|
52134
52557
|
getWorkforcemanagementManagementunitTimeoffplans(managementUnitId) {
|
|
52135
52558
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -52154,7 +52577,7 @@ class WorkforceManagementApi {
|
|
|
52154
52577
|
/**
|
|
52155
52578
|
* Get a time off request
|
|
52156
52579
|
*
|
|
52157
|
-
* @param {String} managementUnitId The
|
|
52580
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52158
52581
|
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
52159
52582
|
* @param {String} timeOffRequestId Time Off Request Id
|
|
52160
52583
|
*/
|
|
@@ -52189,7 +52612,7 @@ class WorkforceManagementApi {
|
|
|
52189
52612
|
/**
|
|
52190
52613
|
* Retrieves time off limit, allocated and waitlisted values according to specific time off request
|
|
52191
52614
|
*
|
|
52192
|
-
* @param {String} managementUnitId The
|
|
52615
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52193
52616
|
* @param {String} userId The userId to whom the time off request applies.
|
|
52194
52617
|
* @param {String} timeOffRequestId The ID of the time off request, which dates and activityCodeId determine limit values to retrieve
|
|
52195
52618
|
*/
|
|
@@ -52224,7 +52647,7 @@ class WorkforceManagementApi {
|
|
|
52224
52647
|
/**
|
|
52225
52648
|
* Get a list of time off requests for a given user
|
|
52226
52649
|
*
|
|
52227
|
-
* @param {String} managementUnitId The
|
|
52650
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52228
52651
|
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
52229
52652
|
* @param {Object} opts Optional parameters
|
|
52230
52653
|
* @param {Boolean} opts.recentlyReviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
|
|
@@ -52258,7 +52681,7 @@ class WorkforceManagementApi {
|
|
|
52258
52681
|
/**
|
|
52259
52682
|
* Get users in the management unit
|
|
52260
52683
|
*
|
|
52261
|
-
* @param {String} managementUnitId The
|
|
52684
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52262
52685
|
*/
|
|
52263
52686
|
getWorkforcemanagementManagementunitUsers(managementUnitId) {
|
|
52264
52687
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -52359,7 +52782,7 @@ class WorkforceManagementApi {
|
|
|
52359
52782
|
/**
|
|
52360
52783
|
* Gets all the shift trades for a given week
|
|
52361
52784
|
*
|
|
52362
|
-
* @param {String} managementUnitId The
|
|
52785
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52363
52786
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
52364
52787
|
* @param {Object} opts Optional parameters
|
|
52365
52788
|
* @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
|
|
@@ -52632,7 +53055,7 @@ class WorkforceManagementApi {
|
|
|
52632
53055
|
/**
|
|
52633
53056
|
* Get a time off request for the current user
|
|
52634
53057
|
*
|
|
52635
|
-
* @param {String} timeOffRequestId
|
|
53058
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
52636
53059
|
*/
|
|
52637
53060
|
getWorkforcemanagementTimeoffrequest(timeOffRequestId) {
|
|
52638
53061
|
// verify the required parameter 'timeOffRequestId' is set
|
|
@@ -52657,7 +53080,7 @@ class WorkforceManagementApi {
|
|
|
52657
53080
|
/**
|
|
52658
53081
|
* Get the daily waitlist positions of a time off request for the current user
|
|
52659
53082
|
*
|
|
52660
|
-
* @param {String} timeOffRequestId
|
|
53083
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
52661
53084
|
*/
|
|
52662
53085
|
getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId) {
|
|
52663
53086
|
// verify the required parameter 'timeOffRequestId' is set
|
|
@@ -52900,7 +53323,7 @@ class WorkforceManagementApi {
|
|
|
52900
53323
|
/**
|
|
52901
53324
|
* Updates a time off limit object.
|
|
52902
53325
|
* Updates time off limit object properties, but not daily values.
|
|
52903
|
-
* @param {String} managementUnitId The
|
|
53326
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52904
53327
|
* @param {String} timeOffLimitId The id of time off limit object to update
|
|
52905
53328
|
* @param {Object} opts Optional parameters
|
|
52906
53329
|
* @param {Object} opts.body body
|
|
@@ -52934,7 +53357,7 @@ class WorkforceManagementApi {
|
|
|
52934
53357
|
/**
|
|
52935
53358
|
* Updates a time off plan
|
|
52936
53359
|
*
|
|
52937
|
-
* @param {String} managementUnitId The management unit
|
|
53360
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
52938
53361
|
* @param {String} timeOffPlanId The ID of the time off plan to update
|
|
52939
53362
|
* @param {Object} opts Optional parameters
|
|
52940
53363
|
* @param {Object} opts.body body
|
|
@@ -52968,7 +53391,7 @@ class WorkforceManagementApi {
|
|
|
52968
53391
|
/**
|
|
52969
53392
|
* Update a time off request
|
|
52970
53393
|
*
|
|
52971
|
-
* @param {String} managementUnitId The
|
|
53394
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52972
53395
|
* @param {String} userId The id of the user the requested time off request belongs to
|
|
52973
53396
|
* @param {String} timeOffRequestId The id of the time off request to update
|
|
52974
53397
|
* @param {Object} opts Optional parameters
|
|
@@ -53007,7 +53430,7 @@ class WorkforceManagementApi {
|
|
|
53007
53430
|
/**
|
|
53008
53431
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
53009
53432
|
*
|
|
53010
|
-
* @param {String} managementUnitId The
|
|
53433
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
53011
53434
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
53012
53435
|
* @param {Object} body body
|
|
53013
53436
|
* @param {String} tradeId The ID of the shift trade to update
|
|
@@ -53116,7 +53539,7 @@ class WorkforceManagementApi {
|
|
|
53116
53539
|
/**
|
|
53117
53540
|
* Update a time off request for the current user
|
|
53118
53541
|
*
|
|
53119
|
-
* @param {String} timeOffRequestId
|
|
53542
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
53120
53543
|
* @param {Object} opts Optional parameters
|
|
53121
53544
|
* @param {Object} opts.body body
|
|
53122
53545
|
*/
|
|
@@ -53253,7 +53676,7 @@ class WorkforceManagementApi {
|
|
|
53253
53676
|
/**
|
|
53254
53677
|
* Get intraday data for the given date for the requested planningGroupIds
|
|
53255
53678
|
*
|
|
53256
|
-
* @param {String} businessUnitId The
|
|
53679
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
53257
53680
|
* @param {Object} opts Optional parameters
|
|
53258
53681
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
53259
53682
|
* @param {Object} opts.body body
|
|
@@ -53686,7 +54109,7 @@ class WorkforceManagementApi {
|
|
|
53686
54109
|
/**
|
|
53687
54110
|
* Copy a short term forecast
|
|
53688
54111
|
*
|
|
53689
|
-
* @param {String} businessUnitId The
|
|
54112
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
53690
54113
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
53691
54114
|
* @param {String} forecastId The ID of the forecast to copy
|
|
53692
54115
|
* @param {Object} body body
|
|
@@ -53730,7 +54153,7 @@ class WorkforceManagementApi {
|
|
|
53730
54153
|
/**
|
|
53731
54154
|
* Generate a short term forecast
|
|
53732
54155
|
*
|
|
53733
|
-
* @param {String} businessUnitId The
|
|
54156
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
53734
54157
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
53735
54158
|
* @param {Object} body
|
|
53736
54159
|
* @param {Object} opts Optional parameters
|
|
@@ -53769,7 +54192,7 @@ class WorkforceManagementApi {
|
|
|
53769
54192
|
/**
|
|
53770
54193
|
* Starts importing the uploaded short term forecast
|
|
53771
54194
|
* Call after uploading the forecast data to the url supplied by the /import/uploadurl route
|
|
53772
|
-
* @param {String} businessUnitId The
|
|
54195
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
53773
54196
|
* @param {String} weekDateId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
53774
54197
|
* @param {Object} body
|
|
53775
54198
|
*/
|
|
@@ -53804,7 +54227,7 @@ class WorkforceManagementApi {
|
|
|
53804
54227
|
/**
|
|
53805
54228
|
* Creates a signed upload URL for importing a short term forecast
|
|
53806
54229
|
* Once the upload is complete, call the /import route to start the short term forecast import process
|
|
53807
|
-
* @param {String} businessUnitId The
|
|
54230
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
53808
54231
|
* @param {String} weekDateId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
53809
54232
|
* @param {Object} body body
|
|
53810
54233
|
*/
|
|
@@ -53931,7 +54354,7 @@ class WorkforceManagementApi {
|
|
|
53931
54354
|
/**
|
|
53932
54355
|
* Query published schedules for given given time range for set of users
|
|
53933
54356
|
*
|
|
53934
|
-
* @param {String} managementUnitId The
|
|
54357
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
53935
54358
|
* @param {Object} opts Optional parameters
|
|
53936
54359
|
* @param {Object} opts.body body
|
|
53937
54360
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
@@ -53962,7 +54385,7 @@ class WorkforceManagementApi {
|
|
|
53962
54385
|
/**
|
|
53963
54386
|
* Request a historical adherence report
|
|
53964
54387
|
* The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
|
|
53965
|
-
* @param {String} managementUnitId The
|
|
54388
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
53966
54389
|
* @param {Object} opts Optional parameters
|
|
53967
54390
|
* @param {Object} opts.body body
|
|
53968
54391
|
*/
|
|
@@ -54020,7 +54443,7 @@ class WorkforceManagementApi {
|
|
|
54020
54443
|
/**
|
|
54021
54444
|
* Query published schedules for given given time range for set of users
|
|
54022
54445
|
*
|
|
54023
|
-
* @param {String} managementUnitId The
|
|
54446
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
54024
54447
|
* @param {Object} opts Optional parameters
|
|
54025
54448
|
* @param {Object} opts.body body
|
|
54026
54449
|
*/
|
|
@@ -54049,7 +54472,7 @@ class WorkforceManagementApi {
|
|
|
54049
54472
|
/**
|
|
54050
54473
|
* Creates a new time off limit object under management unit.
|
|
54051
54474
|
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
54052
|
-
* @param {String} managementUnitId The
|
|
54475
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
54053
54476
|
* @param {Object} opts Optional parameters
|
|
54054
54477
|
* @param {Object} opts.body body
|
|
54055
54478
|
*/
|
|
@@ -54078,7 +54501,7 @@ class WorkforceManagementApi {
|
|
|
54078
54501
|
/**
|
|
54079
54502
|
* Retrieves time off limit related values based on a given set of filters.
|
|
54080
54503
|
*
|
|
54081
|
-
* @param {String} managementUnitId The
|
|
54504
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
54082
54505
|
* @param {Object} opts Optional parameters
|
|
54083
54506
|
* @param {Object} opts.body body
|
|
54084
54507
|
*/
|
|
@@ -54107,7 +54530,7 @@ class WorkforceManagementApi {
|
|
|
54107
54530
|
/**
|
|
54108
54531
|
* Creates a new time off plan
|
|
54109
54532
|
*
|
|
54110
|
-
* @param {String} managementUnitId The management unit
|
|
54533
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
54111
54534
|
* @param {Object} opts Optional parameters
|
|
54112
54535
|
* @param {Object} opts.body body
|
|
54113
54536
|
*/
|
|
@@ -54136,7 +54559,7 @@ class WorkforceManagementApi {
|
|
|
54136
54559
|
/**
|
|
54137
54560
|
* Create a new time off request
|
|
54138
54561
|
*
|
|
54139
|
-
* @param {String} managementUnitId The
|
|
54562
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
54140
54563
|
* @param {Object} opts Optional parameters
|
|
54141
54564
|
* @param {Object} opts.body body
|
|
54142
54565
|
*/
|
|
@@ -54165,7 +54588,7 @@ class WorkforceManagementApi {
|
|
|
54165
54588
|
/**
|
|
54166
54589
|
* Fetches time off requests matching the conditions specified in the request body
|
|
54167
54590
|
* Request body requires one of the following: User ID is specified, statuses == [Pending] or date range to be specified and less than or equal to 33 days. All other fields are filters
|
|
54168
|
-
* @param {String} managementUnitId The
|
|
54591
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
54169
54592
|
* @param {Object} opts Optional parameters
|
|
54170
54593
|
* @param {Object} opts.body body
|
|
54171
54594
|
*/
|
|
@@ -54194,7 +54617,7 @@ class WorkforceManagementApi {
|
|
|
54194
54617
|
/**
|
|
54195
54618
|
* Retrieves daily waitlist position for a list of time off requests
|
|
54196
54619
|
*
|
|
54197
|
-
* @param {String} managementUnitId The
|
|
54620
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
54198
54621
|
* @param {Object} opts Optional parameters
|
|
54199
54622
|
* @param {Object} opts.body body
|
|
54200
54623
|
*/
|
|
@@ -54223,7 +54646,7 @@ class WorkforceManagementApi {
|
|
|
54223
54646
|
/**
|
|
54224
54647
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
54225
54648
|
*
|
|
54226
|
-
* @param {String} managementUnitId The
|
|
54649
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
54227
54650
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
54228
54651
|
* @param {Object} body body
|
|
54229
54652
|
* @param {String} tradeId The ID of the shift trade to update
|
|
@@ -54263,7 +54686,7 @@ class WorkforceManagementApi {
|
|
|
54263
54686
|
/**
|
|
54264
54687
|
* Adds a shift trade
|
|
54265
54688
|
*
|
|
54266
|
-
* @param {String} managementUnitId The
|
|
54689
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
54267
54690
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
54268
54691
|
* @param {Object} body body
|
|
54269
54692
|
*/
|
|
@@ -54298,7 +54721,7 @@ class WorkforceManagementApi {
|
|
|
54298
54721
|
/**
|
|
54299
54722
|
* Searches for potential shift trade matches for the current agent
|
|
54300
54723
|
*
|
|
54301
|
-
* @param {String} managementUnitId The
|
|
54724
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
54302
54725
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
54303
54726
|
* @param {Object} body body
|
|
54304
54727
|
*/
|
|
@@ -54333,7 +54756,7 @@ class WorkforceManagementApi {
|
|
|
54333
54756
|
/**
|
|
54334
54757
|
* Updates the state of a batch of shift trades
|
|
54335
54758
|
* Admin functionality is not supported with \"mine\".
|
|
54336
|
-
* @param {String} managementUnitId The
|
|
54759
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
54337
54760
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
54338
54761
|
* @param {Object} body body
|
|
54339
54762
|
* @param {Object} opts Optional parameters
|
|
@@ -54654,7 +55077,7 @@ class WorkforceManagementApi {
|
|
|
54654
55077
|
/**
|
|
54655
55078
|
* Sets daily values for a date range of time off limit object
|
|
54656
55079
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
54657
|
-
* @param {String} managementUnitId The
|
|
55080
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
54658
55081
|
* @param {String} timeOffLimitId The ID of the time off limit object to set values for
|
|
54659
55082
|
* @param {Object} opts Optional parameters
|
|
54660
55083
|
* @param {Object} opts.body body
|
|
@@ -54716,7 +55139,7 @@ class WorkforceManagementApi {
|
|
|
54716
55139
|
* </pre>
|
|
54717
55140
|
* </p>
|
|
54718
55141
|
* @module purecloud-platform-client-v2/index
|
|
54719
|
-
* @version
|
|
55142
|
+
* @version 136.1.0
|
|
54720
55143
|
*/
|
|
54721
55144
|
class platformClient {
|
|
54722
55145
|
constructor() {
|