purecloud-platform-client-v2 125.0.0 → 126.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 +757 -169
- package/dist/web-amd/purecloud-platform-client-v2.js +757 -169
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +757 -169
- package/dist/web-cjs/purecloud-platform-client-v2.js +757 -169
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +307 -49
- 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 -26
- 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 +1 -1
- 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 -74
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +3 -3
- 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/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 +216 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +3 -4
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +2 -2
- 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 +1 -1
- 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 +473 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -393,7 +393,7 @@ class Configuration {
|
|
|
393
393
|
|
|
394
394
|
/**
|
|
395
395
|
* @module purecloud-platform-client-v2/ApiClient
|
|
396
|
-
* @version
|
|
396
|
+
* @version 126.0.0
|
|
397
397
|
*/
|
|
398
398
|
class ApiClient {
|
|
399
399
|
/**
|
|
@@ -1340,7 +1340,7 @@ class ApiClient {
|
|
|
1340
1340
|
|
|
1341
1341
|
// set header parameters
|
|
1342
1342
|
request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
|
|
1343
|
-
//request.set({ 'purecloud-sdk': '
|
|
1343
|
+
//request.set({ 'purecloud-sdk': '126.0.0' });
|
|
1344
1344
|
|
|
1345
1345
|
// set request timeout
|
|
1346
1346
|
request.timeout(that.timeout);
|
|
@@ -1440,7 +1440,7 @@ class AlertingApi {
|
|
|
1440
1440
|
/**
|
|
1441
1441
|
* Alerting service.
|
|
1442
1442
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1443
|
-
* @version
|
|
1443
|
+
* @version 126.0.0
|
|
1444
1444
|
*/
|
|
1445
1445
|
|
|
1446
1446
|
/**
|
|
@@ -1754,7 +1754,7 @@ class AnalyticsApi {
|
|
|
1754
1754
|
/**
|
|
1755
1755
|
* Analytics service.
|
|
1756
1756
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1757
|
-
* @version
|
|
1757
|
+
* @version 126.0.0
|
|
1758
1758
|
*/
|
|
1759
1759
|
|
|
1760
1760
|
/**
|
|
@@ -2350,31 +2350,6 @@ class AnalyticsApi {
|
|
|
2350
2350
|
);
|
|
2351
2351
|
}
|
|
2352
2352
|
|
|
2353
|
-
/**
|
|
2354
|
-
* Patch AnalyticsReportingSettings values for an organization
|
|
2355
|
-
*
|
|
2356
|
-
* @param {Object} body AnalyticsReportingSettingsRequest
|
|
2357
|
-
*/
|
|
2358
|
-
patchAnalyticsReportingSettings(body) {
|
|
2359
|
-
// verify the required parameter 'body' is set
|
|
2360
|
-
if (body === undefined || body === null) {
|
|
2361
|
-
throw 'Missing the required parameter "body" when calling patchAnalyticsReportingSettings';
|
|
2362
|
-
}
|
|
2363
|
-
|
|
2364
|
-
return this.apiClient.callApi(
|
|
2365
|
-
'/api/v2/analytics/reporting/settings',
|
|
2366
|
-
'PATCH',
|
|
2367
|
-
{ },
|
|
2368
|
-
{ },
|
|
2369
|
-
{ },
|
|
2370
|
-
{ },
|
|
2371
|
-
body,
|
|
2372
|
-
['PureCloud OAuth'],
|
|
2373
|
-
['application/json'],
|
|
2374
|
-
['application/json']
|
|
2375
|
-
);
|
|
2376
|
-
}
|
|
2377
|
-
|
|
2378
2353
|
/**
|
|
2379
2354
|
* Query for bot aggregates
|
|
2380
2355
|
*
|
|
@@ -2916,7 +2891,7 @@ class ArchitectApi {
|
|
|
2916
2891
|
/**
|
|
2917
2892
|
* Architect service.
|
|
2918
2893
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2919
|
-
* @version
|
|
2894
|
+
* @version 126.0.0
|
|
2920
2895
|
*/
|
|
2921
2896
|
|
|
2922
2897
|
/**
|
|
@@ -5912,7 +5887,7 @@ class AuditApi {
|
|
|
5912
5887
|
/**
|
|
5913
5888
|
* Audit service.
|
|
5914
5889
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
5915
|
-
* @version
|
|
5890
|
+
* @version 126.0.0
|
|
5916
5891
|
*/
|
|
5917
5892
|
|
|
5918
5893
|
/**
|
|
@@ -6083,7 +6058,7 @@ class AuthorizationApi {
|
|
|
6083
6058
|
/**
|
|
6084
6059
|
* Authorization service.
|
|
6085
6060
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6086
|
-
* @version
|
|
6061
|
+
* @version 126.0.0
|
|
6087
6062
|
*/
|
|
6088
6063
|
|
|
6089
6064
|
/**
|
|
@@ -7266,7 +7241,7 @@ class BillingApi {
|
|
|
7266
7241
|
/**
|
|
7267
7242
|
* Billing service.
|
|
7268
7243
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7269
|
-
* @version
|
|
7244
|
+
* @version 126.0.0
|
|
7270
7245
|
*/
|
|
7271
7246
|
|
|
7272
7247
|
/**
|
|
@@ -7346,7 +7321,7 @@ class ChatApi {
|
|
|
7346
7321
|
/**
|
|
7347
7322
|
* Chat service.
|
|
7348
7323
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7349
|
-
* @version
|
|
7324
|
+
* @version 126.0.0
|
|
7350
7325
|
*/
|
|
7351
7326
|
|
|
7352
7327
|
/**
|
|
@@ -7437,7 +7412,7 @@ class CoachingApi {
|
|
|
7437
7412
|
/**
|
|
7438
7413
|
* Coaching service.
|
|
7439
7414
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7440
|
-
* @version
|
|
7415
|
+
* @version 126.0.0
|
|
7441
7416
|
*/
|
|
7442
7417
|
|
|
7443
7418
|
/**
|
|
@@ -8012,7 +7987,7 @@ class ContentManagementApi {
|
|
|
8012
7987
|
/**
|
|
8013
7988
|
* ContentManagement service.
|
|
8014
7989
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8015
|
-
* @version
|
|
7990
|
+
* @version 126.0.0
|
|
8016
7991
|
*/
|
|
8017
7992
|
|
|
8018
7993
|
/**
|
|
@@ -9152,7 +9127,7 @@ class ConversationsApi {
|
|
|
9152
9127
|
/**
|
|
9153
9128
|
* Conversations service.
|
|
9154
9129
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9155
|
-
* @version
|
|
9130
|
+
* @version 126.0.0
|
|
9156
9131
|
*/
|
|
9157
9132
|
|
|
9158
9133
|
/**
|
|
@@ -13541,7 +13516,7 @@ class DataExtensionsApi {
|
|
|
13541
13516
|
/**
|
|
13542
13517
|
* DataExtensions service.
|
|
13543
13518
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
13544
|
-
* @version
|
|
13519
|
+
* @version 126.0.0
|
|
13545
13520
|
*/
|
|
13546
13521
|
|
|
13547
13522
|
/**
|
|
@@ -13627,7 +13602,7 @@ class ExternalContactsApi {
|
|
|
13627
13602
|
/**
|
|
13628
13603
|
* ExternalContacts service.
|
|
13629
13604
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
13630
|
-
* @version
|
|
13605
|
+
* @version 126.0.0
|
|
13631
13606
|
*/
|
|
13632
13607
|
|
|
13633
13608
|
/**
|
|
@@ -15370,7 +15345,7 @@ class FaxApi {
|
|
|
15370
15345
|
/**
|
|
15371
15346
|
* Fax service.
|
|
15372
15347
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
15373
|
-
* @version
|
|
15348
|
+
* @version 126.0.0
|
|
15374
15349
|
*/
|
|
15375
15350
|
|
|
15376
15351
|
/**
|
|
@@ -15541,7 +15516,7 @@ class FlowsApi {
|
|
|
15541
15516
|
/**
|
|
15542
15517
|
* Flows service.
|
|
15543
15518
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
15544
|
-
* @version
|
|
15519
|
+
* @version 126.0.0
|
|
15545
15520
|
*/
|
|
15546
15521
|
|
|
15547
15522
|
/**
|
|
@@ -15612,7 +15587,7 @@ class GamificationApi {
|
|
|
15612
15587
|
/**
|
|
15613
15588
|
* Gamification service.
|
|
15614
15589
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
15615
|
-
* @version
|
|
15590
|
+
* @version 126.0.0
|
|
15616
15591
|
*/
|
|
15617
15592
|
|
|
15618
15593
|
/**
|
|
@@ -16918,7 +16893,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
16918
16893
|
/**
|
|
16919
16894
|
* GeneralDataProtectionRegulation service.
|
|
16920
16895
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
16921
|
-
* @version
|
|
16896
|
+
* @version 126.0.0
|
|
16922
16897
|
*/
|
|
16923
16898
|
|
|
16924
16899
|
/**
|
|
@@ -17048,7 +17023,7 @@ class GeolocationApi {
|
|
|
17048
17023
|
/**
|
|
17049
17024
|
* Geolocation service.
|
|
17050
17025
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
17051
|
-
* @version
|
|
17026
|
+
* @version 126.0.0
|
|
17052
17027
|
*/
|
|
17053
17028
|
|
|
17054
17029
|
/**
|
|
@@ -17179,7 +17154,7 @@ class GreetingsApi {
|
|
|
17179
17154
|
/**
|
|
17180
17155
|
* Greetings service.
|
|
17181
17156
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
17182
|
-
* @version
|
|
17157
|
+
* @version 126.0.0
|
|
17183
17158
|
*/
|
|
17184
17159
|
|
|
17185
17160
|
/**
|
|
@@ -17634,7 +17609,7 @@ class GroupsApi {
|
|
|
17634
17609
|
/**
|
|
17635
17610
|
* Groups service.
|
|
17636
17611
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
17637
|
-
* @version
|
|
17612
|
+
* @version 126.0.0
|
|
17638
17613
|
*/
|
|
17639
17614
|
|
|
17640
17615
|
/**
|
|
@@ -18039,7 +18014,7 @@ class IdentityProviderApi {
|
|
|
18039
18014
|
/**
|
|
18040
18015
|
* IdentityProvider service.
|
|
18041
18016
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
18042
|
-
* @version
|
|
18017
|
+
* @version 126.0.0
|
|
18043
18018
|
*/
|
|
18044
18019
|
|
|
18045
18020
|
/**
|
|
@@ -18795,7 +18770,7 @@ class IntegrationsApi {
|
|
|
18795
18770
|
/**
|
|
18796
18771
|
* Integrations service.
|
|
18797
18772
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
18798
|
-
* @version
|
|
18773
|
+
* @version 126.0.0
|
|
18799
18774
|
*/
|
|
18800
18775
|
|
|
18801
18776
|
/**
|
|
@@ -20441,7 +20416,7 @@ class JourneyApi {
|
|
|
20441
20416
|
/**
|
|
20442
20417
|
* Journey service.
|
|
20443
20418
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
20444
|
-
* @version
|
|
20419
|
+
* @version 126.0.0
|
|
20445
20420
|
*/
|
|
20446
20421
|
|
|
20447
20422
|
/**
|
|
@@ -21152,7 +21127,7 @@ class KnowledgeApi {
|
|
|
21152
21127
|
/**
|
|
21153
21128
|
* Knowledge service.
|
|
21154
21129
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
21155
|
-
* @version
|
|
21130
|
+
* @version 126.0.0
|
|
21156
21131
|
*/
|
|
21157
21132
|
|
|
21158
21133
|
/**
|
|
@@ -21642,79 +21617,6 @@ class KnowledgeApi {
|
|
|
21642
21617
|
);
|
|
21643
21618
|
}
|
|
21644
21619
|
|
|
21645
|
-
/**
|
|
21646
|
-
* Update specific context data of the knowledge base.
|
|
21647
|
-
*
|
|
21648
|
-
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
21649
|
-
* @param {String} contextId Context ID.
|
|
21650
|
-
* @param {Object} opts Optional parameters
|
|
21651
|
-
* @param {Object} opts.body
|
|
21652
|
-
*/
|
|
21653
|
-
patchKnowledgeKnowledgebaseContext(knowledgeBaseId, contextId, opts) {
|
|
21654
|
-
opts = opts || {};
|
|
21655
|
-
|
|
21656
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
21657
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
21658
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseContext';
|
|
21659
|
-
}
|
|
21660
|
-
// verify the required parameter 'contextId' is set
|
|
21661
|
-
if (contextId === undefined || contextId === null) {
|
|
21662
|
-
throw 'Missing the required parameter "contextId" when calling patchKnowledgeKnowledgebaseContext';
|
|
21663
|
-
}
|
|
21664
|
-
|
|
21665
|
-
return this.apiClient.callApi(
|
|
21666
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/contexts/{contextId}',
|
|
21667
|
-
'PATCH',
|
|
21668
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'contextId': contextId },
|
|
21669
|
-
{ },
|
|
21670
|
-
{ },
|
|
21671
|
-
{ },
|
|
21672
|
-
opts['body'],
|
|
21673
|
-
['PureCloud OAuth'],
|
|
21674
|
-
['application/json'],
|
|
21675
|
-
['application/json']
|
|
21676
|
-
);
|
|
21677
|
-
}
|
|
21678
|
-
|
|
21679
|
-
/**
|
|
21680
|
-
* Update context value.
|
|
21681
|
-
*
|
|
21682
|
-
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
21683
|
-
* @param {String} contextId Context ID.
|
|
21684
|
-
* @param {String} contextValueId Context Value ID.
|
|
21685
|
-
* @param {Object} opts Optional parameters
|
|
21686
|
-
* @param {Object} opts.body
|
|
21687
|
-
*/
|
|
21688
|
-
patchKnowledgeKnowledgebaseContextValue(knowledgeBaseId, contextId, contextValueId, opts) {
|
|
21689
|
-
opts = opts || {};
|
|
21690
|
-
|
|
21691
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
21692
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
21693
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseContextValue';
|
|
21694
|
-
}
|
|
21695
|
-
// verify the required parameter 'contextId' is set
|
|
21696
|
-
if (contextId === undefined || contextId === null) {
|
|
21697
|
-
throw 'Missing the required parameter "contextId" when calling patchKnowledgeKnowledgebaseContextValue';
|
|
21698
|
-
}
|
|
21699
|
-
// verify the required parameter 'contextValueId' is set
|
|
21700
|
-
if (contextValueId === undefined || contextValueId === null) {
|
|
21701
|
-
throw 'Missing the required parameter "contextValueId" when calling patchKnowledgeKnowledgebaseContextValue';
|
|
21702
|
-
}
|
|
21703
|
-
|
|
21704
|
-
return this.apiClient.callApi(
|
|
21705
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/contexts/{contextId}/values/{contextValueId}',
|
|
21706
|
-
'PATCH',
|
|
21707
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'contextId': contextId,'contextValueId': contextValueId },
|
|
21708
|
-
{ },
|
|
21709
|
-
{ },
|
|
21710
|
-
{ },
|
|
21711
|
-
opts['body'],
|
|
21712
|
-
['PureCloud OAuth'],
|
|
21713
|
-
['application/json'],
|
|
21714
|
-
['application/json']
|
|
21715
|
-
);
|
|
21716
|
-
}
|
|
21717
|
-
|
|
21718
21620
|
/**
|
|
21719
21621
|
* Update category
|
|
21720
21622
|
*
|
|
@@ -22125,7 +22027,7 @@ class LanguageUnderstandingApi {
|
|
|
22125
22027
|
/**
|
|
22126
22028
|
* LanguageUnderstanding service.
|
|
22127
22029
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
22128
|
-
* @version
|
|
22030
|
+
* @version 126.0.0
|
|
22129
22031
|
*/
|
|
22130
22032
|
|
|
22131
22033
|
/**
|
|
@@ -22691,7 +22593,7 @@ class LanguageUnderstandingApi {
|
|
|
22691
22593
|
}
|
|
22692
22594
|
|
|
22693
22595
|
/**
|
|
22694
|
-
* Save information for the draft
|
|
22596
|
+
* Save information for the draft. Either topic draft or intent draft should be sent.
|
|
22695
22597
|
*
|
|
22696
22598
|
* @param {String} minerId Miner ID
|
|
22697
22599
|
* @param {String} draftId Draft ID
|
|
@@ -22935,7 +22837,7 @@ class LanguageUnderstandingApi {
|
|
|
22935
22837
|
}
|
|
22936
22838
|
|
|
22937
22839
|
/**
|
|
22938
|
-
* Start the mining process. Specify date range pair with mediaType
|
|
22840
|
+
* Start the mining process. Specify date range pair with mediaType, queueIds, participantType for mining data from Genesys Cloud. Specify only uploadKey for mining through an external file.
|
|
22939
22841
|
*
|
|
22940
22842
|
* @param {String} minerId Miner ID
|
|
22941
22843
|
* @param {Object} opts Optional parameters
|
|
@@ -23029,7 +22931,7 @@ class LanguagesApi {
|
|
|
23029
22931
|
/**
|
|
23030
22932
|
* Languages service.
|
|
23031
22933
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
23032
|
-
* @version
|
|
22934
|
+
* @version 126.0.0
|
|
23033
22935
|
*/
|
|
23034
22936
|
|
|
23035
22937
|
/**
|
|
@@ -23297,7 +23199,7 @@ class LearningApi {
|
|
|
23297
23199
|
/**
|
|
23298
23200
|
* Learning service.
|
|
23299
23201
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
23300
|
-
* @version
|
|
23202
|
+
* @version 126.0.0
|
|
23301
23203
|
*/
|
|
23302
23204
|
|
|
23303
23205
|
/**
|
|
@@ -23888,7 +23790,7 @@ class LicenseApi {
|
|
|
23888
23790
|
/**
|
|
23889
23791
|
* License service.
|
|
23890
23792
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
23891
|
-
* @version
|
|
23793
|
+
* @version 126.0.0
|
|
23892
23794
|
*/
|
|
23893
23795
|
|
|
23894
23796
|
/**
|
|
@@ -24126,7 +24028,7 @@ class LocationsApi {
|
|
|
24126
24028
|
/**
|
|
24127
24029
|
* Locations service.
|
|
24128
24030
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
24129
|
-
* @version
|
|
24031
|
+
* @version 126.0.0
|
|
24130
24032
|
*/
|
|
24131
24033
|
|
|
24132
24034
|
/**
|
|
@@ -24362,7 +24264,7 @@ class MobileDevicesApi {
|
|
|
24362
24264
|
/**
|
|
24363
24265
|
* MobileDevices service.
|
|
24364
24266
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
24365
|
-
* @version
|
|
24267
|
+
* @version 126.0.0
|
|
24366
24268
|
*/
|
|
24367
24269
|
|
|
24368
24270
|
/**
|
|
@@ -24513,7 +24415,7 @@ class NotificationsApi {
|
|
|
24513
24415
|
/**
|
|
24514
24416
|
* Notifications service.
|
|
24515
24417
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
24516
|
-
* @version
|
|
24418
|
+
* @version 126.0.0
|
|
24517
24419
|
*/
|
|
24518
24420
|
|
|
24519
24421
|
/**
|
|
@@ -24738,7 +24640,7 @@ class OAuthApi {
|
|
|
24738
24640
|
/**
|
|
24739
24641
|
* OAuth service.
|
|
24740
24642
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
24741
|
-
* @version
|
|
24643
|
+
* @version 126.0.0
|
|
24742
24644
|
*/
|
|
24743
24645
|
|
|
24744
24646
|
/**
|
|
@@ -25096,7 +24998,7 @@ class ObjectsApi {
|
|
|
25096
24998
|
/**
|
|
25097
24999
|
* Objects service.
|
|
25098
25000
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
25099
|
-
* @version
|
|
25001
|
+
* @version 126.0.0
|
|
25100
25002
|
*/
|
|
25101
25003
|
|
|
25102
25004
|
/**
|
|
@@ -25367,7 +25269,7 @@ class OrganizationApi {
|
|
|
25367
25269
|
/**
|
|
25368
25270
|
* Organization service.
|
|
25369
25271
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
25370
|
-
* @version
|
|
25272
|
+
* @version 126.0.0
|
|
25371
25273
|
*/
|
|
25372
25274
|
|
|
25373
25275
|
/**
|
|
@@ -25770,7 +25672,7 @@ class OrganizationAuthorizationApi {
|
|
|
25770
25672
|
/**
|
|
25771
25673
|
* OrganizationAuthorization service.
|
|
25772
25674
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
25773
|
-
* @version
|
|
25675
|
+
* @version 126.0.0
|
|
25774
25676
|
*/
|
|
25775
25677
|
|
|
25776
25678
|
/**
|
|
@@ -25810,6 +25712,36 @@ class OrganizationAuthorizationApi {
|
|
|
25810
25712
|
);
|
|
25811
25713
|
}
|
|
25812
25714
|
|
|
25715
|
+
/**
|
|
25716
|
+
* Deletes cloned user
|
|
25717
|
+
*
|
|
25718
|
+
* @param {String} trusteeOrgId Trustee Organization Id
|
|
25719
|
+
* @param {String} trusteeUserId Id of the cloned user to delete
|
|
25720
|
+
*/
|
|
25721
|
+
deleteOrgauthorizationTrusteeCloneduser(trusteeOrgId, trusteeUserId) {
|
|
25722
|
+
// verify the required parameter 'trusteeOrgId' is set
|
|
25723
|
+
if (trusteeOrgId === undefined || trusteeOrgId === null) {
|
|
25724
|
+
throw 'Missing the required parameter "trusteeOrgId" when calling deleteOrgauthorizationTrusteeCloneduser';
|
|
25725
|
+
}
|
|
25726
|
+
// verify the required parameter 'trusteeUserId' is set
|
|
25727
|
+
if (trusteeUserId === undefined || trusteeUserId === null) {
|
|
25728
|
+
throw 'Missing the required parameter "trusteeUserId" when calling deleteOrgauthorizationTrusteeCloneduser';
|
|
25729
|
+
}
|
|
25730
|
+
|
|
25731
|
+
return this.apiClient.callApi(
|
|
25732
|
+
'/api/v2/orgauthorization/trustees/{trusteeOrgId}/clonedusers/{trusteeUserId}',
|
|
25733
|
+
'DELETE',
|
|
25734
|
+
{ 'trusteeOrgId': trusteeOrgId,'trusteeUserId': trusteeUserId },
|
|
25735
|
+
{ },
|
|
25736
|
+
{ },
|
|
25737
|
+
{ },
|
|
25738
|
+
null,
|
|
25739
|
+
['PureCloud OAuth'],
|
|
25740
|
+
['application/json'],
|
|
25741
|
+
['application/json']
|
|
25742
|
+
);
|
|
25743
|
+
}
|
|
25744
|
+
|
|
25813
25745
|
/**
|
|
25814
25746
|
* Delete Trustee User
|
|
25815
25747
|
*
|
|
@@ -25895,6 +25827,36 @@ class OrganizationAuthorizationApi {
|
|
|
25895
25827
|
);
|
|
25896
25828
|
}
|
|
25897
25829
|
|
|
25830
|
+
/**
|
|
25831
|
+
* Delete Cloned User
|
|
25832
|
+
*
|
|
25833
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
25834
|
+
* @param {String} trusteeUserId Trustee User Id
|
|
25835
|
+
*/
|
|
25836
|
+
deleteOrgauthorizationTrustorCloneduser(trustorOrgId, trusteeUserId) {
|
|
25837
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
25838
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
25839
|
+
throw 'Missing the required parameter "trustorOrgId" when calling deleteOrgauthorizationTrustorCloneduser';
|
|
25840
|
+
}
|
|
25841
|
+
// verify the required parameter 'trusteeUserId' is set
|
|
25842
|
+
if (trusteeUserId === undefined || trusteeUserId === null) {
|
|
25843
|
+
throw 'Missing the required parameter "trusteeUserId" when calling deleteOrgauthorizationTrustorCloneduser';
|
|
25844
|
+
}
|
|
25845
|
+
|
|
25846
|
+
return this.apiClient.callApi(
|
|
25847
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}',
|
|
25848
|
+
'DELETE',
|
|
25849
|
+
{ 'trustorOrgId': trustorOrgId,'trusteeUserId': trusteeUserId },
|
|
25850
|
+
{ },
|
|
25851
|
+
{ },
|
|
25852
|
+
{ },
|
|
25853
|
+
null,
|
|
25854
|
+
['PureCloud OAuth'],
|
|
25855
|
+
['application/json'],
|
|
25856
|
+
['application/json']
|
|
25857
|
+
);
|
|
25858
|
+
}
|
|
25859
|
+
|
|
25898
25860
|
/**
|
|
25899
25861
|
* Delete Trustee User
|
|
25900
25862
|
*
|
|
@@ -25975,6 +25937,31 @@ class OrganizationAuthorizationApi {
|
|
|
25975
25937
|
);
|
|
25976
25938
|
}
|
|
25977
25939
|
|
|
25940
|
+
/**
|
|
25941
|
+
* The list of cloned users from the trustee organization (i.e. users with a native user record).
|
|
25942
|
+
* There can be no more than 5 cloned users per organization, so results are represented as simple list and not paged
|
|
25943
|
+
* @param {String} trusteeOrgId Trustee Organization Id
|
|
25944
|
+
*/
|
|
25945
|
+
getOrgauthorizationTrusteeClonedusers(trusteeOrgId) {
|
|
25946
|
+
// verify the required parameter 'trusteeOrgId' is set
|
|
25947
|
+
if (trusteeOrgId === undefined || trusteeOrgId === null) {
|
|
25948
|
+
throw 'Missing the required parameter "trusteeOrgId" when calling getOrgauthorizationTrusteeClonedusers';
|
|
25949
|
+
}
|
|
25950
|
+
|
|
25951
|
+
return this.apiClient.callApi(
|
|
25952
|
+
'/api/v2/orgauthorization/trustees/{trusteeOrgId}/clonedusers',
|
|
25953
|
+
'GET',
|
|
25954
|
+
{ 'trusteeOrgId': trusteeOrgId },
|
|
25955
|
+
{ },
|
|
25956
|
+
{ },
|
|
25957
|
+
{ },
|
|
25958
|
+
null,
|
|
25959
|
+
['PureCloud OAuth'],
|
|
25960
|
+
['application/json'],
|
|
25961
|
+
['application/json']
|
|
25962
|
+
);
|
|
25963
|
+
}
|
|
25964
|
+
|
|
25978
25965
|
/**
|
|
25979
25966
|
* Get Trustee User
|
|
25980
25967
|
*
|
|
@@ -26090,6 +26077,26 @@ class OrganizationAuthorizationApi {
|
|
|
26090
26077
|
);
|
|
26091
26078
|
}
|
|
26092
26079
|
|
|
26080
|
+
/**
|
|
26081
|
+
* Get organization authorization trust with Customer Care, if one exists.
|
|
26082
|
+
*
|
|
26083
|
+
*/
|
|
26084
|
+
getOrgauthorizationTrusteesDefault() {
|
|
26085
|
+
|
|
26086
|
+
return this.apiClient.callApi(
|
|
26087
|
+
'/api/v2/orgauthorization/trustees/default',
|
|
26088
|
+
'GET',
|
|
26089
|
+
{ },
|
|
26090
|
+
{ },
|
|
26091
|
+
{ },
|
|
26092
|
+
{ },
|
|
26093
|
+
null,
|
|
26094
|
+
['PureCloud OAuth'],
|
|
26095
|
+
['application/json'],
|
|
26096
|
+
['application/json']
|
|
26097
|
+
);
|
|
26098
|
+
}
|
|
26099
|
+
|
|
26093
26100
|
/**
|
|
26094
26101
|
* Get Org Trust
|
|
26095
26102
|
*
|
|
@@ -26115,6 +26122,61 @@ class OrganizationAuthorizationApi {
|
|
|
26115
26122
|
);
|
|
26116
26123
|
}
|
|
26117
26124
|
|
|
26125
|
+
/**
|
|
26126
|
+
* Get Cloned User
|
|
26127
|
+
*
|
|
26128
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
26129
|
+
* @param {String} trusteeUserId Trustee User Id
|
|
26130
|
+
*/
|
|
26131
|
+
getOrgauthorizationTrustorCloneduser(trustorOrgId, trusteeUserId) {
|
|
26132
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
26133
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
26134
|
+
throw 'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustorCloneduser';
|
|
26135
|
+
}
|
|
26136
|
+
// verify the required parameter 'trusteeUserId' is set
|
|
26137
|
+
if (trusteeUserId === undefined || trusteeUserId === null) {
|
|
26138
|
+
throw 'Missing the required parameter "trusteeUserId" when calling getOrgauthorizationTrustorCloneduser';
|
|
26139
|
+
}
|
|
26140
|
+
|
|
26141
|
+
return this.apiClient.callApi(
|
|
26142
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}',
|
|
26143
|
+
'GET',
|
|
26144
|
+
{ 'trustorOrgId': trustorOrgId,'trusteeUserId': trusteeUserId },
|
|
26145
|
+
{ },
|
|
26146
|
+
{ },
|
|
26147
|
+
{ },
|
|
26148
|
+
null,
|
|
26149
|
+
['PureCloud OAuth'],
|
|
26150
|
+
['application/json'],
|
|
26151
|
+
['application/json']
|
|
26152
|
+
);
|
|
26153
|
+
}
|
|
26154
|
+
|
|
26155
|
+
/**
|
|
26156
|
+
* The list of cloned users in the trustor organization (i.e. users with a native user record).
|
|
26157
|
+
*
|
|
26158
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
26159
|
+
*/
|
|
26160
|
+
getOrgauthorizationTrustorClonedusers(trustorOrgId) {
|
|
26161
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
26162
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
26163
|
+
throw 'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustorClonedusers';
|
|
26164
|
+
}
|
|
26165
|
+
|
|
26166
|
+
return this.apiClient.callApi(
|
|
26167
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers',
|
|
26168
|
+
'GET',
|
|
26169
|
+
{ 'trustorOrgId': trustorOrgId },
|
|
26170
|
+
{ },
|
|
26171
|
+
{ },
|
|
26172
|
+
{ },
|
|
26173
|
+
null,
|
|
26174
|
+
['PureCloud OAuth'],
|
|
26175
|
+
['application/json'],
|
|
26176
|
+
['application/json']
|
|
26177
|
+
);
|
|
26178
|
+
}
|
|
26179
|
+
|
|
26118
26180
|
/**
|
|
26119
26181
|
* Get Trustee User
|
|
26120
26182
|
*
|
|
@@ -26312,6 +26374,31 @@ class OrganizationAuthorizationApi {
|
|
|
26312
26374
|
);
|
|
26313
26375
|
}
|
|
26314
26376
|
|
|
26377
|
+
/**
|
|
26378
|
+
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
26379
|
+
*
|
|
26380
|
+
* @param {Object} opts Optional parameters
|
|
26381
|
+
* @param {Boolean} opts.assignDefaultRole Assign Admin role to default pairing with Customer Care
|
|
26382
|
+
* @param {Boolean} opts.autoExpire Automatically expire pairing after 30 days
|
|
26383
|
+
*/
|
|
26384
|
+
postOrgauthorizationTrusteesDefault(opts) {
|
|
26385
|
+
opts = opts || {};
|
|
26386
|
+
|
|
26387
|
+
|
|
26388
|
+
return this.apiClient.callApi(
|
|
26389
|
+
'/api/v2/orgauthorization/trustees/default',
|
|
26390
|
+
'POST',
|
|
26391
|
+
{ },
|
|
26392
|
+
{ 'assignDefaultRole': opts['assignDefaultRole'],'autoExpire': opts['autoExpire'] },
|
|
26393
|
+
{ },
|
|
26394
|
+
{ },
|
|
26395
|
+
null,
|
|
26396
|
+
['PureCloud OAuth'],
|
|
26397
|
+
['application/json'],
|
|
26398
|
+
['application/json']
|
|
26399
|
+
);
|
|
26400
|
+
}
|
|
26401
|
+
|
|
26315
26402
|
/**
|
|
26316
26403
|
* Get Org Trustor Audits
|
|
26317
26404
|
*
|
|
@@ -26444,6 +26531,36 @@ class OrganizationAuthorizationApi {
|
|
|
26444
26531
|
);
|
|
26445
26532
|
}
|
|
26446
26533
|
|
|
26534
|
+
/**
|
|
26535
|
+
* Creates a clone of the trustee user in the trustor org.
|
|
26536
|
+
*
|
|
26537
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
26538
|
+
* @param {String} trusteeUserId Trustee User Id
|
|
26539
|
+
*/
|
|
26540
|
+
putOrgauthorizationTrustorCloneduser(trustorOrgId, trusteeUserId) {
|
|
26541
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
26542
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
26543
|
+
throw 'Missing the required parameter "trustorOrgId" when calling putOrgauthorizationTrustorCloneduser';
|
|
26544
|
+
}
|
|
26545
|
+
// verify the required parameter 'trusteeUserId' is set
|
|
26546
|
+
if (trusteeUserId === undefined || trusteeUserId === null) {
|
|
26547
|
+
throw 'Missing the required parameter "trusteeUserId" when calling putOrgauthorizationTrustorCloneduser';
|
|
26548
|
+
}
|
|
26549
|
+
|
|
26550
|
+
return this.apiClient.callApi(
|
|
26551
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}',
|
|
26552
|
+
'PUT',
|
|
26553
|
+
{ 'trustorOrgId': trustorOrgId,'trusteeUserId': trusteeUserId },
|
|
26554
|
+
{ },
|
|
26555
|
+
{ },
|
|
26556
|
+
{ },
|
|
26557
|
+
null,
|
|
26558
|
+
['PureCloud OAuth'],
|
|
26559
|
+
['application/json'],
|
|
26560
|
+
['application/json']
|
|
26561
|
+
);
|
|
26562
|
+
}
|
|
26563
|
+
|
|
26447
26564
|
/**
|
|
26448
26565
|
* Add a Trustee user to the trust.
|
|
26449
26566
|
*
|
|
@@ -26480,7 +26597,7 @@ class OutboundApi {
|
|
|
26480
26597
|
/**
|
|
26481
26598
|
* Outbound service.
|
|
26482
26599
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
26483
|
-
* @version
|
|
26600
|
+
* @version 126.0.0
|
|
26484
26601
|
*/
|
|
26485
26602
|
|
|
26486
26603
|
/**
|
|
@@ -29506,7 +29623,7 @@ class PresenceApi {
|
|
|
29506
29623
|
/**
|
|
29507
29624
|
* Presence service.
|
|
29508
29625
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
29509
|
-
* @version
|
|
29626
|
+
* @version 126.0.0
|
|
29510
29627
|
*/
|
|
29511
29628
|
|
|
29512
29629
|
/**
|
|
@@ -29878,7 +29995,7 @@ class QualityApi {
|
|
|
29878
29995
|
/**
|
|
29879
29996
|
* Quality service.
|
|
29880
29997
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
29881
|
-
* @version
|
|
29998
|
+
* @version 126.0.0
|
|
29882
29999
|
*/
|
|
29883
30000
|
|
|
29884
30001
|
/**
|
|
@@ -30251,7 +30368,7 @@ class QualityApi {
|
|
|
30251
30368
|
|
|
30252
30369
|
/**
|
|
30253
30370
|
* Queries Evaluations and returns a paged list
|
|
30254
|
-
* Query params must include one of conversationId, evaluatorUserId, or agentUserId
|
|
30371
|
+
* Query params must include one of conversationId, evaluatorUserId, or agentUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to 'Never Release' are omitted in this case. When querying by evaluatorUserId or conversationId (including when combined with agentUserId), the results are sorted by assigned date.
|
|
30255
30372
|
* @param {Object} opts Optional parameters
|
|
30256
30373
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
30257
30374
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -31406,7 +31523,7 @@ class RecordingApi {
|
|
|
31406
31523
|
/**
|
|
31407
31524
|
* Recording service.
|
|
31408
31525
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
31409
|
-
* @version
|
|
31526
|
+
* @version 126.0.0
|
|
31410
31527
|
*/
|
|
31411
31528
|
|
|
31412
31529
|
/**
|
|
@@ -32925,7 +33042,7 @@ class ResponseManagementApi {
|
|
|
32925
33042
|
/**
|
|
32926
33043
|
* ResponseManagement service.
|
|
32927
33044
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
32928
|
-
* @version
|
|
33045
|
+
* @version 126.0.0
|
|
32929
33046
|
*/
|
|
32930
33047
|
|
|
32931
33048
|
/**
|
|
@@ -33250,7 +33367,7 @@ class RoutingApi {
|
|
|
33250
33367
|
/**
|
|
33251
33368
|
* Routing service.
|
|
33252
33369
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
33253
|
-
* @version
|
|
33370
|
+
* @version 126.0.0
|
|
33254
33371
|
*/
|
|
33255
33372
|
|
|
33256
33373
|
/**
|
|
@@ -34406,12 +34523,11 @@ class RoutingApi {
|
|
|
34406
34523
|
}
|
|
34407
34524
|
|
|
34408
34525
|
/**
|
|
34409
|
-
* Get a paged listing of simplified queue objects. Can be used to get a digest of all queues in an organization.
|
|
34526
|
+
* Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization.
|
|
34410
34527
|
*
|
|
34411
34528
|
* @param {Object} opts Optional parameters
|
|
34412
34529
|
* @param {Number} opts.pageSize Page size [max value is 500] (default to 25)
|
|
34413
34530
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
34414
|
-
* @param {Object} opts.sortBy Sort by (default to name)
|
|
34415
34531
|
* @param {Object} opts.sortOrder Sort order (default to asc)
|
|
34416
34532
|
*/
|
|
34417
34533
|
getRoutingQueuesDivisionviewsAll(opts) {
|
|
@@ -34422,7 +34538,7 @@ class RoutingApi {
|
|
|
34422
34538
|
'/api/v2/routing/queues/divisionviews/all',
|
|
34423
34539
|
'GET',
|
|
34424
34540
|
{ },
|
|
34425
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'
|
|
34541
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'] },
|
|
34426
34542
|
{ },
|
|
34427
34543
|
{ },
|
|
34428
34544
|
null,
|
|
@@ -36170,7 +36286,7 @@ class SCIMApi {
|
|
|
36170
36286
|
/**
|
|
36171
36287
|
* SCIM service.
|
|
36172
36288
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
36173
|
-
* @version
|
|
36289
|
+
* @version 126.0.0
|
|
36174
36290
|
*/
|
|
36175
36291
|
|
|
36176
36292
|
/**
|
|
@@ -37047,7 +37163,7 @@ class ScriptsApi {
|
|
|
37047
37163
|
/**
|
|
37048
37164
|
* Scripts service.
|
|
37049
37165
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
37050
|
-
* @version
|
|
37166
|
+
* @version 126.0.0
|
|
37051
37167
|
*/
|
|
37052
37168
|
|
|
37053
37169
|
/**
|
|
@@ -37400,7 +37516,7 @@ class SearchApi {
|
|
|
37400
37516
|
/**
|
|
37401
37517
|
* Search service.
|
|
37402
37518
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
37403
|
-
* @version
|
|
37519
|
+
* @version 126.0.0
|
|
37404
37520
|
*/
|
|
37405
37521
|
|
|
37406
37522
|
/**
|
|
@@ -37935,7 +38051,7 @@ class SpeechTextAnalyticsApi {
|
|
|
37935
38051
|
/**
|
|
37936
38052
|
* SpeechTextAnalytics service.
|
|
37937
38053
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
37938
|
-
* @version
|
|
38054
|
+
* @version 126.0.0
|
|
37939
38055
|
*/
|
|
37940
38056
|
|
|
37941
38057
|
/**
|
|
@@ -38106,7 +38222,7 @@ class SpeechTextAnalyticsApi {
|
|
|
38106
38222
|
|
|
38107
38223
|
/**
|
|
38108
38224
|
* Get list of supported Speech & Text Analytics dialects
|
|
38109
|
-
*
|
|
38225
|
+
* This api has been deprecated. Use api/v2/topics/dialects instead
|
|
38110
38226
|
*/
|
|
38111
38227
|
getSpeechandtextanalyticsDialects() {
|
|
38112
38228
|
|
|
@@ -38788,7 +38904,7 @@ class StationsApi {
|
|
|
38788
38904
|
/**
|
|
38789
38905
|
* Stations service.
|
|
38790
38906
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
38791
|
-
* @version
|
|
38907
|
+
* @version 126.0.0
|
|
38792
38908
|
*/
|
|
38793
38909
|
|
|
38794
38910
|
/**
|
|
@@ -38935,7 +39051,7 @@ class SuggestApi {
|
|
|
38935
39051
|
/**
|
|
38936
39052
|
* Suggest service.
|
|
38937
39053
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
38938
|
-
* @version
|
|
39054
|
+
* @version 126.0.0
|
|
38939
39055
|
*/
|
|
38940
39056
|
|
|
38941
39057
|
/**
|
|
@@ -39074,7 +39190,7 @@ class TelephonyApi {
|
|
|
39074
39190
|
/**
|
|
39075
39191
|
* Telephony service.
|
|
39076
39192
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
39077
|
-
* @version
|
|
39193
|
+
* @version 126.0.0
|
|
39078
39194
|
*/
|
|
39079
39195
|
|
|
39080
39196
|
/**
|
|
@@ -39182,7 +39298,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
39182
39298
|
/**
|
|
39183
39299
|
* TelephonyProvidersEdge service.
|
|
39184
39300
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
39185
|
-
* @version
|
|
39301
|
+
* @version 126.0.0
|
|
39186
39302
|
*/
|
|
39187
39303
|
|
|
39188
39304
|
/**
|
|
@@ -42795,7 +42911,7 @@ class TextbotsApi {
|
|
|
42795
42911
|
/**
|
|
42796
42912
|
* Textbots service.
|
|
42797
42913
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
42798
|
-
* @version
|
|
42914
|
+
* @version 126.0.0
|
|
42799
42915
|
*/
|
|
42800
42916
|
|
|
42801
42917
|
/**
|
|
@@ -42896,7 +43012,7 @@ class TokensApi {
|
|
|
42896
43012
|
/**
|
|
42897
43013
|
* Tokens service.
|
|
42898
43014
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
42899
|
-
* @version
|
|
43015
|
+
* @version 126.0.0
|
|
42900
43016
|
*/
|
|
42901
43017
|
|
|
42902
43018
|
/**
|
|
@@ -43002,7 +43118,7 @@ class UploadsApi {
|
|
|
43002
43118
|
/**
|
|
43003
43119
|
* Uploads service.
|
|
43004
43120
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
43005
|
-
* @version
|
|
43121
|
+
* @version 126.0.0
|
|
43006
43122
|
*/
|
|
43007
43123
|
|
|
43008
43124
|
/**
|
|
@@ -43178,7 +43294,7 @@ class UsageApi {
|
|
|
43178
43294
|
/**
|
|
43179
43295
|
* Usage service.
|
|
43180
43296
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
43181
|
-
* @version
|
|
43297
|
+
* @version 126.0.0
|
|
43182
43298
|
*/
|
|
43183
43299
|
|
|
43184
43300
|
/**
|
|
@@ -43249,7 +43365,7 @@ class UserRecordingsApi {
|
|
|
43249
43365
|
/**
|
|
43250
43366
|
* UserRecordings service.
|
|
43251
43367
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
43252
|
-
* @version
|
|
43368
|
+
* @version 126.0.0
|
|
43253
43369
|
*/
|
|
43254
43370
|
|
|
43255
43371
|
/**
|
|
@@ -43433,7 +43549,7 @@ class UsersApi {
|
|
|
43433
43549
|
/**
|
|
43434
43550
|
* Users service.
|
|
43435
43551
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
43436
|
-
* @version
|
|
43552
|
+
* @version 126.0.0
|
|
43437
43553
|
*/
|
|
43438
43554
|
|
|
43439
43555
|
/**
|
|
@@ -45735,7 +45851,7 @@ class UtilitiesApi {
|
|
|
45735
45851
|
/**
|
|
45736
45852
|
* Utilities service.
|
|
45737
45853
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
45738
|
-
* @version
|
|
45854
|
+
* @version 126.0.0
|
|
45739
45855
|
*/
|
|
45740
45856
|
|
|
45741
45857
|
/**
|
|
@@ -45846,7 +45962,7 @@ class VoicemailApi {
|
|
|
45846
45962
|
/**
|
|
45847
45963
|
* Voicemail service.
|
|
45848
45964
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
45849
|
-
* @version
|
|
45965
|
+
* @version 126.0.0
|
|
45850
45966
|
*/
|
|
45851
45967
|
|
|
45852
45968
|
/**
|
|
@@ -46513,7 +46629,7 @@ class WebChatApi {
|
|
|
46513
46629
|
/**
|
|
46514
46630
|
* WebChat service.
|
|
46515
46631
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
46516
|
-
* @version
|
|
46632
|
+
* @version 126.0.0
|
|
46517
46633
|
*/
|
|
46518
46634
|
|
|
46519
46635
|
/**
|
|
@@ -47057,7 +47173,7 @@ class WebDeploymentsApi {
|
|
|
47057
47173
|
/**
|
|
47058
47174
|
* WebDeployments service.
|
|
47059
47175
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
47060
|
-
* @version
|
|
47176
|
+
* @version 126.0.0
|
|
47061
47177
|
*/
|
|
47062
47178
|
|
|
47063
47179
|
/**
|
|
@@ -47412,7 +47528,7 @@ class WebMessagingApi {
|
|
|
47412
47528
|
/**
|
|
47413
47529
|
* WebMessaging service.
|
|
47414
47530
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
47415
|
-
* @version
|
|
47531
|
+
* @version 126.0.0
|
|
47416
47532
|
*/
|
|
47417
47533
|
|
|
47418
47534
|
/**
|
|
@@ -47458,7 +47574,7 @@ class WidgetsApi {
|
|
|
47458
47574
|
/**
|
|
47459
47575
|
* Widgets service.
|
|
47460
47576
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
47461
|
-
* @version
|
|
47577
|
+
* @version 126.0.0
|
|
47462
47578
|
*/
|
|
47463
47579
|
|
|
47464
47580
|
/**
|
|
@@ -47604,7 +47720,7 @@ class WorkforceManagementApi {
|
|
|
47604
47720
|
/**
|
|
47605
47721
|
* WorkforceManagement service.
|
|
47606
47722
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
47607
|
-
* @version
|
|
47723
|
+
* @version 126.0.0
|
|
47608
47724
|
*/
|
|
47609
47725
|
|
|
47610
47726
|
/**
|
|
@@ -47879,6 +47995,66 @@ class WorkforceManagementApi {
|
|
|
47879
47995
|
);
|
|
47880
47996
|
}
|
|
47881
47997
|
|
|
47998
|
+
/**
|
|
47999
|
+
* Deletes a time off limit object
|
|
48000
|
+
*
|
|
48001
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
48002
|
+
* @param {String} timeOffLimitId The ID of the time off limit object to delete
|
|
48003
|
+
*/
|
|
48004
|
+
deleteWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
48005
|
+
// verify the required parameter 'managementUnitId' is set
|
|
48006
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
48007
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitTimeofflimit';
|
|
48008
|
+
}
|
|
48009
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
48010
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
48011
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling deleteWorkforcemanagementManagementunitTimeofflimit';
|
|
48012
|
+
}
|
|
48013
|
+
|
|
48014
|
+
return this.apiClient.callApi(
|
|
48015
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
48016
|
+
'DELETE',
|
|
48017
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
48018
|
+
{ },
|
|
48019
|
+
{ },
|
|
48020
|
+
{ },
|
|
48021
|
+
null,
|
|
48022
|
+
['PureCloud OAuth'],
|
|
48023
|
+
['application/json'],
|
|
48024
|
+
['application/json']
|
|
48025
|
+
);
|
|
48026
|
+
}
|
|
48027
|
+
|
|
48028
|
+
/**
|
|
48029
|
+
* Deletes a time off plan
|
|
48030
|
+
*
|
|
48031
|
+
* @param {String} managementUnitId The management unit ID.
|
|
48032
|
+
* @param {String} timeOffPlanId The ID of the time off plan to delete
|
|
48033
|
+
*/
|
|
48034
|
+
deleteWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
48035
|
+
// verify the required parameter 'managementUnitId' is set
|
|
48036
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
48037
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitTimeoffplan';
|
|
48038
|
+
}
|
|
48039
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
48040
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
48041
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling deleteWorkforcemanagementManagementunitTimeoffplan';
|
|
48042
|
+
}
|
|
48043
|
+
|
|
48044
|
+
return this.apiClient.callApi(
|
|
48045
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
48046
|
+
'DELETE',
|
|
48047
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
48048
|
+
{ },
|
|
48049
|
+
{ },
|
|
48050
|
+
{ },
|
|
48051
|
+
null,
|
|
48052
|
+
['PureCloud OAuth'],
|
|
48053
|
+
['application/json'],
|
|
48054
|
+
['application/json']
|
|
48055
|
+
);
|
|
48056
|
+
}
|
|
48057
|
+
|
|
47882
48058
|
/**
|
|
47883
48059
|
* Delete a work plan
|
|
47884
48060
|
*
|
|
@@ -49120,6 +49296,116 @@ class WorkforceManagementApi {
|
|
|
49120
49296
|
);
|
|
49121
49297
|
}
|
|
49122
49298
|
|
|
49299
|
+
/**
|
|
49300
|
+
* Gets a time off limit object
|
|
49301
|
+
* Returns properties of time off limit object, but not daily values.
|
|
49302
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
49303
|
+
* @param {String} timeOffLimitId The ID of the time off limit to fetch
|
|
49304
|
+
*/
|
|
49305
|
+
getWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
49306
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49307
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49308
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeofflimit';
|
|
49309
|
+
}
|
|
49310
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
49311
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
49312
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling getWorkforcemanagementManagementunitTimeofflimit';
|
|
49313
|
+
}
|
|
49314
|
+
|
|
49315
|
+
return this.apiClient.callApi(
|
|
49316
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
49317
|
+
'GET',
|
|
49318
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
49319
|
+
{ },
|
|
49320
|
+
{ },
|
|
49321
|
+
{ },
|
|
49322
|
+
null,
|
|
49323
|
+
['PureCloud OAuth'],
|
|
49324
|
+
['application/json'],
|
|
49325
|
+
['application/json']
|
|
49326
|
+
);
|
|
49327
|
+
}
|
|
49328
|
+
|
|
49329
|
+
/**
|
|
49330
|
+
* Gets a list of time off limit objects under management unit.
|
|
49331
|
+
* Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.
|
|
49332
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
49333
|
+
*/
|
|
49334
|
+
getWorkforcemanagementManagementunitTimeofflimits(managementUnitId) {
|
|
49335
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49336
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49337
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeofflimits';
|
|
49338
|
+
}
|
|
49339
|
+
|
|
49340
|
+
return this.apiClient.callApi(
|
|
49341
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits',
|
|
49342
|
+
'GET',
|
|
49343
|
+
{ 'managementUnitId': managementUnitId },
|
|
49344
|
+
{ },
|
|
49345
|
+
{ },
|
|
49346
|
+
{ },
|
|
49347
|
+
null,
|
|
49348
|
+
['PureCloud OAuth'],
|
|
49349
|
+
['application/json'],
|
|
49350
|
+
['application/json']
|
|
49351
|
+
);
|
|
49352
|
+
}
|
|
49353
|
+
|
|
49354
|
+
/**
|
|
49355
|
+
* Gets a time off plan
|
|
49356
|
+
*
|
|
49357
|
+
* @param {String} managementUnitId The management unit ID.
|
|
49358
|
+
* @param {String} timeOffPlanId The ID of the time off plan to fetch
|
|
49359
|
+
*/
|
|
49360
|
+
getWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
49361
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49362
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49363
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeoffplan';
|
|
49364
|
+
}
|
|
49365
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
49366
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
49367
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling getWorkforcemanagementManagementunitTimeoffplan';
|
|
49368
|
+
}
|
|
49369
|
+
|
|
49370
|
+
return this.apiClient.callApi(
|
|
49371
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
49372
|
+
'GET',
|
|
49373
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
49374
|
+
{ },
|
|
49375
|
+
{ },
|
|
49376
|
+
{ },
|
|
49377
|
+
null,
|
|
49378
|
+
['PureCloud OAuth'],
|
|
49379
|
+
['application/json'],
|
|
49380
|
+
['application/json']
|
|
49381
|
+
);
|
|
49382
|
+
}
|
|
49383
|
+
|
|
49384
|
+
/**
|
|
49385
|
+
* Gets a list of time off plans
|
|
49386
|
+
*
|
|
49387
|
+
* @param {String} managementUnitId The management unit ID.
|
|
49388
|
+
*/
|
|
49389
|
+
getWorkforcemanagementManagementunitTimeoffplans(managementUnitId) {
|
|
49390
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49391
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49392
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeoffplans';
|
|
49393
|
+
}
|
|
49394
|
+
|
|
49395
|
+
return this.apiClient.callApi(
|
|
49396
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans',
|
|
49397
|
+
'GET',
|
|
49398
|
+
{ 'managementUnitId': managementUnitId },
|
|
49399
|
+
{ },
|
|
49400
|
+
{ },
|
|
49401
|
+
{ },
|
|
49402
|
+
null,
|
|
49403
|
+
['PureCloud OAuth'],
|
|
49404
|
+
['application/json'],
|
|
49405
|
+
['application/json']
|
|
49406
|
+
);
|
|
49407
|
+
}
|
|
49408
|
+
|
|
49123
49409
|
/**
|
|
49124
49410
|
* Get a time off request
|
|
49125
49411
|
*
|
|
@@ -49155,6 +49441,41 @@ class WorkforceManagementApi {
|
|
|
49155
49441
|
);
|
|
49156
49442
|
}
|
|
49157
49443
|
|
|
49444
|
+
/**
|
|
49445
|
+
* Retrieves time off limit, allocated and waitlisted values according to specific time off request
|
|
49446
|
+
*
|
|
49447
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
49448
|
+
* @param {String} userId The userId to whom the time off request applies.
|
|
49449
|
+
* @param {String} timeOffRequestId The ID of the time off request, which dates and activityCodeId determine limit values to retrieve
|
|
49450
|
+
*/
|
|
49451
|
+
getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits(managementUnitId, userId, timeOffRequestId) {
|
|
49452
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49453
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49454
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
49455
|
+
}
|
|
49456
|
+
// verify the required parameter 'userId' is set
|
|
49457
|
+
if (userId === undefined || userId === null) {
|
|
49458
|
+
throw 'Missing the required parameter "userId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
49459
|
+
}
|
|
49460
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
49461
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
49462
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
49463
|
+
}
|
|
49464
|
+
|
|
49465
|
+
return this.apiClient.callApi(
|
|
49466
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeofflimits',
|
|
49467
|
+
'GET',
|
|
49468
|
+
{ 'managementUnitId': managementUnitId,'userId': userId,'timeOffRequestId': timeOffRequestId },
|
|
49469
|
+
{ },
|
|
49470
|
+
{ },
|
|
49471
|
+
{ },
|
|
49472
|
+
null,
|
|
49473
|
+
['PureCloud OAuth'],
|
|
49474
|
+
['application/json'],
|
|
49475
|
+
['application/json']
|
|
49476
|
+
);
|
|
49477
|
+
}
|
|
49478
|
+
|
|
49158
49479
|
/**
|
|
49159
49480
|
* Get a list of time off requests for a given user
|
|
49160
49481
|
*
|
|
@@ -49588,6 +49909,31 @@ class WorkforceManagementApi {
|
|
|
49588
49909
|
);
|
|
49589
49910
|
}
|
|
49590
49911
|
|
|
49912
|
+
/**
|
|
49913
|
+
* Get the daily waitlist positions of a time off request for the current user
|
|
49914
|
+
*
|
|
49915
|
+
* @param {String} timeOffRequestId Time Off Request Id
|
|
49916
|
+
*/
|
|
49917
|
+
getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId) {
|
|
49918
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
49919
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
49920
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementTimeoffrequestWaitlistpositions';
|
|
49921
|
+
}
|
|
49922
|
+
|
|
49923
|
+
return this.apiClient.callApi(
|
|
49924
|
+
'/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}/waitlistpositions',
|
|
49925
|
+
'GET',
|
|
49926
|
+
{ 'timeOffRequestId': timeOffRequestId },
|
|
49927
|
+
{ },
|
|
49928
|
+
{ },
|
|
49929
|
+
{ },
|
|
49930
|
+
null,
|
|
49931
|
+
['PureCloud OAuth'],
|
|
49932
|
+
['application/json'],
|
|
49933
|
+
['application/json']
|
|
49934
|
+
);
|
|
49935
|
+
}
|
|
49936
|
+
|
|
49591
49937
|
/**
|
|
49592
49938
|
* Get a list of time off requests for the current user
|
|
49593
49939
|
*
|
|
@@ -49806,6 +50152,74 @@ class WorkforceManagementApi {
|
|
|
49806
50152
|
);
|
|
49807
50153
|
}
|
|
49808
50154
|
|
|
50155
|
+
/**
|
|
50156
|
+
* Updates a time off limit object.
|
|
50157
|
+
* Updates time off limit object properties, but not daily values.
|
|
50158
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
50159
|
+
* @param {String} timeOffLimitId The id of time off limit object to update
|
|
50160
|
+
* @param {Object} opts Optional parameters
|
|
50161
|
+
* @param {Object} opts.body body
|
|
50162
|
+
*/
|
|
50163
|
+
patchWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId, opts) {
|
|
50164
|
+
opts = opts || {};
|
|
50165
|
+
|
|
50166
|
+
// verify the required parameter 'managementUnitId' is set
|
|
50167
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
50168
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
50169
|
+
}
|
|
50170
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
50171
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
50172
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
50173
|
+
}
|
|
50174
|
+
|
|
50175
|
+
return this.apiClient.callApi(
|
|
50176
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
50177
|
+
'PATCH',
|
|
50178
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
50179
|
+
{ },
|
|
50180
|
+
{ },
|
|
50181
|
+
{ },
|
|
50182
|
+
opts['body'],
|
|
50183
|
+
['PureCloud OAuth'],
|
|
50184
|
+
['application/json'],
|
|
50185
|
+
['application/json']
|
|
50186
|
+
);
|
|
50187
|
+
}
|
|
50188
|
+
|
|
50189
|
+
/**
|
|
50190
|
+
* Updates a time off plan
|
|
50191
|
+
*
|
|
50192
|
+
* @param {String} managementUnitId The management unit ID.
|
|
50193
|
+
* @param {String} timeOffPlanId The ID of the time off plan to update
|
|
50194
|
+
* @param {Object} opts Optional parameters
|
|
50195
|
+
* @param {Object} opts.body body
|
|
50196
|
+
*/
|
|
50197
|
+
patchWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId, opts) {
|
|
50198
|
+
opts = opts || {};
|
|
50199
|
+
|
|
50200
|
+
// verify the required parameter 'managementUnitId' is set
|
|
50201
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
50202
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
50203
|
+
}
|
|
50204
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
50205
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
50206
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
50207
|
+
}
|
|
50208
|
+
|
|
50209
|
+
return this.apiClient.callApi(
|
|
50210
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
50211
|
+
'PATCH',
|
|
50212
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
50213
|
+
{ },
|
|
50214
|
+
{ },
|
|
50215
|
+
{ },
|
|
50216
|
+
opts['body'],
|
|
50217
|
+
['PureCloud OAuth'],
|
|
50218
|
+
['application/json'],
|
|
50219
|
+
['application/json']
|
|
50220
|
+
);
|
|
50221
|
+
}
|
|
50222
|
+
|
|
49809
50223
|
/**
|
|
49810
50224
|
* Update a time off request
|
|
49811
50225
|
*
|
|
@@ -50667,6 +51081,93 @@ class WorkforceManagementApi {
|
|
|
50667
51081
|
);
|
|
50668
51082
|
}
|
|
50669
51083
|
|
|
51084
|
+
/**
|
|
51085
|
+
* Creates a new time off limit object under management unit.
|
|
51086
|
+
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
51087
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51088
|
+
* @param {Object} opts Optional parameters
|
|
51089
|
+
* @param {Object} opts.body body
|
|
51090
|
+
*/
|
|
51091
|
+
postWorkforcemanagementManagementunitTimeofflimits(managementUnitId, opts) {
|
|
51092
|
+
opts = opts || {};
|
|
51093
|
+
|
|
51094
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51095
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51096
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimits';
|
|
51097
|
+
}
|
|
51098
|
+
|
|
51099
|
+
return this.apiClient.callApi(
|
|
51100
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits',
|
|
51101
|
+
'POST',
|
|
51102
|
+
{ 'managementUnitId': managementUnitId },
|
|
51103
|
+
{ },
|
|
51104
|
+
{ },
|
|
51105
|
+
{ },
|
|
51106
|
+
opts['body'],
|
|
51107
|
+
['PureCloud OAuth'],
|
|
51108
|
+
['application/json'],
|
|
51109
|
+
['application/json']
|
|
51110
|
+
);
|
|
51111
|
+
}
|
|
51112
|
+
|
|
51113
|
+
/**
|
|
51114
|
+
* Retrieves time off limit related values based on a given set of filters.
|
|
51115
|
+
*
|
|
51116
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51117
|
+
* @param {Object} opts Optional parameters
|
|
51118
|
+
* @param {Object} opts.body body
|
|
51119
|
+
*/
|
|
51120
|
+
postWorkforcemanagementManagementunitTimeofflimitsValuesQuery(managementUnitId, opts) {
|
|
51121
|
+
opts = opts || {};
|
|
51122
|
+
|
|
51123
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51124
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51125
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimitsValuesQuery';
|
|
51126
|
+
}
|
|
51127
|
+
|
|
51128
|
+
return this.apiClient.callApi(
|
|
51129
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/values/query',
|
|
51130
|
+
'POST',
|
|
51131
|
+
{ 'managementUnitId': managementUnitId },
|
|
51132
|
+
{ },
|
|
51133
|
+
{ },
|
|
51134
|
+
{ },
|
|
51135
|
+
opts['body'],
|
|
51136
|
+
['PureCloud OAuth'],
|
|
51137
|
+
['application/json'],
|
|
51138
|
+
['application/json']
|
|
51139
|
+
);
|
|
51140
|
+
}
|
|
51141
|
+
|
|
51142
|
+
/**
|
|
51143
|
+
* Creates a new time off plan
|
|
51144
|
+
*
|
|
51145
|
+
* @param {String} managementUnitId The management unit ID.
|
|
51146
|
+
* @param {Object} opts Optional parameters
|
|
51147
|
+
* @param {Object} opts.body body
|
|
51148
|
+
*/
|
|
51149
|
+
postWorkforcemanagementManagementunitTimeoffplans(managementUnitId, opts) {
|
|
51150
|
+
opts = opts || {};
|
|
51151
|
+
|
|
51152
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51153
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51154
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffplans';
|
|
51155
|
+
}
|
|
51156
|
+
|
|
51157
|
+
return this.apiClient.callApi(
|
|
51158
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans',
|
|
51159
|
+
'POST',
|
|
51160
|
+
{ 'managementUnitId': managementUnitId },
|
|
51161
|
+
{ },
|
|
51162
|
+
{ },
|
|
51163
|
+
{ },
|
|
51164
|
+
opts['body'],
|
|
51165
|
+
['PureCloud OAuth'],
|
|
51166
|
+
['application/json'],
|
|
51167
|
+
['application/json']
|
|
51168
|
+
);
|
|
51169
|
+
}
|
|
51170
|
+
|
|
50670
51171
|
/**
|
|
50671
51172
|
* Create a new time off request
|
|
50672
51173
|
*
|
|
@@ -50725,6 +51226,35 @@ class WorkforceManagementApi {
|
|
|
50725
51226
|
);
|
|
50726
51227
|
}
|
|
50727
51228
|
|
|
51229
|
+
/**
|
|
51230
|
+
* Retrieves daily waitlist position for a list of time off requests
|
|
51231
|
+
*
|
|
51232
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51233
|
+
* @param {Object} opts Optional parameters
|
|
51234
|
+
* @param {Object} opts.body body
|
|
51235
|
+
*/
|
|
51236
|
+
postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery(managementUnitId, opts) {
|
|
51237
|
+
opts = opts || {};
|
|
51238
|
+
|
|
51239
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51240
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51241
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery';
|
|
51242
|
+
}
|
|
51243
|
+
|
|
51244
|
+
return this.apiClient.callApi(
|
|
51245
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/waitlistpositions/query',
|
|
51246
|
+
'POST',
|
|
51247
|
+
{ 'managementUnitId': managementUnitId },
|
|
51248
|
+
{ },
|
|
51249
|
+
{ },
|
|
51250
|
+
{ },
|
|
51251
|
+
opts['body'],
|
|
51252
|
+
['PureCloud OAuth'],
|
|
51253
|
+
['application/json'],
|
|
51254
|
+
['application/json']
|
|
51255
|
+
);
|
|
51256
|
+
}
|
|
51257
|
+
|
|
50728
51258
|
/**
|
|
50729
51259
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
50730
51260
|
*
|
|
@@ -51108,6 +51638,30 @@ class WorkforceManagementApi {
|
|
|
51108
51638
|
);
|
|
51109
51639
|
}
|
|
51110
51640
|
|
|
51641
|
+
/**
|
|
51642
|
+
* Queries available time off for the current user
|
|
51643
|
+
*
|
|
51644
|
+
* @param {Object} opts Optional parameters
|
|
51645
|
+
* @param {Object} opts.body body
|
|
51646
|
+
*/
|
|
51647
|
+
postWorkforcemanagementTimeofflimitsAvailableQuery(opts) {
|
|
51648
|
+
opts = opts || {};
|
|
51649
|
+
|
|
51650
|
+
|
|
51651
|
+
return this.apiClient.callApi(
|
|
51652
|
+
'/api/v2/workforcemanagement/timeofflimits/available/query',
|
|
51653
|
+
'POST',
|
|
51654
|
+
{ },
|
|
51655
|
+
{ },
|
|
51656
|
+
{ },
|
|
51657
|
+
{ },
|
|
51658
|
+
opts['body'],
|
|
51659
|
+
['PureCloud OAuth'],
|
|
51660
|
+
['application/json'],
|
|
51661
|
+
['application/json']
|
|
51662
|
+
);
|
|
51663
|
+
}
|
|
51664
|
+
|
|
51111
51665
|
/**
|
|
51112
51666
|
* Create a time off request for the current user
|
|
51113
51667
|
*
|
|
@@ -51132,6 +51686,40 @@ class WorkforceManagementApi {
|
|
|
51132
51686
|
);
|
|
51133
51687
|
}
|
|
51134
51688
|
|
|
51689
|
+
/**
|
|
51690
|
+
* Sets daily values for a date range of time off limit object
|
|
51691
|
+
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
51692
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51693
|
+
* @param {String} timeOffLimitId The ID of the time off limit object to set values for
|
|
51694
|
+
* @param {Object} opts Optional parameters
|
|
51695
|
+
* @param {Object} opts.body body
|
|
51696
|
+
*/
|
|
51697
|
+
putWorkforcemanagementManagementunitTimeofflimitValues(managementUnitId, timeOffLimitId, opts) {
|
|
51698
|
+
opts = opts || {};
|
|
51699
|
+
|
|
51700
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51701
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51702
|
+
throw 'Missing the required parameter "managementUnitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
51703
|
+
}
|
|
51704
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
51705
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
51706
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
51707
|
+
}
|
|
51708
|
+
|
|
51709
|
+
return this.apiClient.callApi(
|
|
51710
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}/values',
|
|
51711
|
+
'PUT',
|
|
51712
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
51713
|
+
{ },
|
|
51714
|
+
{ },
|
|
51715
|
+
{ },
|
|
51716
|
+
opts['body'],
|
|
51717
|
+
['PureCloud OAuth'],
|
|
51718
|
+
['application/json'],
|
|
51719
|
+
['application/json']
|
|
51720
|
+
);
|
|
51721
|
+
}
|
|
51722
|
+
|
|
51135
51723
|
}
|
|
51136
51724
|
|
|
51137
51725
|
/**
|
|
@@ -51163,7 +51751,7 @@ class WorkforceManagementApi {
|
|
|
51163
51751
|
* </pre>
|
|
51164
51752
|
* </p>
|
|
51165
51753
|
* @module purecloud-platform-client-v2/index
|
|
51166
|
-
* @version
|
|
51754
|
+
* @version 126.0.0
|
|
51167
51755
|
*/
|
|
51168
51756
|
class platformClient {
|
|
51169
51757
|
constructor() {
|