purecloud-platform-client-v2 134.0.1 → 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 +215 -172
- package/dist/web-amd/purecloud-platform-client-v2.js +215 -172
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +215 -172
- package/dist/web-cjs/purecloud-platform-client-v2.js +215 -172
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +395 -207
- 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 +3 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +26 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -51
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +5 -3
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -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 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +51 -51
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -2265,7 +2265,7 @@ class Configuration {
|
|
|
2265
2265
|
|
|
2266
2266
|
/**
|
|
2267
2267
|
* @module purecloud-platform-client-v2/ApiClient
|
|
2268
|
-
* @version
|
|
2268
|
+
* @version 135.0.0
|
|
2269
2269
|
*/
|
|
2270
2270
|
class ApiClient {
|
|
2271
2271
|
/**
|
|
@@ -3205,7 +3205,7 @@ class ApiClient {
|
|
|
3205
3205
|
|
|
3206
3206
|
// set header parameters
|
|
3207
3207
|
request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
|
|
3208
|
-
//request.set({ 'purecloud-sdk': '
|
|
3208
|
+
//request.set({ 'purecloud-sdk': '135.0.0' });
|
|
3209
3209
|
|
|
3210
3210
|
// set request timeout
|
|
3211
3211
|
request.timeout(that.timeout);
|
|
@@ -3305,7 +3305,7 @@ class AlertingApi {
|
|
|
3305
3305
|
/**
|
|
3306
3306
|
* Alerting service.
|
|
3307
3307
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3308
|
-
* @version
|
|
3308
|
+
* @version 135.0.0
|
|
3309
3309
|
*/
|
|
3310
3310
|
|
|
3311
3311
|
/**
|
|
@@ -3619,7 +3619,7 @@ class AnalyticsApi {
|
|
|
3619
3619
|
/**
|
|
3620
3620
|
* Analytics service.
|
|
3621
3621
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3622
|
-
* @version
|
|
3622
|
+
* @version 135.0.0
|
|
3623
3623
|
*/
|
|
3624
3624
|
|
|
3625
3625
|
/**
|
|
@@ -4801,7 +4801,7 @@ class ArchitectApi {
|
|
|
4801
4801
|
/**
|
|
4802
4802
|
* Architect service.
|
|
4803
4803
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4804
|
-
* @version
|
|
4804
|
+
* @version 135.0.0
|
|
4805
4805
|
*/
|
|
4806
4806
|
|
|
4807
4807
|
/**
|
|
@@ -7797,7 +7797,7 @@ class AuditApi {
|
|
|
7797
7797
|
/**
|
|
7798
7798
|
* Audit service.
|
|
7799
7799
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
7800
|
-
* @version
|
|
7800
|
+
* @version 135.0.0
|
|
7801
7801
|
*/
|
|
7802
7802
|
|
|
7803
7803
|
/**
|
|
@@ -7968,7 +7968,7 @@ class AuthorizationApi {
|
|
|
7968
7968
|
/**
|
|
7969
7969
|
* Authorization service.
|
|
7970
7970
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
7971
|
-
* @version
|
|
7971
|
+
* @version 135.0.0
|
|
7972
7972
|
*/
|
|
7973
7973
|
|
|
7974
7974
|
/**
|
|
@@ -9151,7 +9151,7 @@ class BillingApi {
|
|
|
9151
9151
|
/**
|
|
9152
9152
|
* Billing service.
|
|
9153
9153
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9154
|
-
* @version
|
|
9154
|
+
* @version 135.0.0
|
|
9155
9155
|
*/
|
|
9156
9156
|
|
|
9157
9157
|
/**
|
|
@@ -9231,7 +9231,7 @@ class ChatApi {
|
|
|
9231
9231
|
/**
|
|
9232
9232
|
* Chat service.
|
|
9233
9233
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
9234
|
-
* @version
|
|
9234
|
+
* @version 135.0.0
|
|
9235
9235
|
*/
|
|
9236
9236
|
|
|
9237
9237
|
/**
|
|
@@ -9322,7 +9322,7 @@ class CoachingApi {
|
|
|
9322
9322
|
/**
|
|
9323
9323
|
* Coaching service.
|
|
9324
9324
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9325
|
-
* @version
|
|
9325
|
+
* @version 135.0.0
|
|
9326
9326
|
*/
|
|
9327
9327
|
|
|
9328
9328
|
/**
|
|
@@ -9899,7 +9899,7 @@ class ContentManagementApi {
|
|
|
9899
9899
|
/**
|
|
9900
9900
|
* ContentManagement service.
|
|
9901
9901
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
9902
|
-
* @version
|
|
9902
|
+
* @version 135.0.0
|
|
9903
9903
|
*/
|
|
9904
9904
|
|
|
9905
9905
|
/**
|
|
@@ -11039,7 +11039,7 @@ class ConversationsApi {
|
|
|
11039
11039
|
/**
|
|
11040
11040
|
* Conversations service.
|
|
11041
11041
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
11042
|
-
* @version
|
|
11042
|
+
* @version 135.0.0
|
|
11043
11043
|
*/
|
|
11044
11044
|
|
|
11045
11045
|
/**
|
|
@@ -12944,7 +12944,7 @@ class ConversationsApi {
|
|
|
12944
12944
|
/**
|
|
12945
12945
|
* Get a list of Messaging Stickers
|
|
12946
12946
|
*
|
|
12947
|
-
* @param {
|
|
12947
|
+
* @param {Object} messengerType Messenger Type
|
|
12948
12948
|
* @param {Object} opts Optional parameters
|
|
12949
12949
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
12950
12950
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
@@ -13132,7 +13132,7 @@ class ConversationsApi {
|
|
|
13132
13132
|
}
|
|
13133
13133
|
|
|
13134
13134
|
/**
|
|
13135
|
-
* Update a conversation by setting
|
|
13135
|
+
* Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
13136
13136
|
*
|
|
13137
13137
|
* @param {String} conversationId conversationId
|
|
13138
13138
|
* @param {Object} body Conversation
|
|
@@ -15703,7 +15703,7 @@ class DataExtensionsApi {
|
|
|
15703
15703
|
/**
|
|
15704
15704
|
* DataExtensions service.
|
|
15705
15705
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
15706
|
-
* @version
|
|
15706
|
+
* @version 135.0.0
|
|
15707
15707
|
*/
|
|
15708
15708
|
|
|
15709
15709
|
/**
|
|
@@ -15789,7 +15789,7 @@ class ExternalContactsApi {
|
|
|
15789
15789
|
/**
|
|
15790
15790
|
* ExternalContacts service.
|
|
15791
15791
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
15792
|
-
* @version
|
|
15792
|
+
* @version 135.0.0
|
|
15793
15793
|
*/
|
|
15794
15794
|
|
|
15795
15795
|
/**
|
|
@@ -17532,7 +17532,7 @@ class FaxApi {
|
|
|
17532
17532
|
/**
|
|
17533
17533
|
* Fax service.
|
|
17534
17534
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
17535
|
-
* @version
|
|
17535
|
+
* @version 135.0.0
|
|
17536
17536
|
*/
|
|
17537
17537
|
|
|
17538
17538
|
/**
|
|
@@ -17703,7 +17703,7 @@ class FlowsApi {
|
|
|
17703
17703
|
/**
|
|
17704
17704
|
* Flows service.
|
|
17705
17705
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
17706
|
-
* @version
|
|
17706
|
+
* @version 135.0.0
|
|
17707
17707
|
*/
|
|
17708
17708
|
|
|
17709
17709
|
/**
|
|
@@ -17774,7 +17774,7 @@ class GamificationApi {
|
|
|
17774
17774
|
/**
|
|
17775
17775
|
* Gamification service.
|
|
17776
17776
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
17777
|
-
* @version
|
|
17777
|
+
* @version 135.0.0
|
|
17778
17778
|
*/
|
|
17779
17779
|
|
|
17780
17780
|
/**
|
|
@@ -19204,7 +19204,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
19204
19204
|
/**
|
|
19205
19205
|
* GeneralDataProtectionRegulation service.
|
|
19206
19206
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
19207
|
-
* @version
|
|
19207
|
+
* @version 135.0.0
|
|
19208
19208
|
*/
|
|
19209
19209
|
|
|
19210
19210
|
/**
|
|
@@ -19334,7 +19334,7 @@ class GeolocationApi {
|
|
|
19334
19334
|
/**
|
|
19335
19335
|
* Geolocation service.
|
|
19336
19336
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
19337
|
-
* @version
|
|
19337
|
+
* @version 135.0.0
|
|
19338
19338
|
*/
|
|
19339
19339
|
|
|
19340
19340
|
/**
|
|
@@ -19465,7 +19465,7 @@ class GreetingsApi {
|
|
|
19465
19465
|
/**
|
|
19466
19466
|
* Greetings service.
|
|
19467
19467
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
19468
|
-
* @version
|
|
19468
|
+
* @version 135.0.0
|
|
19469
19469
|
*/
|
|
19470
19470
|
|
|
19471
19471
|
/**
|
|
@@ -19920,7 +19920,7 @@ class GroupsApi {
|
|
|
19920
19920
|
/**
|
|
19921
19921
|
* Groups service.
|
|
19922
19922
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
19923
|
-
* @version
|
|
19923
|
+
* @version 135.0.0
|
|
19924
19924
|
*/
|
|
19925
19925
|
|
|
19926
19926
|
/**
|
|
@@ -20325,7 +20325,7 @@ class IdentityProviderApi {
|
|
|
20325
20325
|
/**
|
|
20326
20326
|
* IdentityProvider service.
|
|
20327
20327
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
20328
|
-
* @version
|
|
20328
|
+
* @version 135.0.0
|
|
20329
20329
|
*/
|
|
20330
20330
|
|
|
20331
20331
|
/**
|
|
@@ -21081,7 +21081,7 @@ class IntegrationsApi {
|
|
|
21081
21081
|
/**
|
|
21082
21082
|
* Integrations service.
|
|
21083
21083
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
21084
|
-
* @version
|
|
21084
|
+
* @version 135.0.0
|
|
21085
21085
|
*/
|
|
21086
21086
|
|
|
21087
21087
|
/**
|
|
@@ -22756,7 +22756,7 @@ class JourneyApi {
|
|
|
22756
22756
|
/**
|
|
22757
22757
|
* Journey service.
|
|
22758
22758
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
22759
|
-
* @version
|
|
22759
|
+
* @version 135.0.0
|
|
22760
22760
|
*/
|
|
22761
22761
|
|
|
22762
22762
|
/**
|
|
@@ -23467,7 +23467,7 @@ class KnowledgeApi {
|
|
|
23467
23467
|
/**
|
|
23468
23468
|
* Knowledge service.
|
|
23469
23469
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
23470
|
-
* @version
|
|
23470
|
+
* @version 135.0.0
|
|
23471
23471
|
*/
|
|
23472
23472
|
|
|
23473
23473
|
/**
|
|
@@ -24367,7 +24367,7 @@ class LanguageUnderstandingApi {
|
|
|
24367
24367
|
/**
|
|
24368
24368
|
* LanguageUnderstanding service.
|
|
24369
24369
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
24370
|
-
* @version
|
|
24370
|
+
* @version 135.0.0
|
|
24371
24371
|
*/
|
|
24372
24372
|
|
|
24373
24373
|
/**
|
|
@@ -25271,7 +25271,7 @@ class LanguagesApi {
|
|
|
25271
25271
|
/**
|
|
25272
25272
|
* Languages service.
|
|
25273
25273
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
25274
|
-
* @version
|
|
25274
|
+
* @version 135.0.0
|
|
25275
25275
|
*/
|
|
25276
25276
|
|
|
25277
25277
|
/**
|
|
@@ -25539,7 +25539,7 @@ class LearningApi {
|
|
|
25539
25539
|
/**
|
|
25540
25540
|
* Learning service.
|
|
25541
25541
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
25542
|
-
* @version
|
|
25542
|
+
* @version 135.0.0
|
|
25543
25543
|
*/
|
|
25544
25544
|
|
|
25545
25545
|
/**
|
|
@@ -26130,7 +26130,7 @@ class LicenseApi {
|
|
|
26130
26130
|
/**
|
|
26131
26131
|
* License service.
|
|
26132
26132
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
26133
|
-
* @version
|
|
26133
|
+
* @version 135.0.0
|
|
26134
26134
|
*/
|
|
26135
26135
|
|
|
26136
26136
|
/**
|
|
@@ -26368,7 +26368,7 @@ class LocationsApi {
|
|
|
26368
26368
|
/**
|
|
26369
26369
|
* Locations service.
|
|
26370
26370
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
26371
|
-
* @version
|
|
26371
|
+
* @version 135.0.0
|
|
26372
26372
|
*/
|
|
26373
26373
|
|
|
26374
26374
|
/**
|
|
@@ -26604,7 +26604,7 @@ class MessagingApi {
|
|
|
26604
26604
|
/**
|
|
26605
26605
|
* Messaging service.
|
|
26606
26606
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
26607
|
-
* @version
|
|
26607
|
+
* @version 135.0.0
|
|
26608
26608
|
*/
|
|
26609
26609
|
|
|
26610
26610
|
/**
|
|
@@ -26755,7 +26755,7 @@ class MobileDevicesApi {
|
|
|
26755
26755
|
/**
|
|
26756
26756
|
* MobileDevices service.
|
|
26757
26757
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
26758
|
-
* @version
|
|
26758
|
+
* @version 135.0.0
|
|
26759
26759
|
*/
|
|
26760
26760
|
|
|
26761
26761
|
/**
|
|
@@ -26906,7 +26906,7 @@ class NotificationsApi {
|
|
|
26906
26906
|
/**
|
|
26907
26907
|
* Notifications service.
|
|
26908
26908
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
26909
|
-
* @version
|
|
26909
|
+
* @version 135.0.0
|
|
26910
26910
|
*/
|
|
26911
26911
|
|
|
26912
26912
|
/**
|
|
@@ -27131,7 +27131,7 @@ class OAuthApi {
|
|
|
27131
27131
|
/**
|
|
27132
27132
|
* OAuth service.
|
|
27133
27133
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
27134
|
-
* @version
|
|
27134
|
+
* @version 135.0.0
|
|
27135
27135
|
*/
|
|
27136
27136
|
|
|
27137
27137
|
/**
|
|
@@ -27497,7 +27497,7 @@ class ObjectsApi {
|
|
|
27497
27497
|
/**
|
|
27498
27498
|
* Objects service.
|
|
27499
27499
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
27500
|
-
* @version
|
|
27500
|
+
* @version 135.0.0
|
|
27501
27501
|
*/
|
|
27502
27502
|
|
|
27503
27503
|
/**
|
|
@@ -27768,7 +27768,7 @@ class OrganizationApi {
|
|
|
27768
27768
|
/**
|
|
27769
27769
|
* Organization service.
|
|
27770
27770
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
27771
|
-
* @version
|
|
27771
|
+
* @version 135.0.0
|
|
27772
27772
|
*/
|
|
27773
27773
|
|
|
27774
27774
|
/**
|
|
@@ -28171,7 +28171,7 @@ class OrganizationAuthorizationApi {
|
|
|
28171
28171
|
/**
|
|
28172
28172
|
* OrganizationAuthorization service.
|
|
28173
28173
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
28174
|
-
* @version
|
|
28174
|
+
* @version 135.0.0
|
|
28175
28175
|
*/
|
|
28176
28176
|
|
|
28177
28177
|
/**
|
|
@@ -29096,7 +29096,7 @@ class OutboundApi {
|
|
|
29096
29096
|
/**
|
|
29097
29097
|
* Outbound service.
|
|
29098
29098
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
29099
|
-
* @version
|
|
29099
|
+
* @version 135.0.0
|
|
29100
29100
|
*/
|
|
29101
29101
|
|
|
29102
29102
|
/**
|
|
@@ -29446,6 +29446,31 @@ class OutboundApi {
|
|
|
29446
29446
|
);
|
|
29447
29447
|
}
|
|
29448
29448
|
|
|
29449
|
+
/**
|
|
29450
|
+
* Reset messaging campaign progress and recycle the messaging campaign
|
|
29451
|
+
*
|
|
29452
|
+
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
29453
|
+
*/
|
|
29454
|
+
deleteOutboundMessagingcampaignProgress(messagingCampaignId) {
|
|
29455
|
+
// verify the required parameter 'messagingCampaignId' is set
|
|
29456
|
+
if (messagingCampaignId === undefined || messagingCampaignId === null) {
|
|
29457
|
+
throw 'Missing the required parameter "messagingCampaignId" when calling deleteOutboundMessagingcampaignProgress';
|
|
29458
|
+
}
|
|
29459
|
+
|
|
29460
|
+
return this.apiClient.callApi(
|
|
29461
|
+
'/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress',
|
|
29462
|
+
'DELETE',
|
|
29463
|
+
{ 'messagingCampaignId': messagingCampaignId },
|
|
29464
|
+
{ },
|
|
29465
|
+
{ },
|
|
29466
|
+
{ },
|
|
29467
|
+
null,
|
|
29468
|
+
['PureCloud OAuth'],
|
|
29469
|
+
['application/json'],
|
|
29470
|
+
['application/json']
|
|
29471
|
+
);
|
|
29472
|
+
}
|
|
29473
|
+
|
|
29449
29474
|
/**
|
|
29450
29475
|
* Delete a Rule Set.
|
|
29451
29476
|
*
|
|
@@ -32126,7 +32151,7 @@ class PresenceApi {
|
|
|
32126
32151
|
/**
|
|
32127
32152
|
* Presence service.
|
|
32128
32153
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
32129
|
-
* @version
|
|
32154
|
+
* @version 135.0.0
|
|
32130
32155
|
*/
|
|
32131
32156
|
|
|
32132
32157
|
/**
|
|
@@ -32272,31 +32297,6 @@ class PresenceApi {
|
|
|
32272
32297
|
);
|
|
32273
32298
|
}
|
|
32274
32299
|
|
|
32275
|
-
/**
|
|
32276
|
-
* Get a user's Microsoft Teams presence.
|
|
32277
|
-
* Gets the presence for a Microsoft Teams user. This will return the Microsoft Teams presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.
|
|
32278
|
-
* @param {String} userId user Id
|
|
32279
|
-
*/
|
|
32280
|
-
getUserPresencesMicrosoftteams(userId) {
|
|
32281
|
-
// verify the required parameter 'userId' is set
|
|
32282
|
-
if (userId === undefined || userId === null) {
|
|
32283
|
-
throw 'Missing the required parameter "userId" when calling getUserPresencesMicrosoftteams';
|
|
32284
|
-
}
|
|
32285
|
-
|
|
32286
|
-
return this.apiClient.callApi(
|
|
32287
|
-
'/api/v2/users/{userId}/presences/microsoftteams',
|
|
32288
|
-
'GET',
|
|
32289
|
-
{ 'userId': userId },
|
|
32290
|
-
{ },
|
|
32291
|
-
{ },
|
|
32292
|
-
{ },
|
|
32293
|
-
null,
|
|
32294
|
-
['PureCloud OAuth'],
|
|
32295
|
-
['application/json'],
|
|
32296
|
-
['application/json']
|
|
32297
|
-
);
|
|
32298
|
-
}
|
|
32299
|
-
|
|
32300
32300
|
/**
|
|
32301
32301
|
* Get a user's Genesys Cloud presence.
|
|
32302
32302
|
* Get the default Genesys Cloud user presence source PURECLOUD
|
|
@@ -32322,31 +32322,6 @@ class PresenceApi {
|
|
|
32322
32322
|
);
|
|
32323
32323
|
}
|
|
32324
32324
|
|
|
32325
|
-
/**
|
|
32326
|
-
* Get a user's Zoom Phone presence.
|
|
32327
|
-
* Gets the presence for a Zoom user. This will return the Zoom Phone presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.
|
|
32328
|
-
* @param {String} userId user Id
|
|
32329
|
-
*/
|
|
32330
|
-
getUserPresencesZoomphone(userId) {
|
|
32331
|
-
// verify the required parameter 'userId' is set
|
|
32332
|
-
if (userId === undefined || userId === null) {
|
|
32333
|
-
throw 'Missing the required parameter "userId" when calling getUserPresencesZoomphone';
|
|
32334
|
-
}
|
|
32335
|
-
|
|
32336
|
-
return this.apiClient.callApi(
|
|
32337
|
-
'/api/v2/users/{userId}/presences/zoomphone',
|
|
32338
|
-
'GET',
|
|
32339
|
-
{ 'userId': userId },
|
|
32340
|
-
{ },
|
|
32341
|
-
{ },
|
|
32342
|
-
{ },
|
|
32343
|
-
null,
|
|
32344
|
-
['PureCloud OAuth'],
|
|
32345
|
-
['application/json'],
|
|
32346
|
-
['application/json']
|
|
32347
|
-
);
|
|
32348
|
-
}
|
|
32349
|
-
|
|
32350
32325
|
/**
|
|
32351
32326
|
* Patch a user's Presence
|
|
32352
32327
|
* Patch a user's presence for the specified source that is not specifically listed. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
|
|
@@ -32498,7 +32473,7 @@ class QualityApi {
|
|
|
32498
32473
|
/**
|
|
32499
32474
|
* Quality service.
|
|
32500
32475
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
32501
|
-
* @version
|
|
32476
|
+
* @version 135.0.0
|
|
32502
32477
|
*/
|
|
32503
32478
|
|
|
32504
32479
|
/**
|
|
@@ -34076,7 +34051,7 @@ class RecordingApi {
|
|
|
34076
34051
|
/**
|
|
34077
34052
|
* Recording service.
|
|
34078
34053
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
34079
|
-
* @version
|
|
34054
|
+
* @version 135.0.0
|
|
34080
34055
|
*/
|
|
34081
34056
|
|
|
34082
34057
|
/**
|
|
@@ -34599,6 +34574,7 @@ class RecordingApi {
|
|
|
34599
34574
|
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
34600
34575
|
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
34601
34576
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
34577
|
+
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
34602
34578
|
*/
|
|
34603
34579
|
getRecordingCrossplatformMediaretentionpolicies(opts) {
|
|
34604
34580
|
opts = opts || {};
|
|
@@ -34608,7 +34584,7 @@ class RecordingApi {
|
|
|
34608
34584
|
'/api/v2/recording/crossplatform/mediaretentionpolicies',
|
|
34609
34585
|
'GET',
|
|
34610
34586
|
{ },
|
|
34611
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'] },
|
|
34587
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'],'deleteDaysThreshold': opts['deleteDaysThreshold'] },
|
|
34612
34588
|
{ },
|
|
34613
34589
|
{ },
|
|
34614
34590
|
null,
|
|
@@ -34790,6 +34766,7 @@ class RecordingApi {
|
|
|
34790
34766
|
* @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
|
|
34791
34767
|
* @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
|
|
34792
34768
|
* @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
|
|
34769
|
+
* @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
|
|
34793
34770
|
*/
|
|
34794
34771
|
getRecordingMediaretentionpolicies(opts) {
|
|
34795
34772
|
opts = opts || {};
|
|
@@ -34799,7 +34776,7 @@ class RecordingApi {
|
|
|
34799
34776
|
'/api/v2/recording/mediaretentionpolicies',
|
|
34800
34777
|
'GET',
|
|
34801
34778
|
{ },
|
|
34802
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'] },
|
|
34779
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'],'deleteDaysThreshold': opts['deleteDaysThreshold'] },
|
|
34803
34780
|
{ },
|
|
34804
34781
|
{ },
|
|
34805
34782
|
null,
|
|
@@ -35602,7 +35579,7 @@ class ResponseManagementApi {
|
|
|
35602
35579
|
/**
|
|
35603
35580
|
* ResponseManagement service.
|
|
35604
35581
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
35605
|
-
* @version
|
|
35582
|
+
* @version 135.0.0
|
|
35606
35583
|
*/
|
|
35607
35584
|
|
|
35608
35585
|
/**
|
|
@@ -36086,7 +36063,7 @@ class RoutingApi {
|
|
|
36086
36063
|
/**
|
|
36087
36064
|
* Routing service.
|
|
36088
36065
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
36089
|
-
* @version
|
|
36066
|
+
* @version 135.0.0
|
|
36090
36067
|
*/
|
|
36091
36068
|
|
|
36092
36069
|
/**
|
|
@@ -39009,7 +38986,7 @@ class SCIMApi {
|
|
|
39009
38986
|
/**
|
|
39010
38987
|
* SCIM service.
|
|
39011
38988
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
39012
|
-
* @version
|
|
38989
|
+
* @version 135.0.0
|
|
39013
38990
|
*/
|
|
39014
38991
|
|
|
39015
38992
|
/**
|
|
@@ -39886,7 +39863,7 @@ class ScriptsApi {
|
|
|
39886
39863
|
/**
|
|
39887
39864
|
* Scripts service.
|
|
39888
39865
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
39889
|
-
* @version
|
|
39866
|
+
* @version 135.0.0
|
|
39890
39867
|
*/
|
|
39891
39868
|
|
|
39892
39869
|
/**
|
|
@@ -40002,6 +39979,7 @@ class ScriptsApi {
|
|
|
40002
39979
|
* @param {Object} opts.sortBy SortBy
|
|
40003
39980
|
* @param {Object} opts.sortOrder SortOrder
|
|
40004
39981
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
39982
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
40005
39983
|
*/
|
|
40006
39984
|
getScripts(opts) {
|
|
40007
39985
|
opts = opts || {};
|
|
@@ -40011,7 +39989,40 @@ class ScriptsApi {
|
|
|
40011
39989
|
'/api/v2/scripts',
|
|
40012
39990
|
'GET',
|
|
40013
39991
|
{ },
|
|
40014
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'scriptDataVersion': opts['scriptDataVersion'] },
|
|
39992
|
+
{ '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'] },
|
|
39993
|
+
{ },
|
|
39994
|
+
{ },
|
|
39995
|
+
null,
|
|
39996
|
+
['PureCloud OAuth'],
|
|
39997
|
+
['application/json'],
|
|
39998
|
+
['application/json']
|
|
39999
|
+
);
|
|
40000
|
+
}
|
|
40001
|
+
|
|
40002
|
+
/**
|
|
40003
|
+
* Get the metadata for a list of scripts
|
|
40004
|
+
*
|
|
40005
|
+
* @param {Object} opts Optional parameters
|
|
40006
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
40007
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
40008
|
+
* @param {String} opts.expand Expand
|
|
40009
|
+
* @param {String} opts.name Name filter
|
|
40010
|
+
* @param {String} opts.feature Feature filter
|
|
40011
|
+
* @param {String} opts.flowId Secure flow id filter
|
|
40012
|
+
* @param {Object} opts.sortBy SortBy
|
|
40013
|
+
* @param {Object} opts.sortOrder SortOrder
|
|
40014
|
+
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
40015
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
40016
|
+
*/
|
|
40017
|
+
getScriptsDivisionviews(opts) {
|
|
40018
|
+
opts = opts || {};
|
|
40019
|
+
|
|
40020
|
+
|
|
40021
|
+
return this.apiClient.callApi(
|
|
40022
|
+
'/api/v2/scripts/divisionviews',
|
|
40023
|
+
'GET',
|
|
40024
|
+
{ },
|
|
40025
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
40015
40026
|
{ },
|
|
40016
40027
|
{ },
|
|
40017
40028
|
null,
|
|
@@ -40032,6 +40043,7 @@ class ScriptsApi {
|
|
|
40032
40043
|
* @param {String} opts.feature Feature filter
|
|
40033
40044
|
* @param {String} opts.flowId Secure flow id filter
|
|
40034
40045
|
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
40046
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
40035
40047
|
*/
|
|
40036
40048
|
getScriptsPublished(opts) {
|
|
40037
40049
|
opts = opts || {};
|
|
@@ -40041,7 +40053,38 @@ class ScriptsApi {
|
|
|
40041
40053
|
'/api/v2/scripts/published',
|
|
40042
40054
|
'GET',
|
|
40043
40055
|
{ },
|
|
40044
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'] },
|
|
40056
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
40057
|
+
{ },
|
|
40058
|
+
{ },
|
|
40059
|
+
null,
|
|
40060
|
+
['PureCloud OAuth'],
|
|
40061
|
+
['application/json'],
|
|
40062
|
+
['application/json']
|
|
40063
|
+
);
|
|
40064
|
+
}
|
|
40065
|
+
|
|
40066
|
+
/**
|
|
40067
|
+
* Get the published scripts metadata.
|
|
40068
|
+
*
|
|
40069
|
+
* @param {Object} opts Optional parameters
|
|
40070
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
40071
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
40072
|
+
* @param {String} opts.expand Expand
|
|
40073
|
+
* @param {String} opts.name Name filter
|
|
40074
|
+
* @param {String} opts.feature Feature filter
|
|
40075
|
+
* @param {String} opts.flowId Secure flow id filter
|
|
40076
|
+
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
40077
|
+
* @param {String} opts.divisionIds Filters scripts to requested divisionIds
|
|
40078
|
+
*/
|
|
40079
|
+
getScriptsPublishedDivisionviews(opts) {
|
|
40080
|
+
opts = opts || {};
|
|
40081
|
+
|
|
40082
|
+
|
|
40083
|
+
return this.apiClient.callApi(
|
|
40084
|
+
'/api/v2/scripts/published/divisionviews',
|
|
40085
|
+
'GET',
|
|
40086
|
+
{ },
|
|
40087
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
|
|
40045
40088
|
{ },
|
|
40046
40089
|
{ },
|
|
40047
40090
|
null,
|
|
@@ -40239,7 +40282,7 @@ class SearchApi {
|
|
|
40239
40282
|
/**
|
|
40240
40283
|
* Search service.
|
|
40241
40284
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
40242
|
-
* @version
|
|
40285
|
+
* @version 135.0.0
|
|
40243
40286
|
*/
|
|
40244
40287
|
|
|
40245
40288
|
/**
|
|
@@ -40774,7 +40817,7 @@ class SpeechTextAnalyticsApi {
|
|
|
40774
40817
|
/**
|
|
40775
40818
|
* SpeechTextAnalytics service.
|
|
40776
40819
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
40777
|
-
* @version
|
|
40820
|
+
* @version 135.0.0
|
|
40778
40821
|
*/
|
|
40779
40822
|
|
|
40780
40823
|
/**
|
|
@@ -41627,7 +41670,7 @@ class StationsApi {
|
|
|
41627
41670
|
/**
|
|
41628
41671
|
* Stations service.
|
|
41629
41672
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
41630
|
-
* @version
|
|
41673
|
+
* @version 135.0.0
|
|
41631
41674
|
*/
|
|
41632
41675
|
|
|
41633
41676
|
/**
|
|
@@ -41774,7 +41817,7 @@ class SuggestApi {
|
|
|
41774
41817
|
/**
|
|
41775
41818
|
* Suggest service.
|
|
41776
41819
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
41777
|
-
* @version
|
|
41820
|
+
* @version 135.0.0
|
|
41778
41821
|
*/
|
|
41779
41822
|
|
|
41780
41823
|
/**
|
|
@@ -41913,7 +41956,7 @@ class TelephonyApi {
|
|
|
41913
41956
|
/**
|
|
41914
41957
|
* Telephony service.
|
|
41915
41958
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
41916
|
-
* @version
|
|
41959
|
+
* @version 135.0.0
|
|
41917
41960
|
*/
|
|
41918
41961
|
|
|
41919
41962
|
/**
|
|
@@ -42021,7 +42064,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
42021
42064
|
/**
|
|
42022
42065
|
* TelephonyProvidersEdge service.
|
|
42023
42066
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
42024
|
-
* @version
|
|
42067
|
+
* @version 135.0.0
|
|
42025
42068
|
*/
|
|
42026
42069
|
|
|
42027
42070
|
/**
|
|
@@ -43436,7 +43479,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
43436
43479
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
43437
43480
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
43438
43481
|
* @param {String} opts.sortBy Sort by
|
|
43439
|
-
* @param {String} opts._number
|
|
43482
|
+
* @param {String} opts._number Deprecated, filtering by number not supported
|
|
43440
43483
|
*/
|
|
43441
43484
|
getTelephonyProvidersEdgesExtensionpools(opts) {
|
|
43442
43485
|
opts = opts || {};
|
|
@@ -45654,7 +45697,7 @@ class TextbotsApi {
|
|
|
45654
45697
|
/**
|
|
45655
45698
|
* Textbots service.
|
|
45656
45699
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
45657
|
-
* @version
|
|
45700
|
+
* @version 135.0.0
|
|
45658
45701
|
*/
|
|
45659
45702
|
|
|
45660
45703
|
/**
|
|
@@ -45782,7 +45825,7 @@ class TokensApi {
|
|
|
45782
45825
|
/**
|
|
45783
45826
|
* Tokens service.
|
|
45784
45827
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
45785
|
-
* @version
|
|
45828
|
+
* @version 135.0.0
|
|
45786
45829
|
*/
|
|
45787
45830
|
|
|
45788
45831
|
/**
|
|
@@ -45888,7 +45931,7 @@ class UploadsApi {
|
|
|
45888
45931
|
/**
|
|
45889
45932
|
* Uploads service.
|
|
45890
45933
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
45891
|
-
* @version
|
|
45934
|
+
* @version 135.0.0
|
|
45892
45935
|
*/
|
|
45893
45936
|
|
|
45894
45937
|
/**
|
|
@@ -46039,7 +46082,7 @@ class UsageApi {
|
|
|
46039
46082
|
/**
|
|
46040
46083
|
* Usage service.
|
|
46041
46084
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
46042
|
-
* @version
|
|
46085
|
+
* @version 135.0.0
|
|
46043
46086
|
*/
|
|
46044
46087
|
|
|
46045
46088
|
/**
|
|
@@ -46110,7 +46153,7 @@ class UserRecordingsApi {
|
|
|
46110
46153
|
/**
|
|
46111
46154
|
* UserRecordings service.
|
|
46112
46155
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
46113
|
-
* @version
|
|
46156
|
+
* @version 135.0.0
|
|
46114
46157
|
*/
|
|
46115
46158
|
|
|
46116
46159
|
/**
|
|
@@ -46294,7 +46337,7 @@ class UsersApi {
|
|
|
46294
46337
|
/**
|
|
46295
46338
|
* Users service.
|
|
46296
46339
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
46297
|
-
* @version
|
|
46340
|
+
* @version 135.0.0
|
|
46298
46341
|
*/
|
|
46299
46342
|
|
|
46300
46343
|
/**
|
|
@@ -48596,7 +48639,7 @@ class UtilitiesApi {
|
|
|
48596
48639
|
/**
|
|
48597
48640
|
* Utilities service.
|
|
48598
48641
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
48599
|
-
* @version
|
|
48642
|
+
* @version 135.0.0
|
|
48600
48643
|
*/
|
|
48601
48644
|
|
|
48602
48645
|
/**
|
|
@@ -48707,7 +48750,7 @@ class VoicemailApi {
|
|
|
48707
48750
|
/**
|
|
48708
48751
|
* Voicemail service.
|
|
48709
48752
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
48710
|
-
* @version
|
|
48753
|
+
* @version 135.0.0
|
|
48711
48754
|
*/
|
|
48712
48755
|
|
|
48713
48756
|
/**
|
|
@@ -49374,7 +49417,7 @@ class WebChatApi {
|
|
|
49374
49417
|
/**
|
|
49375
49418
|
* WebChat service.
|
|
49376
49419
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
49377
|
-
* @version
|
|
49420
|
+
* @version 135.0.0
|
|
49378
49421
|
*/
|
|
49379
49422
|
|
|
49380
49423
|
/**
|
|
@@ -49918,7 +49961,7 @@ class WebDeploymentsApi {
|
|
|
49918
49961
|
/**
|
|
49919
49962
|
* WebDeployments service.
|
|
49920
49963
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
49921
|
-
* @version
|
|
49964
|
+
* @version 135.0.0
|
|
49922
49965
|
*/
|
|
49923
49966
|
|
|
49924
49967
|
/**
|
|
@@ -50273,7 +50316,7 @@ class WebMessagingApi {
|
|
|
50273
50316
|
/**
|
|
50274
50317
|
* WebMessaging service.
|
|
50275
50318
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
50276
|
-
* @version
|
|
50319
|
+
* @version 135.0.0
|
|
50277
50320
|
*/
|
|
50278
50321
|
|
|
50279
50322
|
/**
|
|
@@ -50319,7 +50362,7 @@ class WidgetsApi {
|
|
|
50319
50362
|
/**
|
|
50320
50363
|
* Widgets service.
|
|
50321
50364
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
50322
|
-
* @version
|
|
50365
|
+
* @version 135.0.0
|
|
50323
50366
|
*/
|
|
50324
50367
|
|
|
50325
50368
|
/**
|
|
@@ -50465,7 +50508,7 @@ class WorkforceManagementApi {
|
|
|
50465
50508
|
/**
|
|
50466
50509
|
* WorkforceManagement service.
|
|
50467
50510
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
50468
|
-
* @version
|
|
50511
|
+
* @version 135.0.0
|
|
50469
50512
|
*/
|
|
50470
50513
|
|
|
50471
50514
|
/**
|
|
@@ -50663,7 +50706,7 @@ class WorkforceManagementApi {
|
|
|
50663
50706
|
/**
|
|
50664
50707
|
* Delete a short term forecast
|
|
50665
50708
|
* Must not be tied to any schedules
|
|
50666
|
-
* @param {String} businessUnitId The
|
|
50709
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
50667
50710
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
50668
50711
|
* @param {String} forecastId The ID of the forecast
|
|
50669
50712
|
*/
|
|
@@ -50743,7 +50786,7 @@ class WorkforceManagementApi {
|
|
|
50743
50786
|
/**
|
|
50744
50787
|
* Deletes a time off limit object
|
|
50745
50788
|
*
|
|
50746
|
-
* @param {String} managementUnitId The
|
|
50789
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
50747
50790
|
* @param {String} timeOffLimitId The ID of the time off limit object to delete
|
|
50748
50791
|
*/
|
|
50749
50792
|
deleteWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
@@ -50773,7 +50816,7 @@ class WorkforceManagementApi {
|
|
|
50773
50816
|
/**
|
|
50774
50817
|
* Deletes a time off plan
|
|
50775
50818
|
*
|
|
50776
|
-
* @param {String} managementUnitId The management unit
|
|
50819
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
50777
50820
|
* @param {String} timeOffPlanId The ID of the time off plan to delete
|
|
50778
50821
|
*/
|
|
50779
50822
|
deleteWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
@@ -51042,7 +51085,7 @@ class WorkforceManagementApi {
|
|
|
51042
51085
|
/**
|
|
51043
51086
|
* Get intraday planning groups for the given date
|
|
51044
51087
|
*
|
|
51045
|
-
* @param {String} businessUnitId The
|
|
51088
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
51046
51089
|
* @param {String} _date yyyy-MM-dd date string interpreted in the configured business unit time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51047
51090
|
*/
|
|
51048
51091
|
getWorkforcemanagementBusinessunitIntradayPlanninggroups(businessUnitId, _date) {
|
|
@@ -51495,7 +51538,7 @@ class WorkforceManagementApi {
|
|
|
51495
51538
|
/**
|
|
51496
51539
|
* Get a short term forecast
|
|
51497
51540
|
*
|
|
51498
|
-
* @param {String} businessUnitId The
|
|
51541
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51499
51542
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51500
51543
|
* @param {String} forecastId The ID of the forecast
|
|
51501
51544
|
* @param {Object} opts Optional parameters
|
|
@@ -51534,7 +51577,7 @@ class WorkforceManagementApi {
|
|
|
51534
51577
|
/**
|
|
51535
51578
|
* Get the result of a short term forecast calculation
|
|
51536
51579
|
* Includes modifications unless you pass the doNotApplyModifications query parameter
|
|
51537
|
-
* @param {String} businessUnitId The
|
|
51580
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51538
51581
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51539
51582
|
* @param {String} forecastId The ID of the forecast
|
|
51540
51583
|
* @param {Object} opts Optional parameters
|
|
@@ -51574,7 +51617,7 @@ class WorkforceManagementApi {
|
|
|
51574
51617
|
/**
|
|
51575
51618
|
* Gets the forecast generation results
|
|
51576
51619
|
*
|
|
51577
|
-
* @param {String} businessUnitId The
|
|
51620
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51578
51621
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51579
51622
|
* @param {String} forecastId The ID of the forecast
|
|
51580
51623
|
*/
|
|
@@ -51609,7 +51652,7 @@ class WorkforceManagementApi {
|
|
|
51609
51652
|
/**
|
|
51610
51653
|
* Get the result of a long term forecast calculation
|
|
51611
51654
|
* Includes modifications unless you pass the doNotApplyModifications query parameter
|
|
51612
|
-
* @param {String} businessUnitId The
|
|
51655
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51613
51656
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51614
51657
|
* @param {String} forecastId The ID of the forecast
|
|
51615
51658
|
* @param {Object} opts Optional parameters
|
|
@@ -51648,7 +51691,7 @@ class WorkforceManagementApi {
|
|
|
51648
51691
|
/**
|
|
51649
51692
|
* Gets the forecast planning group snapshot
|
|
51650
51693
|
*
|
|
51651
|
-
* @param {String} businessUnitId The
|
|
51694
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51652
51695
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
51653
51696
|
* @param {String} forecastId The ID of the forecast
|
|
51654
51697
|
*/
|
|
@@ -51683,7 +51726,7 @@ class WorkforceManagementApi {
|
|
|
51683
51726
|
/**
|
|
51684
51727
|
* Get short term forecasts
|
|
51685
51728
|
* Use \"recent\" (without quotes) for the `weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any forecast which spans the specified week
|
|
51686
|
-
* @param {String} businessUnitId The
|
|
51729
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
51687
51730
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format or 'recent' (without quotes) to fetch recent forecasts
|
|
51688
51731
|
*/
|
|
51689
51732
|
getWorkforcemanagementBusinessunitWeekShorttermforecasts(businessUnitId, weekDateId) {
|
|
@@ -51901,7 +51944,7 @@ class WorkforceManagementApi {
|
|
|
51901
51944
|
/**
|
|
51902
51945
|
* Get a list of user schedule adherence records for the requested management unit
|
|
51903
51946
|
*
|
|
51904
|
-
* @param {String} managementUnitId The
|
|
51947
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
51905
51948
|
* @param {Object} opts Optional parameters
|
|
51906
51949
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
51907
51950
|
*/
|
|
@@ -51930,7 +51973,7 @@ class WorkforceManagementApi {
|
|
|
51930
51973
|
/**
|
|
51931
51974
|
* Get data for agent in the management unit
|
|
51932
51975
|
*
|
|
51933
|
-
* @param {String} managementUnitId The
|
|
51976
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
51934
51977
|
* @param {String} agentId The agent id
|
|
51935
51978
|
* @param {Object} opts Optional parameters
|
|
51936
51979
|
* @param {Boolean} opts.excludeCapabilities Excludes all capabilities of the agent such as queues, languages, and skills
|
|
@@ -51964,7 +52007,7 @@ class WorkforceManagementApi {
|
|
|
51964
52007
|
/**
|
|
51965
52008
|
* Gets all the shift trades for a given agent
|
|
51966
52009
|
*
|
|
51967
|
-
* @param {String} managementUnitId The
|
|
52010
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
51968
52011
|
* @param {String} agentId The agent id
|
|
51969
52012
|
*/
|
|
51970
52013
|
getWorkforcemanagementManagementunitAgentShifttrades(managementUnitId, agentId) {
|
|
@@ -51994,7 +52037,7 @@ class WorkforceManagementApi {
|
|
|
51994
52037
|
/**
|
|
51995
52038
|
* Gets a summary of all shift trades in the matched state
|
|
51996
52039
|
*
|
|
51997
|
-
* @param {String} managementUnitId The
|
|
52040
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
51998
52041
|
*/
|
|
51999
52042
|
getWorkforcemanagementManagementunitShifttradesMatched(managementUnitId) {
|
|
52000
52043
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -52019,7 +52062,7 @@ class WorkforceManagementApi {
|
|
|
52019
52062
|
/**
|
|
52020
52063
|
* Gets list of users available for whom you can send direct shift trade requests
|
|
52021
52064
|
*
|
|
52022
|
-
* @param {String} managementUnitId The
|
|
52065
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52023
52066
|
*/
|
|
52024
52067
|
getWorkforcemanagementManagementunitShifttradesUsers(managementUnitId) {
|
|
52025
52068
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -52044,7 +52087,7 @@ class WorkforceManagementApi {
|
|
|
52044
52087
|
/**
|
|
52045
52088
|
* Gets a time off limit object
|
|
52046
52089
|
* Returns properties of time off limit object, but not daily values.
|
|
52047
|
-
* @param {String} managementUnitId The
|
|
52090
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52048
52091
|
* @param {String} timeOffLimitId The ID of the time off limit to fetch
|
|
52049
52092
|
*/
|
|
52050
52093
|
getWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
@@ -52074,7 +52117,7 @@ class WorkforceManagementApi {
|
|
|
52074
52117
|
/**
|
|
52075
52118
|
* Gets a list of time off limit objects under management unit.
|
|
52076
52119
|
* Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.
|
|
52077
|
-
* @param {String} managementUnitId The
|
|
52120
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52078
52121
|
*/
|
|
52079
52122
|
getWorkforcemanagementManagementunitTimeofflimits(managementUnitId) {
|
|
52080
52123
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -52099,7 +52142,7 @@ class WorkforceManagementApi {
|
|
|
52099
52142
|
/**
|
|
52100
52143
|
* Gets a time off plan
|
|
52101
52144
|
*
|
|
52102
|
-
* @param {String} managementUnitId The management unit
|
|
52145
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
52103
52146
|
* @param {String} timeOffPlanId The ID of the time off plan to fetch
|
|
52104
52147
|
*/
|
|
52105
52148
|
getWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
@@ -52129,7 +52172,7 @@ class WorkforceManagementApi {
|
|
|
52129
52172
|
/**
|
|
52130
52173
|
* Gets a list of time off plans
|
|
52131
52174
|
*
|
|
52132
|
-
* @param {String} managementUnitId The management unit
|
|
52175
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
52133
52176
|
*/
|
|
52134
52177
|
getWorkforcemanagementManagementunitTimeoffplans(managementUnitId) {
|
|
52135
52178
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -52154,7 +52197,7 @@ class WorkforceManagementApi {
|
|
|
52154
52197
|
/**
|
|
52155
52198
|
* Get a time off request
|
|
52156
52199
|
*
|
|
52157
|
-
* @param {String} managementUnitId The
|
|
52200
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52158
52201
|
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
52159
52202
|
* @param {String} timeOffRequestId Time Off Request Id
|
|
52160
52203
|
*/
|
|
@@ -52189,7 +52232,7 @@ class WorkforceManagementApi {
|
|
|
52189
52232
|
/**
|
|
52190
52233
|
* Retrieves time off limit, allocated and waitlisted values according to specific time off request
|
|
52191
52234
|
*
|
|
52192
|
-
* @param {String} managementUnitId The
|
|
52235
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52193
52236
|
* @param {String} userId The userId to whom the time off request applies.
|
|
52194
52237
|
* @param {String} timeOffRequestId The ID of the time off request, which dates and activityCodeId determine limit values to retrieve
|
|
52195
52238
|
*/
|
|
@@ -52224,7 +52267,7 @@ class WorkforceManagementApi {
|
|
|
52224
52267
|
/**
|
|
52225
52268
|
* Get a list of time off requests for a given user
|
|
52226
52269
|
*
|
|
52227
|
-
* @param {String} managementUnitId The
|
|
52270
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52228
52271
|
* @param {String} userId The userId to whom the Time Off Request applies.
|
|
52229
52272
|
* @param {Object} opts Optional parameters
|
|
52230
52273
|
* @param {Boolean} opts.recentlyReviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
|
|
@@ -52258,7 +52301,7 @@ class WorkforceManagementApi {
|
|
|
52258
52301
|
/**
|
|
52259
52302
|
* Get users in the management unit
|
|
52260
52303
|
*
|
|
52261
|
-
* @param {String} managementUnitId The
|
|
52304
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52262
52305
|
*/
|
|
52263
52306
|
getWorkforcemanagementManagementunitUsers(managementUnitId) {
|
|
52264
52307
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -52359,7 +52402,7 @@ class WorkforceManagementApi {
|
|
|
52359
52402
|
/**
|
|
52360
52403
|
* Gets all the shift trades for a given week
|
|
52361
52404
|
*
|
|
52362
|
-
* @param {String} managementUnitId The
|
|
52405
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52363
52406
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
52364
52407
|
* @param {Object} opts Optional parameters
|
|
52365
52408
|
* @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
|
|
@@ -52632,7 +52675,7 @@ class WorkforceManagementApi {
|
|
|
52632
52675
|
/**
|
|
52633
52676
|
* Get a time off request for the current user
|
|
52634
52677
|
*
|
|
52635
|
-
* @param {String} timeOffRequestId
|
|
52678
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
52636
52679
|
*/
|
|
52637
52680
|
getWorkforcemanagementTimeoffrequest(timeOffRequestId) {
|
|
52638
52681
|
// verify the required parameter 'timeOffRequestId' is set
|
|
@@ -52657,7 +52700,7 @@ class WorkforceManagementApi {
|
|
|
52657
52700
|
/**
|
|
52658
52701
|
* Get the daily waitlist positions of a time off request for the current user
|
|
52659
52702
|
*
|
|
52660
|
-
* @param {String} timeOffRequestId
|
|
52703
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
52661
52704
|
*/
|
|
52662
52705
|
getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId) {
|
|
52663
52706
|
// verify the required parameter 'timeOffRequestId' is set
|
|
@@ -52900,7 +52943,7 @@ class WorkforceManagementApi {
|
|
|
52900
52943
|
/**
|
|
52901
52944
|
* Updates a time off limit object.
|
|
52902
52945
|
* Updates time off limit object properties, but not daily values.
|
|
52903
|
-
* @param {String} managementUnitId The
|
|
52946
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
52904
52947
|
* @param {String} timeOffLimitId The id of time off limit object to update
|
|
52905
52948
|
* @param {Object} opts Optional parameters
|
|
52906
52949
|
* @param {Object} opts.body body
|
|
@@ -52934,7 +52977,7 @@ class WorkforceManagementApi {
|
|
|
52934
52977
|
/**
|
|
52935
52978
|
* Updates a time off plan
|
|
52936
52979
|
*
|
|
52937
|
-
* @param {String} managementUnitId The management unit
|
|
52980
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
52938
52981
|
* @param {String} timeOffPlanId The ID of the time off plan to update
|
|
52939
52982
|
* @param {Object} opts Optional parameters
|
|
52940
52983
|
* @param {Object} opts.body body
|
|
@@ -52968,7 +53011,7 @@ class WorkforceManagementApi {
|
|
|
52968
53011
|
/**
|
|
52969
53012
|
* Update a time off request
|
|
52970
53013
|
*
|
|
52971
|
-
* @param {String} managementUnitId The
|
|
53014
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
52972
53015
|
* @param {String} userId The id of the user the requested time off request belongs to
|
|
52973
53016
|
* @param {String} timeOffRequestId The id of the time off request to update
|
|
52974
53017
|
* @param {Object} opts Optional parameters
|
|
@@ -53007,7 +53050,7 @@ class WorkforceManagementApi {
|
|
|
53007
53050
|
/**
|
|
53008
53051
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
53009
53052
|
*
|
|
53010
|
-
* @param {String} managementUnitId The
|
|
53053
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
53011
53054
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
53012
53055
|
* @param {Object} body body
|
|
53013
53056
|
* @param {String} tradeId The ID of the shift trade to update
|
|
@@ -53116,7 +53159,7 @@ class WorkforceManagementApi {
|
|
|
53116
53159
|
/**
|
|
53117
53160
|
* Update a time off request for the current user
|
|
53118
53161
|
*
|
|
53119
|
-
* @param {String} timeOffRequestId
|
|
53162
|
+
* @param {String} timeOffRequestId The ID of the time off request
|
|
53120
53163
|
* @param {Object} opts Optional parameters
|
|
53121
53164
|
* @param {Object} opts.body body
|
|
53122
53165
|
*/
|
|
@@ -53253,7 +53296,7 @@ class WorkforceManagementApi {
|
|
|
53253
53296
|
/**
|
|
53254
53297
|
* Get intraday data for the given date for the requested planningGroupIds
|
|
53255
53298
|
*
|
|
53256
|
-
* @param {String} businessUnitId The
|
|
53299
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
53257
53300
|
* @param {Object} opts Optional parameters
|
|
53258
53301
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
53259
53302
|
* @param {Object} opts.body body
|
|
@@ -53686,7 +53729,7 @@ class WorkforceManagementApi {
|
|
|
53686
53729
|
/**
|
|
53687
53730
|
* Copy a short term forecast
|
|
53688
53731
|
*
|
|
53689
|
-
* @param {String} businessUnitId The
|
|
53732
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
53690
53733
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
53691
53734
|
* @param {String} forecastId The ID of the forecast to copy
|
|
53692
53735
|
* @param {Object} body body
|
|
@@ -53730,7 +53773,7 @@ class WorkforceManagementApi {
|
|
|
53730
53773
|
/**
|
|
53731
53774
|
* Generate a short term forecast
|
|
53732
53775
|
*
|
|
53733
|
-
* @param {String} businessUnitId The
|
|
53776
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
53734
53777
|
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
53735
53778
|
* @param {Object} body
|
|
53736
53779
|
* @param {Object} opts Optional parameters
|
|
@@ -53769,7 +53812,7 @@ class WorkforceManagementApi {
|
|
|
53769
53812
|
/**
|
|
53770
53813
|
* Starts importing the uploaded short term forecast
|
|
53771
53814
|
* Call after uploading the forecast data to the url supplied by the /import/uploadurl route
|
|
53772
|
-
* @param {String} businessUnitId The
|
|
53815
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
53773
53816
|
* @param {String} weekDateId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
53774
53817
|
* @param {Object} body
|
|
53775
53818
|
*/
|
|
@@ -53804,7 +53847,7 @@ class WorkforceManagementApi {
|
|
|
53804
53847
|
/**
|
|
53805
53848
|
* Creates a signed upload URL for importing a short term forecast
|
|
53806
53849
|
* Once the upload is complete, call the /import route to start the short term forecast import process
|
|
53807
|
-
* @param {String} businessUnitId The
|
|
53850
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
53808
53851
|
* @param {String} weekDateId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
53809
53852
|
* @param {Object} body body
|
|
53810
53853
|
*/
|
|
@@ -53931,7 +53974,7 @@ class WorkforceManagementApi {
|
|
|
53931
53974
|
/**
|
|
53932
53975
|
* Query published schedules for given given time range for set of users
|
|
53933
53976
|
*
|
|
53934
|
-
* @param {String} managementUnitId The
|
|
53977
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
53935
53978
|
* @param {Object} opts Optional parameters
|
|
53936
53979
|
* @param {Object} opts.body body
|
|
53937
53980
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
@@ -53962,7 +54005,7 @@ class WorkforceManagementApi {
|
|
|
53962
54005
|
/**
|
|
53963
54006
|
* Request a historical adherence report
|
|
53964
54007
|
* The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
|
|
53965
|
-
* @param {String} managementUnitId The
|
|
54008
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
53966
54009
|
* @param {Object} opts Optional parameters
|
|
53967
54010
|
* @param {Object} opts.body body
|
|
53968
54011
|
*/
|
|
@@ -54020,7 +54063,7 @@ class WorkforceManagementApi {
|
|
|
54020
54063
|
/**
|
|
54021
54064
|
* Query published schedules for given given time range for set of users
|
|
54022
54065
|
*
|
|
54023
|
-
* @param {String} managementUnitId The
|
|
54066
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
54024
54067
|
* @param {Object} opts Optional parameters
|
|
54025
54068
|
* @param {Object} opts.body body
|
|
54026
54069
|
*/
|
|
@@ -54049,7 +54092,7 @@ class WorkforceManagementApi {
|
|
|
54049
54092
|
/**
|
|
54050
54093
|
* Creates a new time off limit object under management unit.
|
|
54051
54094
|
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
54052
|
-
* @param {String} managementUnitId The
|
|
54095
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
54053
54096
|
* @param {Object} opts Optional parameters
|
|
54054
54097
|
* @param {Object} opts.body body
|
|
54055
54098
|
*/
|
|
@@ -54078,7 +54121,7 @@ class WorkforceManagementApi {
|
|
|
54078
54121
|
/**
|
|
54079
54122
|
* Retrieves time off limit related values based on a given set of filters.
|
|
54080
54123
|
*
|
|
54081
|
-
* @param {String} managementUnitId The
|
|
54124
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
54082
54125
|
* @param {Object} opts Optional parameters
|
|
54083
54126
|
* @param {Object} opts.body body
|
|
54084
54127
|
*/
|
|
@@ -54107,7 +54150,7 @@ class WorkforceManagementApi {
|
|
|
54107
54150
|
/**
|
|
54108
54151
|
* Creates a new time off plan
|
|
54109
54152
|
*
|
|
54110
|
-
* @param {String} managementUnitId The management unit
|
|
54153
|
+
* @param {String} managementUnitId The ID of the management unit
|
|
54111
54154
|
* @param {Object} opts Optional parameters
|
|
54112
54155
|
* @param {Object} opts.body body
|
|
54113
54156
|
*/
|
|
@@ -54136,7 +54179,7 @@ class WorkforceManagementApi {
|
|
|
54136
54179
|
/**
|
|
54137
54180
|
* Create a new time off request
|
|
54138
54181
|
*
|
|
54139
|
-
* @param {String} managementUnitId The
|
|
54182
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
54140
54183
|
* @param {Object} opts Optional parameters
|
|
54141
54184
|
* @param {Object} opts.body body
|
|
54142
54185
|
*/
|
|
@@ -54165,7 +54208,7 @@ class WorkforceManagementApi {
|
|
|
54165
54208
|
/**
|
|
54166
54209
|
* Fetches time off requests matching the conditions specified in the request body
|
|
54167
54210
|
* Request body requires one of the following: User ID is specified, statuses == [Pending] or date range to be specified and less than or equal to 33 days. All other fields are filters
|
|
54168
|
-
* @param {String} managementUnitId The
|
|
54211
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
54169
54212
|
* @param {Object} opts Optional parameters
|
|
54170
54213
|
* @param {Object} opts.body body
|
|
54171
54214
|
*/
|
|
@@ -54194,7 +54237,7 @@ class WorkforceManagementApi {
|
|
|
54194
54237
|
/**
|
|
54195
54238
|
* Retrieves daily waitlist position for a list of time off requests
|
|
54196
54239
|
*
|
|
54197
|
-
* @param {String} managementUnitId The
|
|
54240
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
54198
54241
|
* @param {Object} opts Optional parameters
|
|
54199
54242
|
* @param {Object} opts.body body
|
|
54200
54243
|
*/
|
|
@@ -54223,7 +54266,7 @@ class WorkforceManagementApi {
|
|
|
54223
54266
|
/**
|
|
54224
54267
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
54225
54268
|
*
|
|
54226
|
-
* @param {String} managementUnitId The
|
|
54269
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
54227
54270
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
54228
54271
|
* @param {Object} body body
|
|
54229
54272
|
* @param {String} tradeId The ID of the shift trade to update
|
|
@@ -54263,7 +54306,7 @@ class WorkforceManagementApi {
|
|
|
54263
54306
|
/**
|
|
54264
54307
|
* Adds a shift trade
|
|
54265
54308
|
*
|
|
54266
|
-
* @param {String} managementUnitId The
|
|
54309
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
54267
54310
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
54268
54311
|
* @param {Object} body body
|
|
54269
54312
|
*/
|
|
@@ -54298,7 +54341,7 @@ class WorkforceManagementApi {
|
|
|
54298
54341
|
/**
|
|
54299
54342
|
* Searches for potential shift trade matches for the current agent
|
|
54300
54343
|
*
|
|
54301
|
-
* @param {String} managementUnitId The
|
|
54344
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
54302
54345
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
54303
54346
|
* @param {Object} body body
|
|
54304
54347
|
*/
|
|
@@ -54333,7 +54376,7 @@ class WorkforceManagementApi {
|
|
|
54333
54376
|
/**
|
|
54334
54377
|
* Updates the state of a batch of shift trades
|
|
54335
54378
|
* Admin functionality is not supported with \"mine\".
|
|
54336
|
-
* @param {String} managementUnitId The
|
|
54379
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
54337
54380
|
* @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
54338
54381
|
* @param {Object} body body
|
|
54339
54382
|
* @param {Object} opts Optional parameters
|
|
@@ -54654,7 +54697,7 @@ class WorkforceManagementApi {
|
|
|
54654
54697
|
/**
|
|
54655
54698
|
* Sets daily values for a date range of time off limit object
|
|
54656
54699
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
54657
|
-
* @param {String} managementUnitId The
|
|
54700
|
+
* @param {String} managementUnitId The ID of the management unit.
|
|
54658
54701
|
* @param {String} timeOffLimitId The ID of the time off limit object to set values for
|
|
54659
54702
|
* @param {Object} opts Optional parameters
|
|
54660
54703
|
* @param {Object} opts.body body
|
|
@@ -54716,7 +54759,7 @@ class WorkforceManagementApi {
|
|
|
54716
54759
|
* </pre>
|
|
54717
54760
|
* </p>
|
|
54718
54761
|
* @module purecloud-platform-client-v2/index
|
|
54719
|
-
* @version
|
|
54762
|
+
* @version 135.0.0
|
|
54720
54763
|
*/
|
|
54721
54764
|
class platformClient {
|
|
54722
54765
|
constructor() {
|