purecloud-platform-client-v2 133.0.2 → 135.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/node/purecloud-platform-client-v2.js +680 -200
- package/dist/web-amd/purecloud-platform-client-v2.js +680 -200
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +680 -200
- package/dist/web-cjs/purecloud-platform-client-v2.js +692 -204
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1060 -221
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +78 -3
- 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 +1 -1
- 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 +1 -1
- 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 +14 -6
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +26 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -51
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +5 -3
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +160 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- 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 -26
- 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 +269 -49
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5382,19 +5382,27 @@ request.getXHR = function () {
|
|
|
5382
5382
|
|
|
5383
5383
|
try {
|
|
5384
5384
|
return new ActiveXObject('Microsoft.XMLHTTP');
|
|
5385
|
-
} catch (_unused) {
|
|
5385
|
+
} catch (_unused) {
|
|
5386
|
+
/**/
|
|
5387
|
+
}
|
|
5386
5388
|
|
|
5387
5389
|
try {
|
|
5388
5390
|
return new ActiveXObject('Msxml2.XMLHTTP.6.0');
|
|
5389
|
-
} catch (_unused2) {
|
|
5391
|
+
} catch (_unused2) {
|
|
5392
|
+
/**/
|
|
5393
|
+
}
|
|
5390
5394
|
|
|
5391
5395
|
try {
|
|
5392
5396
|
return new ActiveXObject('Msxml2.XMLHTTP.3.0');
|
|
5393
|
-
} catch (_unused3) {
|
|
5397
|
+
} catch (_unused3) {
|
|
5398
|
+
/**/
|
|
5399
|
+
}
|
|
5394
5400
|
|
|
5395
5401
|
try {
|
|
5396
5402
|
return new ActiveXObject('Msxml2.XMLHTTP');
|
|
5397
|
-
} catch (_unused4) {
|
|
5403
|
+
} catch (_unused4) {
|
|
5404
|
+
/**/
|
|
5405
|
+
}
|
|
5398
5406
|
|
|
5399
5407
|
throw new Error('Browser-only version of superagent could not find XHR');
|
|
5400
5408
|
};
|
|
@@ -9667,7 +9675,7 @@ class Configuration {
|
|
|
9667
9675
|
|
|
9668
9676
|
/**
|
|
9669
9677
|
* @module purecloud-platform-client-v2/ApiClient
|
|
9670
|
-
* @version
|
|
9678
|
+
* @version 135.0.0
|
|
9671
9679
|
*/
|
|
9672
9680
|
class ApiClient {
|
|
9673
9681
|
/**
|
|
@@ -10607,7 +10615,7 @@ class ApiClient {
|
|
|
10607
10615
|
|
|
10608
10616
|
// set header parameters
|
|
10609
10617
|
request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
|
|
10610
|
-
//request.set({ 'purecloud-sdk': '
|
|
10618
|
+
//request.set({ 'purecloud-sdk': '135.0.0' });
|
|
10611
10619
|
|
|
10612
10620
|
// set request timeout
|
|
10613
10621
|
request.timeout(that.timeout);
|
|
@@ -10707,7 +10715,7 @@ class AlertingApi {
|
|
|
10707
10715
|
/**
|
|
10708
10716
|
* Alerting service.
|
|
10709
10717
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
10710
|
-
* @version
|
|
10718
|
+
* @version 135.0.0
|
|
10711
10719
|
*/
|
|
10712
10720
|
|
|
10713
10721
|
/**
|
|
@@ -11021,7 +11029,7 @@ class AnalyticsApi {
|
|
|
11021
11029
|
/**
|
|
11022
11030
|
* Analytics service.
|
|
11023
11031
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
11024
|
-
* @version
|
|
11032
|
+
* @version 135.0.0
|
|
11025
11033
|
*/
|
|
11026
11034
|
|
|
11027
11035
|
/**
|
|
@@ -12203,7 +12211,7 @@ class ArchitectApi {
|
|
|
12203
12211
|
/**
|
|
12204
12212
|
* Architect service.
|
|
12205
12213
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
12206
|
-
* @version
|
|
12214
|
+
* @version 135.0.0
|
|
12207
12215
|
*/
|
|
12208
12216
|
|
|
12209
12217
|
/**
|
|
@@ -15199,7 +15207,7 @@ class AuditApi {
|
|
|
15199
15207
|
/**
|
|
15200
15208
|
* Audit service.
|
|
15201
15209
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
15202
|
-
* @version
|
|
15210
|
+
* @version 135.0.0
|
|
15203
15211
|
*/
|
|
15204
15212
|
|
|
15205
15213
|
/**
|
|
@@ -15370,7 +15378,7 @@ class AuthorizationApi {
|
|
|
15370
15378
|
/**
|
|
15371
15379
|
* Authorization service.
|
|
15372
15380
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
15373
|
-
* @version
|
|
15381
|
+
* @version 135.0.0
|
|
15374
15382
|
*/
|
|
15375
15383
|
|
|
15376
15384
|
/**
|
|
@@ -16553,7 +16561,7 @@ class BillingApi {
|
|
|
16553
16561
|
/**
|
|
16554
16562
|
* Billing service.
|
|
16555
16563
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
16556
|
-
* @version
|
|
16564
|
+
* @version 135.0.0
|
|
16557
16565
|
*/
|
|
16558
16566
|
|
|
16559
16567
|
/**
|
|
@@ -16633,7 +16641,7 @@ class ChatApi {
|
|
|
16633
16641
|
/**
|
|
16634
16642
|
* Chat service.
|
|
16635
16643
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
16636
|
-
* @version
|
|
16644
|
+
* @version 135.0.0
|
|
16637
16645
|
*/
|
|
16638
16646
|
|
|
16639
16647
|
/**
|
|
@@ -16724,7 +16732,7 @@ class CoachingApi {
|
|
|
16724
16732
|
/**
|
|
16725
16733
|
* Coaching service.
|
|
16726
16734
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
16727
|
-
* @version
|
|
16735
|
+
* @version 135.0.0
|
|
16728
16736
|
*/
|
|
16729
16737
|
|
|
16730
16738
|
/**
|
|
@@ -17301,7 +17309,7 @@ class ContentManagementApi {
|
|
|
17301
17309
|
/**
|
|
17302
17310
|
* ContentManagement service.
|
|
17303
17311
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
17304
|
-
* @version
|
|
17312
|
+
* @version 135.0.0
|
|
17305
17313
|
*/
|
|
17306
17314
|
|
|
17307
17315
|
/**
|
|
@@ -18441,7 +18449,7 @@ class ConversationsApi {
|
|
|
18441
18449
|
/**
|
|
18442
18450
|
* Conversations service.
|
|
18443
18451
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
18444
|
-
* @version
|
|
18452
|
+
* @version 135.0.0
|
|
18445
18453
|
*/
|
|
18446
18454
|
|
|
18447
18455
|
/**
|
|
@@ -20346,7 +20354,7 @@ class ConversationsApi {
|
|
|
20346
20354
|
/**
|
|
20347
20355
|
* Get a list of Messaging Stickers
|
|
20348
20356
|
*
|
|
20349
|
-
* @param {
|
|
20357
|
+
* @param {Object} messengerType Messenger Type
|
|
20350
20358
|
* @param {Object} opts Optional parameters
|
|
20351
20359
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
20352
20360
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
@@ -20534,7 +20542,7 @@ class ConversationsApi {
|
|
|
20534
20542
|
}
|
|
20535
20543
|
|
|
20536
20544
|
/**
|
|
20537
|
-
* Update a conversation by setting
|
|
20545
|
+
* Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
20538
20546
|
*
|
|
20539
20547
|
* @param {String} conversationId conversationId
|
|
20540
20548
|
* @param {Object} body Conversation
|
|
@@ -20848,6 +20856,31 @@ class ConversationsApi {
|
|
|
20848
20856
|
);
|
|
20849
20857
|
}
|
|
20850
20858
|
|
|
20859
|
+
/**
|
|
20860
|
+
* Update a scheduled callback
|
|
20861
|
+
*
|
|
20862
|
+
* @param {Object} body PatchCallbackRequest
|
|
20863
|
+
*/
|
|
20864
|
+
patchConversationsCallbacks(body) {
|
|
20865
|
+
// verify the required parameter 'body' is set
|
|
20866
|
+
if (body === undefined || body === null) {
|
|
20867
|
+
throw 'Missing the required parameter "body" when calling patchConversationsCallbacks';
|
|
20868
|
+
}
|
|
20869
|
+
|
|
20870
|
+
return this.apiClient.callApi(
|
|
20871
|
+
'/api/v2/conversations/callbacks',
|
|
20872
|
+
'PATCH',
|
|
20873
|
+
{ },
|
|
20874
|
+
{ },
|
|
20875
|
+
{ },
|
|
20876
|
+
{ },
|
|
20877
|
+
body,
|
|
20878
|
+
['PureCloud OAuth'],
|
|
20879
|
+
['application/json'],
|
|
20880
|
+
['application/json']
|
|
20881
|
+
);
|
|
20882
|
+
}
|
|
20883
|
+
|
|
20851
20884
|
/**
|
|
20852
20885
|
* Update a conversation by disconnecting all of the participants
|
|
20853
20886
|
*
|
|
@@ -22101,6 +22134,56 @@ class ConversationsApi {
|
|
|
22101
22134
|
);
|
|
22102
22135
|
}
|
|
22103
22136
|
|
|
22137
|
+
/**
|
|
22138
|
+
* Disconnect multiple scheduled callbacks
|
|
22139
|
+
*
|
|
22140
|
+
* @param {Object} body BulkCallbackDisconnectRequest
|
|
22141
|
+
*/
|
|
22142
|
+
postConversationsCallbacksBulkDisconnect(body) {
|
|
22143
|
+
// verify the required parameter 'body' is set
|
|
22144
|
+
if (body === undefined || body === null) {
|
|
22145
|
+
throw 'Missing the required parameter "body" when calling postConversationsCallbacksBulkDisconnect';
|
|
22146
|
+
}
|
|
22147
|
+
|
|
22148
|
+
return this.apiClient.callApi(
|
|
22149
|
+
'/api/v2/conversations/callbacks/bulk/disconnect',
|
|
22150
|
+
'POST',
|
|
22151
|
+
{ },
|
|
22152
|
+
{ },
|
|
22153
|
+
{ },
|
|
22154
|
+
{ },
|
|
22155
|
+
body,
|
|
22156
|
+
['PureCloud OAuth'],
|
|
22157
|
+
['application/json'],
|
|
22158
|
+
['application/json']
|
|
22159
|
+
);
|
|
22160
|
+
}
|
|
22161
|
+
|
|
22162
|
+
/**
|
|
22163
|
+
* Update multiple scheduled callbacks
|
|
22164
|
+
*
|
|
22165
|
+
* @param {Object} body BulkCallbackPatchRequest
|
|
22166
|
+
*/
|
|
22167
|
+
postConversationsCallbacksBulkUpdate(body) {
|
|
22168
|
+
// verify the required parameter 'body' is set
|
|
22169
|
+
if (body === undefined || body === null) {
|
|
22170
|
+
throw 'Missing the required parameter "body" when calling postConversationsCallbacksBulkUpdate';
|
|
22171
|
+
}
|
|
22172
|
+
|
|
22173
|
+
return this.apiClient.callApi(
|
|
22174
|
+
'/api/v2/conversations/callbacks/bulk/update',
|
|
22175
|
+
'POST',
|
|
22176
|
+
{ },
|
|
22177
|
+
{ },
|
|
22178
|
+
{ },
|
|
22179
|
+
{ },
|
|
22180
|
+
body,
|
|
22181
|
+
['PureCloud OAuth'],
|
|
22182
|
+
['application/json'],
|
|
22183
|
+
['application/json']
|
|
22184
|
+
);
|
|
22185
|
+
}
|
|
22186
|
+
|
|
22104
22187
|
/**
|
|
22105
22188
|
* Create a call conversation
|
|
22106
22189
|
*
|
|
@@ -23030,7 +23113,7 @@ class DataExtensionsApi {
|
|
|
23030
23113
|
/**
|
|
23031
23114
|
* DataExtensions service.
|
|
23032
23115
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
23033
|
-
* @version
|
|
23116
|
+
* @version 135.0.0
|
|
23034
23117
|
*/
|
|
23035
23118
|
|
|
23036
23119
|
/**
|
|
@@ -23116,7 +23199,7 @@ class ExternalContactsApi {
|
|
|
23116
23199
|
/**
|
|
23117
23200
|
* ExternalContacts service.
|
|
23118
23201
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
23119
|
-
* @version
|
|
23202
|
+
* @version 135.0.0
|
|
23120
23203
|
*/
|
|
23121
23204
|
|
|
23122
23205
|
/**
|
|
@@ -24859,7 +24942,7 @@ class FaxApi {
|
|
|
24859
24942
|
/**
|
|
24860
24943
|
* Fax service.
|
|
24861
24944
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
24862
|
-
* @version
|
|
24945
|
+
* @version 135.0.0
|
|
24863
24946
|
*/
|
|
24864
24947
|
|
|
24865
24948
|
/**
|
|
@@ -25030,7 +25113,7 @@ class FlowsApi {
|
|
|
25030
25113
|
/**
|
|
25031
25114
|
* Flows service.
|
|
25032
25115
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
25033
|
-
* @version
|
|
25116
|
+
* @version 135.0.0
|
|
25034
25117
|
*/
|
|
25035
25118
|
|
|
25036
25119
|
/**
|
|
@@ -25101,7 +25184,7 @@ class GamificationApi {
|
|
|
25101
25184
|
/**
|
|
25102
25185
|
* Gamification service.
|
|
25103
25186
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
25104
|
-
* @version
|
|
25187
|
+
* @version 135.0.0
|
|
25105
25188
|
*/
|
|
25106
25189
|
|
|
25107
25190
|
/**
|
|
@@ -26531,7 +26614,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
26531
26614
|
/**
|
|
26532
26615
|
* GeneralDataProtectionRegulation service.
|
|
26533
26616
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
26534
|
-
* @version
|
|
26617
|
+
* @version 135.0.0
|
|
26535
26618
|
*/
|
|
26536
26619
|
|
|
26537
26620
|
/**
|
|
@@ -26661,7 +26744,7 @@ class GeolocationApi {
|
|
|
26661
26744
|
/**
|
|
26662
26745
|
* Geolocation service.
|
|
26663
26746
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
26664
|
-
* @version
|
|
26747
|
+
* @version 135.0.0
|
|
26665
26748
|
*/
|
|
26666
26749
|
|
|
26667
26750
|
/**
|
|
@@ -26792,7 +26875,7 @@ class GreetingsApi {
|
|
|
26792
26875
|
/**
|
|
26793
26876
|
* Greetings service.
|
|
26794
26877
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
26795
|
-
* @version
|
|
26878
|
+
* @version 135.0.0
|
|
26796
26879
|
*/
|
|
26797
26880
|
|
|
26798
26881
|
/**
|
|
@@ -27247,7 +27330,7 @@ class GroupsApi {
|
|
|
27247
27330
|
/**
|
|
27248
27331
|
* Groups service.
|
|
27249
27332
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
27250
|
-
* @version
|
|
27333
|
+
* @version 135.0.0
|
|
27251
27334
|
*/
|
|
27252
27335
|
|
|
27253
27336
|
/**
|
|
@@ -27652,7 +27735,7 @@ class IdentityProviderApi {
|
|
|
27652
27735
|
/**
|
|
27653
27736
|
* IdentityProvider service.
|
|
27654
27737
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
27655
|
-
* @version
|
|
27738
|
+
* @version 135.0.0
|
|
27656
27739
|
*/
|
|
27657
27740
|
|
|
27658
27741
|
/**
|
|
@@ -28408,7 +28491,7 @@ class IntegrationsApi {
|
|
|
28408
28491
|
/**
|
|
28409
28492
|
* Integrations service.
|
|
28410
28493
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
28411
|
-
* @version
|
|
28494
|
+
* @version 135.0.0
|
|
28412
28495
|
*/
|
|
28413
28496
|
|
|
28414
28497
|
/**
|
|
@@ -30083,7 +30166,7 @@ class JourneyApi {
|
|
|
30083
30166
|
/**
|
|
30084
30167
|
* Journey service.
|
|
30085
30168
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
30086
|
-
* @version
|
|
30169
|
+
* @version 135.0.0
|
|
30087
30170
|
*/
|
|
30088
30171
|
|
|
30089
30172
|
/**
|
|
@@ -30794,7 +30877,7 @@ class KnowledgeApi {
|
|
|
30794
30877
|
/**
|
|
30795
30878
|
* Knowledge service.
|
|
30796
30879
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
30797
|
-
* @version
|
|
30880
|
+
* @version 135.0.0
|
|
30798
30881
|
*/
|
|
30799
30882
|
|
|
30800
30883
|
/**
|
|
@@ -31694,7 +31777,7 @@ class LanguageUnderstandingApi {
|
|
|
31694
31777
|
/**
|
|
31695
31778
|
* LanguageUnderstanding service.
|
|
31696
31779
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
31697
|
-
* @version
|
|
31780
|
+
* @version 135.0.0
|
|
31698
31781
|
*/
|
|
31699
31782
|
|
|
31700
31783
|
/**
|
|
@@ -32598,7 +32681,7 @@ class LanguagesApi {
|
|
|
32598
32681
|
/**
|
|
32599
32682
|
* Languages service.
|
|
32600
32683
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
32601
|
-
* @version
|
|
32684
|
+
* @version 135.0.0
|
|
32602
32685
|
*/
|
|
32603
32686
|
|
|
32604
32687
|
/**
|
|
@@ -32866,7 +32949,7 @@ class LearningApi {
|
|
|
32866
32949
|
/**
|
|
32867
32950
|
* Learning service.
|
|
32868
32951
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
32869
|
-
* @version
|
|
32952
|
+
* @version 135.0.0
|
|
32870
32953
|
*/
|
|
32871
32954
|
|
|
32872
32955
|
/**
|
|
@@ -33457,7 +33540,7 @@ class LicenseApi {
|
|
|
33457
33540
|
/**
|
|
33458
33541
|
* License service.
|
|
33459
33542
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
33460
|
-
* @version
|
|
33543
|
+
* @version 135.0.0
|
|
33461
33544
|
*/
|
|
33462
33545
|
|
|
33463
33546
|
/**
|
|
@@ -33695,7 +33778,7 @@ class LocationsApi {
|
|
|
33695
33778
|
/**
|
|
33696
33779
|
* Locations service.
|
|
33697
33780
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
33698
|
-
* @version
|
|
33781
|
+
* @version 135.0.0
|
|
33699
33782
|
*/
|
|
33700
33783
|
|
|
33701
33784
|
/**
|
|
@@ -33931,7 +34014,7 @@ class MessagingApi {
|
|
|
33931
34014
|
/**
|
|
33932
34015
|
* Messaging service.
|
|
33933
34016
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
33934
|
-
* @version
|
|
34017
|
+
* @version 135.0.0
|
|
33935
34018
|
*/
|
|
33936
34019
|
|
|
33937
34020
|
/**
|
|
@@ -34082,7 +34165,7 @@ class MobileDevicesApi {
|
|
|
34082
34165
|
/**
|
|
34083
34166
|
* MobileDevices service.
|
|
34084
34167
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
34085
|
-
* @version
|
|
34168
|
+
* @version 135.0.0
|
|
34086
34169
|
*/
|
|
34087
34170
|
|
|
34088
34171
|
/**
|
|
@@ -34233,7 +34316,7 @@ class NotificationsApi {
|
|
|
34233
34316
|
/**
|
|
34234
34317
|
* Notifications service.
|
|
34235
34318
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
34236
|
-
* @version
|
|
34319
|
+
* @version 135.0.0
|
|
34237
34320
|
*/
|
|
34238
34321
|
|
|
34239
34322
|
/**
|
|
@@ -34458,7 +34541,7 @@ class OAuthApi {
|
|
|
34458
34541
|
/**
|
|
34459
34542
|
* OAuth service.
|
|
34460
34543
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
34461
|
-
* @version
|
|
34544
|
+
* @version 135.0.0
|
|
34462
34545
|
*/
|
|
34463
34546
|
|
|
34464
34547
|
/**
|
|
@@ -34502,8 +34585,12 @@ class OAuthApi {
|
|
|
34502
34585
|
* Get a client that is authorized by the resource owner
|
|
34503
34586
|
*
|
|
34504
34587
|
* @param {String} clientId The ID of client
|
|
34588
|
+
* @param {Object} opts Optional parameters
|
|
34589
|
+
* @param {String} opts.acceptLanguage The language in which to display the client descriptions. (default to en-us)
|
|
34505
34590
|
*/
|
|
34506
|
-
getOauthAuthorization(clientId) {
|
|
34591
|
+
getOauthAuthorization(clientId, opts) {
|
|
34592
|
+
opts = opts || {};
|
|
34593
|
+
|
|
34507
34594
|
// verify the required parameter 'clientId' is set
|
|
34508
34595
|
if (clientId === undefined || clientId === null) {
|
|
34509
34596
|
throw 'Missing the required parameter "clientId" when calling getOauthAuthorization';
|
|
@@ -34514,7 +34601,7 @@ class OAuthApi {
|
|
|
34514
34601
|
'GET',
|
|
34515
34602
|
{ 'clientId': clientId },
|
|
34516
34603
|
{ },
|
|
34517
|
-
{
|
|
34604
|
+
{ 'Accept-Language': opts['acceptLanguage'] },
|
|
34518
34605
|
{ },
|
|
34519
34606
|
null,
|
|
34520
34607
|
['PureCloud OAuth'],
|
|
@@ -34524,17 +34611,21 @@ class OAuthApi {
|
|
|
34524
34611
|
}
|
|
34525
34612
|
|
|
34526
34613
|
/**
|
|
34527
|
-
* List clients that
|
|
34614
|
+
* List clients that have been authorized, requested, or revoked by the resource owner
|
|
34528
34615
|
*
|
|
34616
|
+
* @param {Object} opts Optional parameters
|
|
34617
|
+
* @param {String} opts.acceptLanguage The language in which to display the client descriptions. (default to en-us)
|
|
34529
34618
|
*/
|
|
34530
|
-
getOauthAuthorizations() {
|
|
34619
|
+
getOauthAuthorizations(opts) {
|
|
34620
|
+
opts = opts || {};
|
|
34621
|
+
|
|
34531
34622
|
|
|
34532
34623
|
return this.apiClient.callApi(
|
|
34533
34624
|
'/api/v2/oauth/authorizations',
|
|
34534
34625
|
'GET',
|
|
34535
34626
|
{ },
|
|
34536
34627
|
{ },
|
|
34537
|
-
{
|
|
34628
|
+
{ 'Accept-Language': opts['acceptLanguage'] },
|
|
34538
34629
|
{ },
|
|
34539
34630
|
null,
|
|
34540
34631
|
['PureCloud OAuth'],
|
|
@@ -34816,7 +34907,7 @@ class ObjectsApi {
|
|
|
34816
34907
|
/**
|
|
34817
34908
|
* Objects service.
|
|
34818
34909
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
34819
|
-
* @version
|
|
34910
|
+
* @version 135.0.0
|
|
34820
34911
|
*/
|
|
34821
34912
|
|
|
34822
34913
|
/**
|
|
@@ -35087,7 +35178,7 @@ class OrganizationApi {
|
|
|
35087
35178
|
/**
|
|
35088
35179
|
* Organization service.
|
|
35089
35180
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
35090
|
-
* @version
|
|
35181
|
+
* @version 135.0.0
|
|
35091
35182
|
*/
|
|
35092
35183
|
|
|
35093
35184
|
/**
|
|
@@ -35490,7 +35581,7 @@ class OrganizationAuthorizationApi {
|
|
|
35490
35581
|
/**
|
|
35491
35582
|
* OrganizationAuthorization service.
|
|
35492
35583
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
35493
|
-
* @version
|
|
35584
|
+
* @version 135.0.0
|
|
35494
35585
|
*/
|
|
35495
35586
|
|
|
35496
35587
|
/**
|
|
@@ -36415,7 +36506,7 @@ class OutboundApi {
|
|
|
36415
36506
|
/**
|
|
36416
36507
|
* Outbound service.
|
|
36417
36508
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
36418
|
-
* @version
|
|
36509
|
+
* @version 135.0.0
|
|
36419
36510
|
*/
|
|
36420
36511
|
|
|
36421
36512
|
/**
|
|
@@ -36765,6 +36856,31 @@ class OutboundApi {
|
|
|
36765
36856
|
);
|
|
36766
36857
|
}
|
|
36767
36858
|
|
|
36859
|
+
/**
|
|
36860
|
+
* Reset messaging campaign progress and recycle the messaging campaign
|
|
36861
|
+
*
|
|
36862
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
36863
|
+
*/
|
|
36864
|
+
deleteOutboundMessagingcampaignProgress(messagingCampaignId) {
|
|
36865
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
36866
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
36867
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling deleteOutboundMessagingcampaignProgress';
|
|
36868
|
+
}
|
|
36869
|
+
|
|
36870
|
+
return this.apiClient.callApi(
|
|
36871
|
+
'/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress',
|
|
36872
|
+
'DELETE',
|
|
36873
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
36874
|
+
{ },
|
|
36875
|
+
{ },
|
|
36876
|
+
{ },
|
|
36877
|
+
null,
|
|
36878
|
+
['PureCloud OAuth'],
|
|
36879
|
+
['application/json'],
|
|
36880
|
+
['application/json']
|
|
36881
|
+
);
|
|
36882
|
+
}
|
|
36883
|
+
|
|
36768
36884
|
/**
|
|
36769
36885
|
* Delete a Rule Set.
|
|
36770
36886
|
*
|
|
@@ -39445,7 +39561,7 @@ class PresenceApi {
|
|
|
39445
39561
|
/**
|
|
39446
39562
|
* Presence service.
|
|
39447
39563
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
39448
|
-
* @version
|
|
39564
|
+
* @version 135.0.0
|
|
39449
39565
|
*/
|
|
39450
39566
|
|
|
39451
39567
|
/**
|
|
@@ -39591,31 +39707,6 @@ class PresenceApi {
|
|
|
39591
39707
|
);
|
|
39592
39708
|
}
|
|
39593
39709
|
|
|
39594
|
-
/**
|
|
39595
|
-
* Get a user's Microsoft Teams presence.
|
|
39596
|
-
* 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.
|
|
39597
|
-
* @param {String} userId user Id
|
|
39598
|
-
*/
|
|
39599
|
-
getUserPresencesMicrosoftteams(userId) {
|
|
39600
|
-
// verify the required parameter 'userId' is set
|
|
39601
|
-
if (userId === undefined || userId === null) {
|
|
39602
|
-
throw 'Missing the required parameter "userId" when calling getUserPresencesMicrosoftteams';
|
|
39603
|
-
}
|
|
39604
|
-
|
|
39605
|
-
return this.apiClient.callApi(
|
|
39606
|
-
'/api/v2/users/{userId}/presences/microsoftteams',
|
|
39607
|
-
'GET',
|
|
39608
|
-
{ 'userId': userId },
|
|
39609
|
-
{ },
|
|
39610
|
-
{ },
|
|
39611
|
-
{ },
|
|
39612
|
-
null,
|
|
39613
|
-
['PureCloud OAuth'],
|
|
39614
|
-
['application/json'],
|
|
39615
|
-
['application/json']
|
|
39616
|
-
);
|
|
39617
|
-
}
|
|
39618
|
-
|
|
39619
39710
|
/**
|
|
39620
39711
|
* Get a user's Genesys Cloud presence.
|
|
39621
39712
|
* Get the default Genesys Cloud user presence source PURECLOUD
|
|
@@ -39641,31 +39732,6 @@ class PresenceApi {
|
|
|
39641
39732
|
);
|
|
39642
39733
|
}
|
|
39643
39734
|
|
|
39644
|
-
/**
|
|
39645
|
-
* Get a user's Zoom Phone presence.
|
|
39646
|
-
* 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.
|
|
39647
|
-
* @param {String} userId user Id
|
|
39648
|
-
*/
|
|
39649
|
-
getUserPresencesZoomphone(userId) {
|
|
39650
|
-
// verify the required parameter 'userId' is set
|
|
39651
|
-
if (userId === undefined || userId === null) {
|
|
39652
|
-
throw 'Missing the required parameter "userId" when calling getUserPresencesZoomphone';
|
|
39653
|
-
}
|
|
39654
|
-
|
|
39655
|
-
return this.apiClient.callApi(
|
|
39656
|
-
'/api/v2/users/{userId}/presences/zoomphone',
|
|
39657
|
-
'GET',
|
|
39658
|
-
{ 'userId': userId },
|
|
39659
|
-
{ },
|
|
39660
|
-
{ },
|
|
39661
|
-
{ },
|
|
39662
|
-
null,
|
|
39663
|
-
['PureCloud OAuth'],
|
|
39664
|
-
['application/json'],
|
|
39665
|
-
['application/json']
|
|
39666
|
-
);
|
|
39667
|
-
}
|
|
39668
|
-
|
|
39669
39735
|
/**
|
|
39670
39736
|
* Patch a user's Presence
|
|
39671
39737
|
* 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.
|
|
@@ -39817,7 +39883,7 @@ class QualityApi {
|
|
|
39817
39883
|
/**
|
|
39818
39884
|
* Quality service.
|
|
39819
39885
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
39820
|
-
* @version
|
|
39886
|
+
* @version 135.0.0
|
|
39821
39887
|
*/
|
|
39822
39888
|
|
|
39823
39889
|
/**
|
|
@@ -41395,7 +41461,7 @@ class RecordingApi {
|
|
|
41395
41461
|
/**
|
|
41396
41462
|
* Recording service.
|
|
41397
41463
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
41398
|
-
* @version
|
|
41464
|
+
* @version 135.0.0
|
|
41399
41465
|
*/
|
|
41400
41466
|
|
|
41401
41467
|
/**
|
|
@@ -41918,6 +41984,7 @@ class RecordingApi {
|
|
|
41918
41984
|
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
41919
41985
|
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
41920
41986
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
41987
|
+
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
41921
41988
|
*/
|
|
41922
41989
|
getRecordingCrossplatformMediaretentionpolicies(opts) {
|
|
41923
41990
|
opts = opts || {};
|
|
@@ -41927,7 +41994,7 @@ class RecordingApi {
|
|
|
41927
41994
|
'/api/v2/recording/crossplatform/mediaretentionpolicies',
|
|
41928
41995
|
'GET',
|
|
41929
41996
|
{ },
|
|
41930
|
-
{ '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'] },
|
|
41997
|
+
{ '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'] },
|
|
41931
41998
|
{ },
|
|
41932
41999
|
{ },
|
|
41933
42000
|
null,
|
|
@@ -42109,6 +42176,7 @@ class RecordingApi {
|
|
|
42109
42176
|
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
42110
42177
|
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
42111
42178
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
42179
|
+
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
42112
42180
|
*/
|
|
42113
42181
|
getRecordingMediaretentionpolicies(opts) {
|
|
42114
42182
|
opts = opts || {};
|
|
@@ -42118,7 +42186,7 @@ class RecordingApi {
|
|
|
42118
42186
|
'/api/v2/recording/mediaretentionpolicies',
|
|
42119
42187
|
'GET',
|
|
42120
42188
|
{ },
|
|
42121
|
-
{ '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'] },
|
|
42189
|
+
{ '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'] },
|
|
42122
42190
|
{ },
|
|
42123
42191
|
{ },
|
|
42124
42192
|
null,
|
|
@@ -42921,7 +42989,7 @@ class ResponseManagementApi {
|
|
|
42921
42989
|
/**
|
|
42922
42990
|
* ResponseManagement service.
|
|
42923
42991
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
42924
|
-
* @version
|
|
42992
|
+
* @version 135.0.0
|
|
42925
42993
|
*/
|
|
42926
42994
|
|
|
42927
42995
|
/**
|
|
@@ -42986,6 +43054,31 @@ class ResponseManagementApi {
|
|
|
42986
43054
|
);
|
|
42987
43055
|
}
|
|
42988
43056
|
|
|
43057
|
+
/**
|
|
43058
|
+
* Delete response asset
|
|
43059
|
+
*
|
|
43060
|
+
* @param {String} responseAssetId Asset Id
|
|
43061
|
+
*/
|
|
43062
|
+
deleteResponsemanagementResponseasset(responseAssetId) {
|
|
43063
|
+
// verify the required parameter 'responseAssetId' is set
|
|
43064
|
+
if (responseAssetId === undefined || responseAssetId === null) {
|
|
43065
|
+
throw 'Missing the required parameter "responseAssetId" when calling deleteResponsemanagementResponseasset';
|
|
43066
|
+
}
|
|
43067
|
+
|
|
43068
|
+
return this.apiClient.callApi(
|
|
43069
|
+
'/api/v2/responsemanagement/responseassets/{responseAssetId}',
|
|
43070
|
+
'DELETE',
|
|
43071
|
+
{ 'responseAssetId': responseAssetId },
|
|
43072
|
+
{ },
|
|
43073
|
+
{ },
|
|
43074
|
+
{ },
|
|
43075
|
+
null,
|
|
43076
|
+
['PureCloud OAuth'],
|
|
43077
|
+
['application/json'],
|
|
43078
|
+
['application/json']
|
|
43079
|
+
);
|
|
43080
|
+
}
|
|
43081
|
+
|
|
42989
43082
|
/**
|
|
42990
43083
|
* Gets a list of existing response libraries.
|
|
42991
43084
|
*
|
|
@@ -43066,6 +43159,56 @@ class ResponseManagementApi {
|
|
|
43066
43159
|
);
|
|
43067
43160
|
}
|
|
43068
43161
|
|
|
43162
|
+
/**
|
|
43163
|
+
* Get response asset information
|
|
43164
|
+
*
|
|
43165
|
+
* @param {String} responseAssetId Asset Id
|
|
43166
|
+
*/
|
|
43167
|
+
getResponsemanagementResponseasset(responseAssetId) {
|
|
43168
|
+
// verify the required parameter 'responseAssetId' is set
|
|
43169
|
+
if (responseAssetId === undefined || responseAssetId === null) {
|
|
43170
|
+
throw 'Missing the required parameter "responseAssetId" when calling getResponsemanagementResponseasset';
|
|
43171
|
+
}
|
|
43172
|
+
|
|
43173
|
+
return this.apiClient.callApi(
|
|
43174
|
+
'/api/v2/responsemanagement/responseassets/{responseAssetId}',
|
|
43175
|
+
'GET',
|
|
43176
|
+
{ 'responseAssetId': responseAssetId },
|
|
43177
|
+
{ },
|
|
43178
|
+
{ },
|
|
43179
|
+
{ },
|
|
43180
|
+
null,
|
|
43181
|
+
['PureCloud OAuth'],
|
|
43182
|
+
['application/json'],
|
|
43183
|
+
['application/json']
|
|
43184
|
+
);
|
|
43185
|
+
}
|
|
43186
|
+
|
|
43187
|
+
/**
|
|
43188
|
+
* Get response asset upload status
|
|
43189
|
+
*
|
|
43190
|
+
* @param {String} statusId Status Id
|
|
43191
|
+
*/
|
|
43192
|
+
getResponsemanagementResponseassetsStatusStatusId(statusId) {
|
|
43193
|
+
// verify the required parameter 'statusId' is set
|
|
43194
|
+
if (statusId === undefined || statusId === null) {
|
|
43195
|
+
throw 'Missing the required parameter "statusId" when calling getResponsemanagementResponseassetsStatusStatusId';
|
|
43196
|
+
}
|
|
43197
|
+
|
|
43198
|
+
return this.apiClient.callApi(
|
|
43199
|
+
'/api/v2/responsemanagement/responseassets/status/{statusId}',
|
|
43200
|
+
'GET',
|
|
43201
|
+
{ 'statusId': statusId },
|
|
43202
|
+
{ },
|
|
43203
|
+
{ },
|
|
43204
|
+
{ },
|
|
43205
|
+
null,
|
|
43206
|
+
['PureCloud OAuth'],
|
|
43207
|
+
['application/json'],
|
|
43208
|
+
['application/json']
|
|
43209
|
+
);
|
|
43210
|
+
}
|
|
43211
|
+
|
|
43069
43212
|
/**
|
|
43070
43213
|
* Gets a list of existing responses.
|
|
43071
43214
|
*
|
|
@@ -43122,6 +43265,60 @@ class ResponseManagementApi {
|
|
|
43122
43265
|
);
|
|
43123
43266
|
}
|
|
43124
43267
|
|
|
43268
|
+
/**
|
|
43269
|
+
* Search response assets
|
|
43270
|
+
*
|
|
43271
|
+
* @param {Object} body request
|
|
43272
|
+
* @param {Object} opts Optional parameters
|
|
43273
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
43274
|
+
*/
|
|
43275
|
+
postResponsemanagementResponseassetsSearch(body, opts) {
|
|
43276
|
+
opts = opts || {};
|
|
43277
|
+
|
|
43278
|
+
// verify the required parameter 'body' is set
|
|
43279
|
+
if (body === undefined || body === null) {
|
|
43280
|
+
throw 'Missing the required parameter "body" when calling postResponsemanagementResponseassetsSearch';
|
|
43281
|
+
}
|
|
43282
|
+
|
|
43283
|
+
return this.apiClient.callApi(
|
|
43284
|
+
'/api/v2/responsemanagement/responseassets/search',
|
|
43285
|
+
'POST',
|
|
43286
|
+
{ },
|
|
43287
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
43288
|
+
{ },
|
|
43289
|
+
{ },
|
|
43290
|
+
body,
|
|
43291
|
+
['PureCloud OAuth'],
|
|
43292
|
+
['application/json'],
|
|
43293
|
+
['application/json']
|
|
43294
|
+
);
|
|
43295
|
+
}
|
|
43296
|
+
|
|
43297
|
+
/**
|
|
43298
|
+
* Creates pre-signed url for uploading response asset
|
|
43299
|
+
*
|
|
43300
|
+
* @param {Object} body request
|
|
43301
|
+
*/
|
|
43302
|
+
postResponsemanagementResponseassetsUploads(body) {
|
|
43303
|
+
// verify the required parameter 'body' is set
|
|
43304
|
+
if (body === undefined || body === null) {
|
|
43305
|
+
throw 'Missing the required parameter "body" when calling postResponsemanagementResponseassetsUploads';
|
|
43306
|
+
}
|
|
43307
|
+
|
|
43308
|
+
return this.apiClient.callApi(
|
|
43309
|
+
'/api/v2/responsemanagement/responseassets/uploads',
|
|
43310
|
+
'POST',
|
|
43311
|
+
{ },
|
|
43312
|
+
{ },
|
|
43313
|
+
{ },
|
|
43314
|
+
{ },
|
|
43315
|
+
body,
|
|
43316
|
+
['PureCloud OAuth'],
|
|
43317
|
+
['application/json'],
|
|
43318
|
+
['application/json']
|
|
43319
|
+
);
|
|
43320
|
+
}
|
|
43321
|
+
|
|
43125
43322
|
/**
|
|
43126
43323
|
* Create a response.
|
|
43127
43324
|
*
|
|
@@ -43240,13 +43437,43 @@ class ResponseManagementApi {
|
|
|
43240
43437
|
);
|
|
43241
43438
|
}
|
|
43242
43439
|
|
|
43440
|
+
/**
|
|
43441
|
+
* Update response asset
|
|
43442
|
+
*
|
|
43443
|
+
* @param {String} responseAssetId Asset Id
|
|
43444
|
+
* @param {Object} body request
|
|
43445
|
+
*/
|
|
43446
|
+
putResponsemanagementResponseasset(responseAssetId, body) {
|
|
43447
|
+
// verify the required parameter 'responseAssetId' is set
|
|
43448
|
+
if (responseAssetId === undefined || responseAssetId === null) {
|
|
43449
|
+
throw 'Missing the required parameter "responseAssetId" when calling putResponsemanagementResponseasset';
|
|
43450
|
+
}
|
|
43451
|
+
// verify the required parameter 'body' is set
|
|
43452
|
+
if (body === undefined || body === null) {
|
|
43453
|
+
throw 'Missing the required parameter "body" when calling putResponsemanagementResponseasset';
|
|
43454
|
+
}
|
|
43455
|
+
|
|
43456
|
+
return this.apiClient.callApi(
|
|
43457
|
+
'/api/v2/responsemanagement/responseassets/{responseAssetId}',
|
|
43458
|
+
'PUT',
|
|
43459
|
+
{ 'responseAssetId': responseAssetId },
|
|
43460
|
+
{ },
|
|
43461
|
+
{ },
|
|
43462
|
+
{ },
|
|
43463
|
+
body,
|
|
43464
|
+
['PureCloud OAuth'],
|
|
43465
|
+
['application/json'],
|
|
43466
|
+
['application/json']
|
|
43467
|
+
);
|
|
43468
|
+
}
|
|
43469
|
+
|
|
43243
43470
|
}
|
|
43244
43471
|
|
|
43245
43472
|
class RoutingApi {
|
|
43246
43473
|
/**
|
|
43247
43474
|
* Routing service.
|
|
43248
43475
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
43249
|
-
* @version
|
|
43476
|
+
* @version 135.0.0
|
|
43250
43477
|
*/
|
|
43251
43478
|
|
|
43252
43479
|
/**
|
|
@@ -46169,7 +46396,7 @@ class SCIMApi {
|
|
|
46169
46396
|
/**
|
|
46170
46397
|
* SCIM service.
|
|
46171
46398
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
46172
|
-
* @version
|
|
46399
|
+
* @version 135.0.0
|
|
46173
46400
|
*/
|
|
46174
46401
|
|
|
46175
46402
|
/**
|
|
@@ -47046,7 +47273,7 @@ class ScriptsApi {
|
|
|
47046
47273
|
/**
|
|
47047
47274
|
* Scripts service.
|
|
47048
47275
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
47049
|
-
* @version
|
|
47276
|
+
* @version 135.0.0
|
|
47050
47277
|
*/
|
|
47051
47278
|
|
|
47052
47279
|
/**
|
|
@@ -47162,6 +47389,7 @@ class ScriptsApi {
|
|
|
47162
47389
|
* @param {Object} opts.sortBy SortBy
|
|
47163
47390
|
* @param {Object} opts.sortOrder SortOrder
|
|
47164
47391
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
47392
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
47165
47393
|
*/
|
|
47166
47394
|
getScripts(opts) {
|
|
47167
47395
|
opts = opts || {};
|
|
@@ -47171,7 +47399,40 @@ class ScriptsApi {
|
|
|
47171
47399
|
'/api/v2/scripts',
|
|
47172
47400
|
'GET',
|
|
47173
47401
|
{ },
|
|
47174
|
-
{ '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'] },
|
|
47402
|
+
{ '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'] },
|
|
47403
|
+
{ },
|
|
47404
|
+
{ },
|
|
47405
|
+
null,
|
|
47406
|
+
['PureCloud OAuth'],
|
|
47407
|
+
['application/json'],
|
|
47408
|
+
['application/json']
|
|
47409
|
+
);
|
|
47410
|
+
}
|
|
47411
|
+
|
|
47412
|
+
/**
|
|
47413
|
+
* Get the metadata for a list of scripts
|
|
47414
|
+
*
|
|
47415
|
+
* @param {Object} opts Optional parameters
|
|
47416
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
47417
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
47418
|
+
* @param {String} opts.expand Expand
|
|
47419
|
+
* @param {String} opts.name Name filter
|
|
47420
|
+
* @param {String} opts.feature Feature filter
|
|
47421
|
+
* @param {String} opts.flowId Secure flow id filter
|
|
47422
|
+
* @param {Object} opts.sortBy SortBy
|
|
47423
|
+
* @param {Object} opts.sortOrder SortOrder
|
|
47424
|
+
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
47425
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
47426
|
+
*/
|
|
47427
|
+
getScriptsDivisionviews(opts) {
|
|
47428
|
+
opts = opts || {};
|
|
47429
|
+
|
|
47430
|
+
|
|
47431
|
+
return this.apiClient.callApi(
|
|
47432
|
+
'/api/v2/scripts/divisionviews',
|
|
47433
|
+
'GET',
|
|
47434
|
+
{ },
|
|
47435
|
+
{ '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'] },
|
|
47175
47436
|
{ },
|
|
47176
47437
|
{ },
|
|
47177
47438
|
null,
|
|
@@ -47192,6 +47453,7 @@ class ScriptsApi {
|
|
|
47192
47453
|
* @param {String} opts.feature Feature filter
|
|
47193
47454
|
* @param {String} opts.flowId Secure flow id filter
|
|
47194
47455
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
47456
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
47195
47457
|
*/
|
|
47196
47458
|
getScriptsPublished(opts) {
|
|
47197
47459
|
opts = opts || {};
|
|
@@ -47201,7 +47463,38 @@ class ScriptsApi {
|
|
|
47201
47463
|
'/api/v2/scripts/published',
|
|
47202
47464
|
'GET',
|
|
47203
47465
|
{ },
|
|
47204
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'] },
|
|
47466
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
47467
|
+
{ },
|
|
47468
|
+
{ },
|
|
47469
|
+
null,
|
|
47470
|
+
['PureCloud OAuth'],
|
|
47471
|
+
['application/json'],
|
|
47472
|
+
['application/json']
|
|
47473
|
+
);
|
|
47474
|
+
}
|
|
47475
|
+
|
|
47476
|
+
/**
|
|
47477
|
+
* Get the published scripts metadata.
|
|
47478
|
+
*
|
|
47479
|
+
* @param {Object} opts Optional parameters
|
|
47480
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
47481
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
47482
|
+
* @param {String} opts.expand Expand
|
|
47483
|
+
* @param {String} opts.name Name filter
|
|
47484
|
+
* @param {String} opts.feature Feature filter
|
|
47485
|
+
* @param {String} opts.flowId Secure flow id filter
|
|
47486
|
+
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
47487
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
47488
|
+
*/
|
|
47489
|
+
getScriptsPublishedDivisionviews(opts) {
|
|
47490
|
+
opts = opts || {};
|
|
47491
|
+
|
|
47492
|
+
|
|
47493
|
+
return this.apiClient.callApi(
|
|
47494
|
+
'/api/v2/scripts/published/divisionviews',
|
|
47495
|
+
'GET',
|
|
47496
|
+
{ },
|
|
47497
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
47205
47498
|
{ },
|
|
47206
47499
|
{ },
|
|
47207
47500
|
null,
|
|
@@ -47399,7 +47692,7 @@ class SearchApi {
|
|
|
47399
47692
|
/**
|
|
47400
47693
|
* Search service.
|
|
47401
47694
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
47402
|
-
* @version
|
|
47695
|
+
* @version 135.0.0
|
|
47403
47696
|
*/
|
|
47404
47697
|
|
|
47405
47698
|
/**
|
|
@@ -47934,7 +48227,7 @@ class SpeechTextAnalyticsApi {
|
|
|
47934
48227
|
/**
|
|
47935
48228
|
* SpeechTextAnalytics service.
|
|
47936
48229
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
47937
|
-
* @version
|
|
48230
|
+
* @version 135.0.0
|
|
47938
48231
|
*/
|
|
47939
48232
|
|
|
47940
48233
|
/**
|
|
@@ -48787,7 +49080,7 @@ class StationsApi {
|
|
|
48787
49080
|
/**
|
|
48788
49081
|
* Stations service.
|
|
48789
49082
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
48790
|
-
* @version
|
|
49083
|
+
* @version 135.0.0
|
|
48791
49084
|
*/
|
|
48792
49085
|
|
|
48793
49086
|
/**
|
|
@@ -48934,7 +49227,7 @@ class SuggestApi {
|
|
|
48934
49227
|
/**
|
|
48935
49228
|
* Suggest service.
|
|
48936
49229
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
48937
|
-
* @version
|
|
49230
|
+
* @version 135.0.0
|
|
48938
49231
|
*/
|
|
48939
49232
|
|
|
48940
49233
|
/**
|
|
@@ -49073,7 +49366,7 @@ class TelephonyApi {
|
|
|
49073
49366
|
/**
|
|
49074
49367
|
* Telephony service.
|
|
49075
49368
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
49076
|
-
* @version
|
|
49369
|
+
* @version 135.0.0
|
|
49077
49370
|
*/
|
|
49078
49371
|
|
|
49079
49372
|
/**
|
|
@@ -49181,7 +49474,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
49181
49474
|
/**
|
|
49182
49475
|
* TelephonyProvidersEdge service.
|
|
49183
49476
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
49184
|
-
* @version
|
|
49477
|
+
* @version 135.0.0
|
|
49185
49478
|
*/
|
|
49186
49479
|
|
|
49187
49480
|
/**
|
|
@@ -50596,7 +50889,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
50596
50889
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
50597
50890
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
50598
50891
|
* @param {String} opts.sortBy Sort by
|
|
50599
|
-
* @param {String} opts._number
|
|
50892
|
+
* @param {String} opts._number Deprecated, filtering by number not supported
|
|
50600
50893
|
*/
|
|
50601
50894
|
getTelephonyProvidersEdgesExtensionpools(opts) {
|
|
50602
50895
|
opts = opts || {};
|
|
@@ -52814,7 +53107,7 @@ class TextbotsApi {
|
|
|
52814
53107
|
/**
|
|
52815
53108
|
* Textbots service.
|
|
52816
53109
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
52817
|
-
* @version
|
|
53110
|
+
* @version 135.0.0
|
|
52818
53111
|
*/
|
|
52819
53112
|
|
|
52820
53113
|
/**
|
|
@@ -52942,7 +53235,7 @@ class TokensApi {
|
|
|
52942
53235
|
/**
|
|
52943
53236
|
* Tokens service.
|
|
52944
53237
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
52945
|
-
* @version
|
|
53238
|
+
* @version 135.0.0
|
|
52946
53239
|
*/
|
|
52947
53240
|
|
|
52948
53241
|
/**
|
|
@@ -53048,7 +53341,7 @@ class UploadsApi {
|
|
|
53048
53341
|
/**
|
|
53049
53342
|
* Uploads service.
|
|
53050
53343
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
53051
|
-
* @version
|
|
53344
|
+
* @version 135.0.0
|
|
53052
53345
|
*/
|
|
53053
53346
|
|
|
53054
53347
|
/**
|
|
@@ -53193,38 +53486,13 @@ class UploadsApi {
|
|
|
53193
53486
|
);
|
|
53194
53487
|
}
|
|
53195
53488
|
|
|
53196
|
-
/**
|
|
53197
|
-
* Creates presigned url for uploading WFM historical data file. Requires data in json format.
|
|
53198
|
-
*
|
|
53199
|
-
* @param {Object} body query
|
|
53200
|
-
*/
|
|
53201
|
-
postUploadsWorkforcemanagementHistoricaldataJson(body) {
|
|
53202
|
-
// verify the required parameter 'body' is set
|
|
53203
|
-
if (body === undefined || body === null) {
|
|
53204
|
-
throw 'Missing the required parameter "body" when calling postUploadsWorkforcemanagementHistoricaldataJson';
|
|
53205
|
-
}
|
|
53206
|
-
|
|
53207
|
-
return this.apiClient.callApi(
|
|
53208
|
-
'/api/v2/uploads/workforcemanagement/historicaldata/json',
|
|
53209
|
-
'POST',
|
|
53210
|
-
{ },
|
|
53211
|
-
{ },
|
|
53212
|
-
{ },
|
|
53213
|
-
{ },
|
|
53214
|
-
body,
|
|
53215
|
-
['PureCloud OAuth'],
|
|
53216
|
-
['application/json'],
|
|
53217
|
-
['application/json']
|
|
53218
|
-
);
|
|
53219
|
-
}
|
|
53220
|
-
|
|
53221
53489
|
}
|
|
53222
53490
|
|
|
53223
53491
|
class UsageApi {
|
|
53224
53492
|
/**
|
|
53225
53493
|
* Usage service.
|
|
53226
53494
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
53227
|
-
* @version
|
|
53495
|
+
* @version 135.0.0
|
|
53228
53496
|
*/
|
|
53229
53497
|
|
|
53230
53498
|
/**
|
|
@@ -53295,7 +53563,7 @@ class UserRecordingsApi {
|
|
|
53295
53563
|
/**
|
|
53296
53564
|
* UserRecordings service.
|
|
53297
53565
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
53298
|
-
* @version
|
|
53566
|
+
* @version 135.0.0
|
|
53299
53567
|
*/
|
|
53300
53568
|
|
|
53301
53569
|
/**
|
|
@@ -53479,7 +53747,7 @@ class UsersApi {
|
|
|
53479
53747
|
/**
|
|
53480
53748
|
* Users service.
|
|
53481
53749
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
53482
|
-
* @version
|
|
53750
|
+
* @version 135.0.0
|
|
53483
53751
|
*/
|
|
53484
53752
|
|
|
53485
53753
|
/**
|
|
@@ -55781,7 +56049,7 @@ class UtilitiesApi {
|
|
|
55781
56049
|
/**
|
|
55782
56050
|
* Utilities service.
|
|
55783
56051
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
55784
|
-
* @version
|
|
56052
|
+
* @version 135.0.0
|
|
55785
56053
|
*/
|
|
55786
56054
|
|
|
55787
56055
|
/**
|
|
@@ -55892,7 +56160,7 @@ class VoicemailApi {
|
|
|
55892
56160
|
/**
|
|
55893
56161
|
* Voicemail service.
|
|
55894
56162
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
55895
|
-
* @version
|
|
56163
|
+
* @version 135.0.0
|
|
55896
56164
|
*/
|
|
55897
56165
|
|
|
55898
56166
|
/**
|
|
@@ -56559,7 +56827,7 @@ class WebChatApi {
|
|
|
56559
56827
|
/**
|
|
56560
56828
|
* WebChat service.
|
|
56561
56829
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
56562
|
-
* @version
|
|
56830
|
+
* @version 135.0.0
|
|
56563
56831
|
*/
|
|
56564
56832
|
|
|
56565
56833
|
/**
|
|
@@ -57103,7 +57371,7 @@ class WebDeploymentsApi {
|
|
|
57103
57371
|
/**
|
|
57104
57372
|
* WebDeployments service.
|
|
57105
57373
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
57106
|
-
* @version
|
|
57374
|
+
* @version 135.0.0
|
|
57107
57375
|
*/
|
|
57108
57376
|
|
|
57109
57377
|
/**
|
|
@@ -57458,7 +57726,7 @@ class WebMessagingApi {
|
|
|
57458
57726
|
/**
|
|
57459
57727
|
* WebMessaging service.
|
|
57460
57728
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
57461
|
-
* @version
|
|
57729
|
+
* @version 135.0.0
|
|
57462
57730
|
*/
|
|
57463
57731
|
|
|
57464
57732
|
/**
|
|
@@ -57504,7 +57772,7 @@ class WidgetsApi {
|
|
|
57504
57772
|
/**
|
|
57505
57773
|
* Widgets service.
|
|
57506
57774
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
57507
|
-
* @version
|
|
57775
|
+
* @version 135.0.0
|
|
57508
57776
|
*/
|
|
57509
57777
|
|
|
57510
57778
|
/**
|
|
@@ -57650,7 +57918,7 @@ class WorkforceManagementApi {
|
|
|
57650
57918
|
/**
|
|
57651
57919
|
* WorkforceManagement service.
|
|
57652
57920
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
57653
|
-
* @version
|
|
57921
|
+
* @version 135.0.0
|
|
57654
57922
|
*/
|
|
57655
57923
|
|
|
57656
57924
|
/**
|
|
@@ -57848,7 +58116,7 @@ class WorkforceManagementApi {
|
|
|
57848
58116
|
/**
|
|
57849
58117
|
* Delete a short term forecast
|
|
57850
58118
|
* Must not be tied to any schedules
|
|
57851
|
-
* @param {String} businessUnitId The
|
|
58119
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
57852
58120
|
* @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
|
|
57853
58121
|
* @param {String} forecastId The ID of the forecast
|
|
57854
58122
|
*/
|
|
@@ -57928,7 +58196,7 @@ class WorkforceManagementApi {
|
|
|
57928
58196
|
/**
|
|
57929
58197
|
* Deletes a time off limit object
|
|
57930
58198
|
*
|
|
57931
|
-
* @param {String} managementUnitId The
|
|
58199
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
57932
58200
|
* @param {String} timeOffLimitId The ID of the time off limit object to delete
|
|
57933
58201
|
*/
|
|
57934
58202
|
deleteWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
@@ -57958,7 +58226,7 @@ class WorkforceManagementApi {
|
|
|
57958
58226
|
/**
|
|
57959
58227
|
* Deletes a time off plan
|
|
57960
58228
|
*
|
|
57961
|
-
* @param {String} managementUnitId The management unit
|
|
58229
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
57962
58230
|
* @param {String} timeOffPlanId The ID of the time off plan to delete
|
|
57963
58231
|
*/
|
|
57964
58232
|
deleteWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
@@ -58227,7 +58495,7 @@ class WorkforceManagementApi {
|
|
|
58227
58495
|
/**
|
|
58228
58496
|
* Get intraday planning groups for the given date
|
|
58229
58497
|
*
|
|
58230
|
-
* @param {String} businessUnitId The
|
|
58498
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
58231
58499
|
* @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
|
|
58232
58500
|
*/
|
|
58233
58501
|
getWorkforcemanagementBusinessunitIntradayPlanninggroups(businessUnitId, _date) {
|
|
@@ -58680,7 +58948,7 @@ class WorkforceManagementApi {
|
|
|
58680
58948
|
/**
|
|
58681
58949
|
* Get a short term forecast
|
|
58682
58950
|
*
|
|
58683
|
-
* @param {String} businessUnitId The
|
|
58951
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
58684
58952
|
* @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
|
|
58685
58953
|
* @param {String} forecastId The ID of the forecast
|
|
58686
58954
|
* @param {Object} opts Optional parameters
|
|
@@ -58719,7 +58987,7 @@ class WorkforceManagementApi {
|
|
|
58719
58987
|
/**
|
|
58720
58988
|
* Get the result of a short term forecast calculation
|
|
58721
58989
|
* Includes modifications unless you pass the doNotApplyModifications query parameter
|
|
58722
|
-
* @param {String} businessUnitId The
|
|
58990
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
58723
58991
|
* @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
|
|
58724
58992
|
* @param {String} forecastId The ID of the forecast
|
|
58725
58993
|
* @param {Object} opts Optional parameters
|
|
@@ -58759,7 +59027,7 @@ class WorkforceManagementApi {
|
|
|
58759
59027
|
/**
|
|
58760
59028
|
* Gets the forecast generation results
|
|
58761
59029
|
*
|
|
58762
|
-
* @param {String} businessUnitId The
|
|
59030
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
58763
59031
|
* @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
|
|
58764
59032
|
* @param {String} forecastId The ID of the forecast
|
|
58765
59033
|
*/
|
|
@@ -58794,7 +59062,7 @@ class WorkforceManagementApi {
|
|
|
58794
59062
|
/**
|
|
58795
59063
|
* Get the result of a long term forecast calculation
|
|
58796
59064
|
* Includes modifications unless you pass the doNotApplyModifications query parameter
|
|
58797
|
-
* @param {String} businessUnitId The
|
|
59065
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
58798
59066
|
* @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
|
|
58799
59067
|
* @param {String} forecastId The ID of the forecast
|
|
58800
59068
|
* @param {Object} opts Optional parameters
|
|
@@ -58833,7 +59101,7 @@ class WorkforceManagementApi {
|
|
|
58833
59101
|
/**
|
|
58834
59102
|
* Gets the forecast planning group snapshot
|
|
58835
59103
|
*
|
|
58836
|
-
* @param {String} businessUnitId The
|
|
59104
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
58837
59105
|
* @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
|
|
58838
59106
|
* @param {String} forecastId The ID of the forecast
|
|
58839
59107
|
*/
|
|
@@ -58868,7 +59136,7 @@ class WorkforceManagementApi {
|
|
|
58868
59136
|
/**
|
|
58869
59137
|
* Get short term forecasts
|
|
58870
59138
|
* 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
|
|
58871
|
-
* @param {String} businessUnitId The
|
|
59139
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
58872
59140
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format or 'recent' (without quotes) to fetch recent forecasts
|
|
58873
59141
|
*/
|
|
58874
59142
|
getWorkforcemanagementBusinessunitWeekShorttermforecasts(businessUnitId, weekDateId) {
|
|
@@ -59086,7 +59354,7 @@ class WorkforceManagementApi {
|
|
|
59086
59354
|
/**
|
|
59087
59355
|
* Get a list of user schedule adherence records for the requested management unit
|
|
59088
59356
|
*
|
|
59089
|
-
* @param {String} managementUnitId The
|
|
59357
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
59090
59358
|
* @param {Object} opts Optional parameters
|
|
59091
59359
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
59092
59360
|
*/
|
|
@@ -59115,7 +59383,7 @@ class WorkforceManagementApi {
|
|
|
59115
59383
|
/**
|
|
59116
59384
|
* Get data for agent in the management unit
|
|
59117
59385
|
*
|
|
59118
|
-
* @param {String} managementUnitId The
|
|
59386
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
59119
59387
|
* @param {String} agentId The agent id
|
|
59120
59388
|
* @param {Object} opts Optional parameters
|
|
59121
59389
|
* @param {Boolean} opts.excludeCapabilities Excludes all capabilities of the agent such as queues, languages, and skills
|
|
@@ -59149,7 +59417,7 @@ class WorkforceManagementApi {
|
|
|
59149
59417
|
/**
|
|
59150
59418
|
* Gets all the shift trades for a given agent
|
|
59151
59419
|
*
|
|
59152
|
-
* @param {String} managementUnitId The
|
|
59420
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
59153
59421
|
* @param {String} agentId The agent id
|
|
59154
59422
|
*/
|
|
59155
59423
|
getWorkforcemanagementManagementunitAgentShifttrades(managementUnitId, agentId) {
|
|
@@ -59179,7 +59447,7 @@ class WorkforceManagementApi {
|
|
|
59179
59447
|
/**
|
|
59180
59448
|
* Gets a summary of all shift trades in the matched state
|
|
59181
59449
|
*
|
|
59182
|
-
* @param {String} managementUnitId The
|
|
59450
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
59183
59451
|
*/
|
|
59184
59452
|
getWorkforcemanagementManagementunitShifttradesMatched(managementUnitId) {
|
|
59185
59453
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -59204,7 +59472,7 @@ class WorkforceManagementApi {
|
|
|
59204
59472
|
/**
|
|
59205
59473
|
* Gets list of users available for whom you can send direct shift trade requests
|
|
59206
59474
|
*
|
|
59207
|
-
* @param {String} managementUnitId The
|
|
59475
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
59208
59476
|
*/
|
|
59209
59477
|
getWorkforcemanagementManagementunitShifttradesUsers(managementUnitId) {
|
|
59210
59478
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -59229,7 +59497,7 @@ class WorkforceManagementApi {
|
|
|
59229
59497
|
/**
|
|
59230
59498
|
* Gets a time off limit object
|
|
59231
59499
|
* Returns properties of time off limit object, but not daily values.
|
|
59232
|
-
* @param {String} managementUnitId The
|
|
59500
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
59233
59501
|
* @param {String} timeOffLimitId The ID of the time off limit to fetch
|
|
59234
59502
|
*/
|
|
59235
59503
|
getWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
@@ -59259,7 +59527,7 @@ class WorkforceManagementApi {
|
|
|
59259
59527
|
/**
|
|
59260
59528
|
* Gets a list of time off limit objects under management unit.
|
|
59261
59529
|
* Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.
|
|
59262
|
-
* @param {String} managementUnitId The
|
|
59530
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
59263
59531
|
*/
|
|
59264
59532
|
getWorkforcemanagementManagementunitTimeofflimits(managementUnitId) {
|
|
59265
59533
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -59284,7 +59552,7 @@ class WorkforceManagementApi {
|
|
|
59284
59552
|
/**
|
|
59285
59553
|
* Gets a time off plan
|
|
59286
59554
|
*
|
|
59287
|
-
* @param {String} managementUnitId The management unit
|
|
59555
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
59288
59556
|
* @param {String} timeOffPlanId The ID of the time off plan to fetch
|
|
59289
59557
|
*/
|
|
59290
59558
|
getWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
@@ -59314,7 +59582,7 @@ class WorkforceManagementApi {
|
|
|
59314
59582
|
/**
|
|
59315
59583
|
* Gets a list of time off plans
|
|
59316
59584
|
*
|
|
59317
|
-
* @param {String} managementUnitId The management unit
|
|
59585
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
59318
59586
|
*/
|
|
59319
59587
|
getWorkforcemanagementManagementunitTimeoffplans(managementUnitId) {
|
|
59320
59588
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -59339,7 +59607,7 @@ class WorkforceManagementApi {
|
|
|
59339
59607
|
/**
|
|
59340
59608
|
* Get a time off request
|
|
59341
59609
|
*
|
|
59342
|
-
* @param {String} managementUnitId The
|
|
59610
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
59343
59611
|
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
59344
59612
|
* @param {String} timeOffRequestId Time Off Request Id
|
|
59345
59613
|
*/
|
|
@@ -59374,7 +59642,7 @@ class WorkforceManagementApi {
|
|
|
59374
59642
|
/**
|
|
59375
59643
|
* Retrieves time off limit, allocated and waitlisted values according to specific time off request
|
|
59376
59644
|
*
|
|
59377
|
-
* @param {String} managementUnitId The
|
|
59645
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
59378
59646
|
* @param {String} userId The userId to whom the time off request applies.
|
|
59379
59647
|
* @param {String} timeOffRequestId The ID of the time off request, which dates and activityCodeId determine limit values to retrieve
|
|
59380
59648
|
*/
|
|
@@ -59409,7 +59677,7 @@ class WorkforceManagementApi {
|
|
|
59409
59677
|
/**
|
|
59410
59678
|
* Get a list of time off requests for a given user
|
|
59411
59679
|
*
|
|
59412
|
-
* @param {String} managementUnitId The
|
|
59680
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
59413
59681
|
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
59414
59682
|
* @param {Object} opts Optional parameters
|
|
59415
59683
|
* @param {Boolean} opts.recentlyReviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
|
|
@@ -59443,7 +59711,7 @@ class WorkforceManagementApi {
|
|
|
59443
59711
|
/**
|
|
59444
59712
|
* Get users in the management unit
|
|
59445
59713
|
*
|
|
59446
|
-
* @param {String} managementUnitId The
|
|
59714
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
59447
59715
|
*/
|
|
59448
59716
|
getWorkforcemanagementManagementunitUsers(managementUnitId) {
|
|
59449
59717
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -59544,7 +59812,7 @@ class WorkforceManagementApi {
|
|
|
59544
59812
|
/**
|
|
59545
59813
|
* Gets all the shift trades for a given week
|
|
59546
59814
|
*
|
|
59547
|
-
* @param {String} managementUnitId The
|
|
59815
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
59548
59816
|
* @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
|
|
59549
59817
|
* @param {Object} opts Optional parameters
|
|
59550
59818
|
* @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
|
|
@@ -59817,7 +60085,7 @@ class WorkforceManagementApi {
|
|
|
59817
60085
|
/**
|
|
59818
60086
|
* Get a time off request for the current user
|
|
59819
60087
|
*
|
|
59820
|
-
* @param {String} timeOffRequestId
|
|
60088
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
59821
60089
|
*/
|
|
59822
60090
|
getWorkforcemanagementTimeoffrequest(timeOffRequestId) {
|
|
59823
60091
|
// verify the required parameter 'timeOffRequestId' is set
|
|
@@ -59842,7 +60110,7 @@ class WorkforceManagementApi {
|
|
|
59842
60110
|
/**
|
|
59843
60111
|
* Get the daily waitlist positions of a time off request for the current user
|
|
59844
60112
|
*
|
|
59845
|
-
* @param {String} timeOffRequestId
|
|
60113
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
59846
60114
|
*/
|
|
59847
60115
|
getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId) {
|
|
59848
60116
|
// verify the required parameter 'timeOffRequestId' is set
|
|
@@ -60085,7 +60353,7 @@ class WorkforceManagementApi {
|
|
|
60085
60353
|
/**
|
|
60086
60354
|
* Updates a time off limit object.
|
|
60087
60355
|
* Updates time off limit object properties, but not daily values.
|
|
60088
|
-
* @param {String} managementUnitId The
|
|
60356
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
60089
60357
|
* @param {String} timeOffLimitId The id of time off limit object to update
|
|
60090
60358
|
* @param {Object} opts Optional parameters
|
|
60091
60359
|
* @param {Object} opts.body body
|
|
@@ -60119,7 +60387,7 @@ class WorkforceManagementApi {
|
|
|
60119
60387
|
/**
|
|
60120
60388
|
* Updates a time off plan
|
|
60121
60389
|
*
|
|
60122
|
-
* @param {String} managementUnitId The management unit
|
|
60390
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
60123
60391
|
* @param {String} timeOffPlanId The ID of the time off plan to update
|
|
60124
60392
|
* @param {Object} opts Optional parameters
|
|
60125
60393
|
* @param {Object} opts.body body
|
|
@@ -60153,7 +60421,7 @@ class WorkforceManagementApi {
|
|
|
60153
60421
|
/**
|
|
60154
60422
|
* Update a time off request
|
|
60155
60423
|
*
|
|
60156
|
-
* @param {String} managementUnitId The
|
|
60424
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
60157
60425
|
* @param {String} userId The id of the user the requested time off request belongs to
|
|
60158
60426
|
* @param {String} timeOffRequestId The id of the time off request to update
|
|
60159
60427
|
* @param {Object} opts Optional parameters
|
|
@@ -60192,7 +60460,7 @@ class WorkforceManagementApi {
|
|
|
60192
60460
|
/**
|
|
60193
60461
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
60194
60462
|
*
|
|
60195
|
-
* @param {String} managementUnitId The
|
|
60463
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
60196
60464
|
* @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
|
|
60197
60465
|
* @param {Object} body body
|
|
60198
60466
|
* @param {String} tradeId The ID of the shift trade to update
|
|
@@ -60301,7 +60569,7 @@ class WorkforceManagementApi {
|
|
|
60301
60569
|
/**
|
|
60302
60570
|
* Update a time off request for the current user
|
|
60303
60571
|
*
|
|
60304
|
-
* @param {String} timeOffRequestId
|
|
60572
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
60305
60573
|
* @param {Object} opts Optional parameters
|
|
60306
60574
|
* @param {Object} opts.body body
|
|
60307
60575
|
*/
|
|
@@ -60438,7 +60706,7 @@ class WorkforceManagementApi {
|
|
|
60438
60706
|
/**
|
|
60439
60707
|
* Get intraday data for the given date for the requested planningGroupIds
|
|
60440
60708
|
*
|
|
60441
|
-
* @param {String} businessUnitId The
|
|
60709
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
60442
60710
|
* @param {Object} opts Optional parameters
|
|
60443
60711
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
60444
60712
|
* @param {Object} opts.body body
|
|
@@ -60648,6 +60916,86 @@ class WorkforceManagementApi {
|
|
|
60648
60916
|
);
|
|
60649
60917
|
}
|
|
60650
60918
|
|
|
60919
|
+
/**
|
|
60920
|
+
* Starts processing a schedule update
|
|
60921
|
+
* Call after uploading the schedule data to the url supplied by the /update/uploadurl route
|
|
60922
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
60923
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
60924
|
+
* @param {String} scheduleId The ID of the schedule
|
|
60925
|
+
* @param {Object} body body
|
|
60926
|
+
*/
|
|
60927
|
+
postWorkforcemanagementBusinessunitWeekScheduleUpdate(businessUnitId, weekId, scheduleId, body) {
|
|
60928
|
+
// verify the required parameter 'businessUnitId' is set
|
|
60929
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
60930
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdate';
|
|
60931
|
+
}
|
|
60932
|
+
// verify the required parameter 'weekId' is set
|
|
60933
|
+
if (weekId === undefined || weekId === null) {
|
|
60934
|
+
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdate';
|
|
60935
|
+
}
|
|
60936
|
+
// verify the required parameter 'scheduleId' is set
|
|
60937
|
+
if (scheduleId === undefined || scheduleId === null) {
|
|
60938
|
+
throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdate';
|
|
60939
|
+
}
|
|
60940
|
+
// verify the required parameter 'body' is set
|
|
60941
|
+
if (body === undefined || body === null) {
|
|
60942
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdate';
|
|
60943
|
+
}
|
|
60944
|
+
|
|
60945
|
+
return this.apiClient.callApi(
|
|
60946
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/update',
|
|
60947
|
+
'POST',
|
|
60948
|
+
{ 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
60949
|
+
{ },
|
|
60950
|
+
{ },
|
|
60951
|
+
{ },
|
|
60952
|
+
body,
|
|
60953
|
+
['PureCloud OAuth'],
|
|
60954
|
+
['application/json'],
|
|
60955
|
+
['application/json']
|
|
60956
|
+
);
|
|
60957
|
+
}
|
|
60958
|
+
|
|
60959
|
+
/**
|
|
60960
|
+
* Creates a signed upload URL for updating a schedule
|
|
60961
|
+
* Once the upload is complete, call the /{scheduleId}/update route to start the schedule update process
|
|
60962
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
60963
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
60964
|
+
* @param {String} scheduleId The ID of the schedule
|
|
60965
|
+
* @param {Object} body body
|
|
60966
|
+
*/
|
|
60967
|
+
postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl(businessUnitId, weekId, scheduleId, body) {
|
|
60968
|
+
// verify the required parameter 'businessUnitId' is set
|
|
60969
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
60970
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl';
|
|
60971
|
+
}
|
|
60972
|
+
// verify the required parameter 'weekId' is set
|
|
60973
|
+
if (weekId === undefined || weekId === null) {
|
|
60974
|
+
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl';
|
|
60975
|
+
}
|
|
60976
|
+
// verify the required parameter 'scheduleId' is set
|
|
60977
|
+
if (scheduleId === undefined || scheduleId === null) {
|
|
60978
|
+
throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl';
|
|
60979
|
+
}
|
|
60980
|
+
// verify the required parameter 'body' is set
|
|
60981
|
+
if (body === undefined || body === null) {
|
|
60982
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekScheduleUpdateUploadurl';
|
|
60983
|
+
}
|
|
60984
|
+
|
|
60985
|
+
return this.apiClient.callApi(
|
|
60986
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/update/uploadurl',
|
|
60987
|
+
'POST',
|
|
60988
|
+
{ 'businessUnitId': businessUnitId,'weekId': weekId,'scheduleId': scheduleId },
|
|
60989
|
+
{ },
|
|
60990
|
+
{ },
|
|
60991
|
+
{ },
|
|
60992
|
+
body,
|
|
60993
|
+
['PureCloud OAuth'],
|
|
60994
|
+
['application/json'],
|
|
60995
|
+
['application/json']
|
|
60996
|
+
);
|
|
60997
|
+
}
|
|
60998
|
+
|
|
60651
60999
|
/**
|
|
60652
61000
|
* Create a blank schedule
|
|
60653
61001
|
*
|
|
@@ -60718,10 +61066,80 @@ class WorkforceManagementApi {
|
|
|
60718
61066
|
);
|
|
60719
61067
|
}
|
|
60720
61068
|
|
|
61069
|
+
/**
|
|
61070
|
+
* Starts processing a schedule import
|
|
61071
|
+
* Call after uploading the schedule data to the url supplied by the /import/uploadurl route
|
|
61072
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
61073
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
61074
|
+
* @param {Object} body
|
|
61075
|
+
*/
|
|
61076
|
+
postWorkforcemanagementBusinessunitWeekSchedulesImport(businessUnitId, weekId, body) {
|
|
61077
|
+
// verify the required parameter 'businessUnitId' is set
|
|
61078
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
61079
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulesImport';
|
|
61080
|
+
}
|
|
61081
|
+
// verify the required parameter 'weekId' is set
|
|
61082
|
+
if (weekId === undefined || weekId === null) {
|
|
61083
|
+
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulesImport';
|
|
61084
|
+
}
|
|
61085
|
+
// verify the required parameter 'body' is set
|
|
61086
|
+
if (body === undefined || body === null) {
|
|
61087
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekSchedulesImport';
|
|
61088
|
+
}
|
|
61089
|
+
|
|
61090
|
+
return this.apiClient.callApi(
|
|
61091
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/import',
|
|
61092
|
+
'POST',
|
|
61093
|
+
{ 'businessUnitId': businessUnitId,'weekId': weekId },
|
|
61094
|
+
{ },
|
|
61095
|
+
{ },
|
|
61096
|
+
{ },
|
|
61097
|
+
body,
|
|
61098
|
+
['PureCloud OAuth'],
|
|
61099
|
+
['application/json'],
|
|
61100
|
+
['application/json']
|
|
61101
|
+
);
|
|
61102
|
+
}
|
|
61103
|
+
|
|
61104
|
+
/**
|
|
61105
|
+
* Creates a signed upload URL for importing a schedule
|
|
61106
|
+
* Once the upload is complete, call the /import route to start the schedule import process
|
|
61107
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
61108
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
61109
|
+
* @param {Object} body body
|
|
61110
|
+
*/
|
|
61111
|
+
postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl(businessUnitId, weekId, body) {
|
|
61112
|
+
// verify the required parameter 'businessUnitId' is set
|
|
61113
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
61114
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl';
|
|
61115
|
+
}
|
|
61116
|
+
// verify the required parameter 'weekId' is set
|
|
61117
|
+
if (weekId === undefined || weekId === null) {
|
|
61118
|
+
throw 'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl';
|
|
61119
|
+
}
|
|
61120
|
+
// verify the required parameter 'body' is set
|
|
61121
|
+
if (body === undefined || body === null) {
|
|
61122
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekSchedulesImportUploadurl';
|
|
61123
|
+
}
|
|
61124
|
+
|
|
61125
|
+
return this.apiClient.callApi(
|
|
61126
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/import/uploadurl',
|
|
61127
|
+
'POST',
|
|
61128
|
+
{ 'businessUnitId': businessUnitId,'weekId': weekId },
|
|
61129
|
+
{ },
|
|
61130
|
+
{ },
|
|
61131
|
+
{ },
|
|
61132
|
+
body,
|
|
61133
|
+
['PureCloud OAuth'],
|
|
61134
|
+
['application/json'],
|
|
61135
|
+
['application/json']
|
|
61136
|
+
);
|
|
61137
|
+
}
|
|
61138
|
+
|
|
60721
61139
|
/**
|
|
60722
61140
|
* Copy a short term forecast
|
|
60723
61141
|
*
|
|
60724
|
-
* @param {String} businessUnitId The
|
|
61142
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
60725
61143
|
* @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
|
|
60726
61144
|
* @param {String} forecastId The ID of the forecast to copy
|
|
60727
61145
|
* @param {Object} body body
|
|
@@ -60765,7 +61183,7 @@ class WorkforceManagementApi {
|
|
|
60765
61183
|
/**
|
|
60766
61184
|
* Generate a short term forecast
|
|
60767
61185
|
*
|
|
60768
|
-
* @param {String} businessUnitId The
|
|
61186
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
60769
61187
|
* @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
|
|
60770
61188
|
* @param {Object} body
|
|
60771
61189
|
* @param {Object} opts Optional parameters
|
|
@@ -60801,6 +61219,76 @@ class WorkforceManagementApi {
|
|
|
60801
61219
|
);
|
|
60802
61220
|
}
|
|
60803
61221
|
|
|
61222
|
+
/**
|
|
61223
|
+
* Starts importing the uploaded short term forecast
|
|
61224
|
+
* Call after uploading the forecast data to the url supplied by the /import/uploadurl route
|
|
61225
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
61226
|
+
* @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
|
|
61227
|
+
* @param {Object} body
|
|
61228
|
+
*/
|
|
61229
|
+
postWorkforcemanagementBusinessunitWeekShorttermforecastsImport(businessUnitId, weekDateId, body) {
|
|
61230
|
+
// verify the required parameter 'businessUnitId' is set
|
|
61231
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
61232
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImport';
|
|
61233
|
+
}
|
|
61234
|
+
// verify the required parameter 'weekDateId' is set
|
|
61235
|
+
if (weekDateId === undefined || weekDateId === null) {
|
|
61236
|
+
throw 'Missing the required parameter "weekDateId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImport';
|
|
61237
|
+
}
|
|
61238
|
+
// verify the required parameter 'body' is set
|
|
61239
|
+
if (body === undefined || body === null) {
|
|
61240
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImport';
|
|
61241
|
+
}
|
|
61242
|
+
|
|
61243
|
+
return this.apiClient.callApi(
|
|
61244
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/import',
|
|
61245
|
+
'POST',
|
|
61246
|
+
{ 'businessUnitId': businessUnitId,'weekDateId': weekDateId },
|
|
61247
|
+
{ },
|
|
61248
|
+
{ },
|
|
61249
|
+
{ },
|
|
61250
|
+
body,
|
|
61251
|
+
['PureCloud OAuth'],
|
|
61252
|
+
['application/json'],
|
|
61253
|
+
['application/json']
|
|
61254
|
+
);
|
|
61255
|
+
}
|
|
61256
|
+
|
|
61257
|
+
/**
|
|
61258
|
+
* Creates a signed upload URL for importing a short term forecast
|
|
61259
|
+
* Once the upload is complete, call the /import route to start the short term forecast import process
|
|
61260
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
61261
|
+
* @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
|
|
61262
|
+
* @param {Object} body body
|
|
61263
|
+
*/
|
|
61264
|
+
postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl(businessUnitId, weekDateId, body) {
|
|
61265
|
+
// verify the required parameter 'businessUnitId' is set
|
|
61266
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
61267
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl';
|
|
61268
|
+
}
|
|
61269
|
+
// verify the required parameter 'weekDateId' is set
|
|
61270
|
+
if (weekDateId === undefined || weekDateId === null) {
|
|
61271
|
+
throw 'Missing the required parameter "weekDateId" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl';
|
|
61272
|
+
}
|
|
61273
|
+
// verify the required parameter 'body' is set
|
|
61274
|
+
if (body === undefined || body === null) {
|
|
61275
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekShorttermforecastsImportUploadurl';
|
|
61276
|
+
}
|
|
61277
|
+
|
|
61278
|
+
return this.apiClient.callApi(
|
|
61279
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/import/uploadurl',
|
|
61280
|
+
'POST',
|
|
61281
|
+
{ 'businessUnitId': businessUnitId,'weekDateId': weekDateId },
|
|
61282
|
+
{ },
|
|
61283
|
+
{ },
|
|
61284
|
+
{ },
|
|
61285
|
+
body,
|
|
61286
|
+
['PureCloud OAuth'],
|
|
61287
|
+
['application/json'],
|
|
61288
|
+
['application/json']
|
|
61289
|
+
);
|
|
61290
|
+
}
|
|
61291
|
+
|
|
60804
61292
|
/**
|
|
60805
61293
|
* Add a new business unit
|
|
60806
61294
|
* It may take a minute or two for a new business unit to be available for api operations
|
|
@@ -60896,7 +61384,7 @@ class WorkforceManagementApi {
|
|
|
60896
61384
|
/**
|
|
60897
61385
|
* Query published schedules for given given time range for set of users
|
|
60898
61386
|
*
|
|
60899
|
-
* @param {String} managementUnitId The
|
|
61387
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
60900
61388
|
* @param {Object} opts Optional parameters
|
|
60901
61389
|
* @param {Object} opts.body body
|
|
60902
61390
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
@@ -60927,7 +61415,7 @@ class WorkforceManagementApi {
|
|
|
60927
61415
|
/**
|
|
60928
61416
|
* Request a historical adherence report
|
|
60929
61417
|
* The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
|
|
60930
|
-
* @param {String} managementUnitId The
|
|
61418
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
60931
61419
|
* @param {Object} opts Optional parameters
|
|
60932
61420
|
* @param {Object} opts.body body
|
|
60933
61421
|
*/
|
|
@@ -60985,7 +61473,7 @@ class WorkforceManagementApi {
|
|
|
60985
61473
|
/**
|
|
60986
61474
|
* Query published schedules for given given time range for set of users
|
|
60987
61475
|
*
|
|
60988
|
-
* @param {String} managementUnitId The
|
|
61476
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
60989
61477
|
* @param {Object} opts Optional parameters
|
|
60990
61478
|
* @param {Object} opts.body body
|
|
60991
61479
|
*/
|
|
@@ -61014,7 +61502,7 @@ class WorkforceManagementApi {
|
|
|
61014
61502
|
/**
|
|
61015
61503
|
* Creates a new time off limit object under management unit.
|
|
61016
61504
|
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
61017
|
-
* @param {String} managementUnitId The
|
|
61505
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
61018
61506
|
* @param {Object} opts Optional parameters
|
|
61019
61507
|
* @param {Object} opts.body body
|
|
61020
61508
|
*/
|
|
@@ -61043,7 +61531,7 @@ class WorkforceManagementApi {
|
|
|
61043
61531
|
/**
|
|
61044
61532
|
* Retrieves time off limit related values based on a given set of filters.
|
|
61045
61533
|
*
|
|
61046
|
-
* @param {String} managementUnitId The
|
|
61534
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
61047
61535
|
* @param {Object} opts Optional parameters
|
|
61048
61536
|
* @param {Object} opts.body body
|
|
61049
61537
|
*/
|
|
@@ -61072,7 +61560,7 @@ class WorkforceManagementApi {
|
|
|
61072
61560
|
/**
|
|
61073
61561
|
* Creates a new time off plan
|
|
61074
61562
|
*
|
|
61075
|
-
* @param {String} managementUnitId The management unit
|
|
61563
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
61076
61564
|
* @param {Object} opts Optional parameters
|
|
61077
61565
|
* @param {Object} opts.body body
|
|
61078
61566
|
*/
|
|
@@ -61101,7 +61589,7 @@ class WorkforceManagementApi {
|
|
|
61101
61589
|
/**
|
|
61102
61590
|
* Create a new time off request
|
|
61103
61591
|
*
|
|
61104
|
-
* @param {String} managementUnitId The
|
|
61592
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
61105
61593
|
* @param {Object} opts Optional parameters
|
|
61106
61594
|
* @param {Object} opts.body body
|
|
61107
61595
|
*/
|
|
@@ -61130,7 +61618,7 @@ class WorkforceManagementApi {
|
|
|
61130
61618
|
/**
|
|
61131
61619
|
* Fetches time off requests matching the conditions specified in the request body
|
|
61132
61620
|
* 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
|
|
61133
|
-
* @param {String} managementUnitId The
|
|
61621
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
61134
61622
|
* @param {Object} opts Optional parameters
|
|
61135
61623
|
* @param {Object} opts.body body
|
|
61136
61624
|
*/
|
|
@@ -61159,7 +61647,7 @@ class WorkforceManagementApi {
|
|
|
61159
61647
|
/**
|
|
61160
61648
|
* Retrieves daily waitlist position for a list of time off requests
|
|
61161
61649
|
*
|
|
61162
|
-
* @param {String} managementUnitId The
|
|
61650
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
61163
61651
|
* @param {Object} opts Optional parameters
|
|
61164
61652
|
* @param {Object} opts.body body
|
|
61165
61653
|
*/
|
|
@@ -61188,7 +61676,7 @@ class WorkforceManagementApi {
|
|
|
61188
61676
|
/**
|
|
61189
61677
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
61190
61678
|
*
|
|
61191
|
-
* @param {String} managementUnitId The
|
|
61679
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
61192
61680
|
* @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
|
|
61193
61681
|
* @param {Object} body body
|
|
61194
61682
|
* @param {String} tradeId The ID of the shift trade to update
|
|
@@ -61228,7 +61716,7 @@ class WorkforceManagementApi {
|
|
|
61228
61716
|
/**
|
|
61229
61717
|
* Adds a shift trade
|
|
61230
61718
|
*
|
|
61231
|
-
* @param {String} managementUnitId The
|
|
61719
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
61232
61720
|
* @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
|
|
61233
61721
|
* @param {Object} body body
|
|
61234
61722
|
*/
|
|
@@ -61263,7 +61751,7 @@ class WorkforceManagementApi {
|
|
|
61263
61751
|
/**
|
|
61264
61752
|
* Searches for potential shift trade matches for the current agent
|
|
61265
61753
|
*
|
|
61266
|
-
* @param {String} managementUnitId The
|
|
61754
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
61267
61755
|
* @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
|
|
61268
61756
|
* @param {Object} body body
|
|
61269
61757
|
*/
|
|
@@ -61298,7 +61786,7 @@ class WorkforceManagementApi {
|
|
|
61298
61786
|
/**
|
|
61299
61787
|
* Updates the state of a batch of shift trades
|
|
61300
61788
|
* Admin functionality is not supported with \"mine\".
|
|
61301
|
-
* @param {String} managementUnitId The
|
|
61789
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
61302
61790
|
* @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
|
|
61303
61791
|
* @param {Object} body body
|
|
61304
61792
|
* @param {Object} opts Optional parameters
|
|
@@ -61619,7 +62107,7 @@ class WorkforceManagementApi {
|
|
|
61619
62107
|
/**
|
|
61620
62108
|
* Sets daily values for a date range of time off limit object
|
|
61621
62109
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
61622
|
-
* @param {String} managementUnitId The
|
|
62110
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
61623
62111
|
* @param {String} timeOffLimitId The ID of the time off limit object to set values for
|
|
61624
62112
|
* @param {Object} opts Optional parameters
|
|
61625
62113
|
* @param {Object} opts.body body
|
|
@@ -61681,7 +62169,7 @@ class WorkforceManagementApi {
|
|
|
61681
62169
|
* </pre>
|
|
61682
62170
|
* </p>
|
|
61683
62171
|
* @module purecloud-platform-client-v2/index
|
|
61684
|
-
* @version
|
|
62172
|
+
* @version 135.0.0
|
|
61685
62173
|
*/
|
|
61686
62174
|
class platformClient {
|
|
61687
62175
|
constructor() {
|