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
|
@@ -391,7 +391,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
391
391
|
|
|
392
392
|
/**
|
|
393
393
|
* @module purecloud-platform-client-v2/ApiClient
|
|
394
|
-
* @version
|
|
394
|
+
* @version 126.0.0
|
|
395
395
|
*/
|
|
396
396
|
class ApiClient {
|
|
397
397
|
/**
|
|
@@ -1338,7 +1338,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1338
1338
|
|
|
1339
1339
|
// set header parameters
|
|
1340
1340
|
request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
|
|
1341
|
-
//request.set({ 'purecloud-sdk': '
|
|
1341
|
+
//request.set({ 'purecloud-sdk': '126.0.0' });
|
|
1342
1342
|
|
|
1343
1343
|
// set request timeout
|
|
1344
1344
|
request.timeout(that.timeout);
|
|
@@ -1438,7 +1438,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1438
1438
|
/**
|
|
1439
1439
|
* Alerting service.
|
|
1440
1440
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1441
|
-
* @version
|
|
1441
|
+
* @version 126.0.0
|
|
1442
1442
|
*/
|
|
1443
1443
|
|
|
1444
1444
|
/**
|
|
@@ -1752,7 +1752,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1752
1752
|
/**
|
|
1753
1753
|
* Analytics service.
|
|
1754
1754
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1755
|
-
* @version
|
|
1755
|
+
* @version 126.0.0
|
|
1756
1756
|
*/
|
|
1757
1757
|
|
|
1758
1758
|
/**
|
|
@@ -2348,31 +2348,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2348
2348
|
);
|
|
2349
2349
|
}
|
|
2350
2350
|
|
|
2351
|
-
/**
|
|
2352
|
-
* Patch AnalyticsReportingSettings values for an organization
|
|
2353
|
-
*
|
|
2354
|
-
* @param {Object} body AnalyticsReportingSettingsRequest
|
|
2355
|
-
*/
|
|
2356
|
-
patchAnalyticsReportingSettings(body) {
|
|
2357
|
-
// verify the required parameter 'body' is set
|
|
2358
|
-
if (body === undefined || body === null) {
|
|
2359
|
-
throw 'Missing the required parameter "body" when calling patchAnalyticsReportingSettings';
|
|
2360
|
-
}
|
|
2361
|
-
|
|
2362
|
-
return this.apiClient.callApi(
|
|
2363
|
-
'/api/v2/analytics/reporting/settings',
|
|
2364
|
-
'PATCH',
|
|
2365
|
-
{ },
|
|
2366
|
-
{ },
|
|
2367
|
-
{ },
|
|
2368
|
-
{ },
|
|
2369
|
-
body,
|
|
2370
|
-
['PureCloud OAuth'],
|
|
2371
|
-
['application/json'],
|
|
2372
|
-
['application/json']
|
|
2373
|
-
);
|
|
2374
|
-
}
|
|
2375
|
-
|
|
2376
2351
|
/**
|
|
2377
2352
|
* Query for bot aggregates
|
|
2378
2353
|
*
|
|
@@ -2914,7 +2889,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2914
2889
|
/**
|
|
2915
2890
|
* Architect service.
|
|
2916
2891
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2917
|
-
* @version
|
|
2892
|
+
* @version 126.0.0
|
|
2918
2893
|
*/
|
|
2919
2894
|
|
|
2920
2895
|
/**
|
|
@@ -5910,7 +5885,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5910
5885
|
/**
|
|
5911
5886
|
* Audit service.
|
|
5912
5887
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
5913
|
-
* @version
|
|
5888
|
+
* @version 126.0.0
|
|
5914
5889
|
*/
|
|
5915
5890
|
|
|
5916
5891
|
/**
|
|
@@ -6081,7 +6056,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6081
6056
|
/**
|
|
6082
6057
|
* Authorization service.
|
|
6083
6058
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6084
|
-
* @version
|
|
6059
|
+
* @version 126.0.0
|
|
6085
6060
|
*/
|
|
6086
6061
|
|
|
6087
6062
|
/**
|
|
@@ -7264,7 +7239,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7264
7239
|
/**
|
|
7265
7240
|
* Billing service.
|
|
7266
7241
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7267
|
-
* @version
|
|
7242
|
+
* @version 126.0.0
|
|
7268
7243
|
*/
|
|
7269
7244
|
|
|
7270
7245
|
/**
|
|
@@ -7344,7 +7319,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7344
7319
|
/**
|
|
7345
7320
|
* Chat service.
|
|
7346
7321
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7347
|
-
* @version
|
|
7322
|
+
* @version 126.0.0
|
|
7348
7323
|
*/
|
|
7349
7324
|
|
|
7350
7325
|
/**
|
|
@@ -7435,7 +7410,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7435
7410
|
/**
|
|
7436
7411
|
* Coaching service.
|
|
7437
7412
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7438
|
-
* @version
|
|
7413
|
+
* @version 126.0.0
|
|
7439
7414
|
*/
|
|
7440
7415
|
|
|
7441
7416
|
/**
|
|
@@ -8010,7 +7985,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8010
7985
|
/**
|
|
8011
7986
|
* ContentManagement service.
|
|
8012
7987
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8013
|
-
* @version
|
|
7988
|
+
* @version 126.0.0
|
|
8014
7989
|
*/
|
|
8015
7990
|
|
|
8016
7991
|
/**
|
|
@@ -9150,7 +9125,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9150
9125
|
/**
|
|
9151
9126
|
* Conversations service.
|
|
9152
9127
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9153
|
-
* @version
|
|
9128
|
+
* @version 126.0.0
|
|
9154
9129
|
*/
|
|
9155
9130
|
|
|
9156
9131
|
/**
|
|
@@ -13539,7 +13514,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13539
13514
|
/**
|
|
13540
13515
|
* DataExtensions service.
|
|
13541
13516
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
13542
|
-
* @version
|
|
13517
|
+
* @version 126.0.0
|
|
13543
13518
|
*/
|
|
13544
13519
|
|
|
13545
13520
|
/**
|
|
@@ -13625,7 +13600,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13625
13600
|
/**
|
|
13626
13601
|
* ExternalContacts service.
|
|
13627
13602
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
13628
|
-
* @version
|
|
13603
|
+
* @version 126.0.0
|
|
13629
13604
|
*/
|
|
13630
13605
|
|
|
13631
13606
|
/**
|
|
@@ -15368,7 +15343,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15368
15343
|
/**
|
|
15369
15344
|
* Fax service.
|
|
15370
15345
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
15371
|
-
* @version
|
|
15346
|
+
* @version 126.0.0
|
|
15372
15347
|
*/
|
|
15373
15348
|
|
|
15374
15349
|
/**
|
|
@@ -15539,7 +15514,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15539
15514
|
/**
|
|
15540
15515
|
* Flows service.
|
|
15541
15516
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
15542
|
-
* @version
|
|
15517
|
+
* @version 126.0.0
|
|
15543
15518
|
*/
|
|
15544
15519
|
|
|
15545
15520
|
/**
|
|
@@ -15610,7 +15585,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15610
15585
|
/**
|
|
15611
15586
|
* Gamification service.
|
|
15612
15587
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
15613
|
-
* @version
|
|
15588
|
+
* @version 126.0.0
|
|
15614
15589
|
*/
|
|
15615
15590
|
|
|
15616
15591
|
/**
|
|
@@ -16916,7 +16891,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16916
16891
|
/**
|
|
16917
16892
|
* GeneralDataProtectionRegulation service.
|
|
16918
16893
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
16919
|
-
* @version
|
|
16894
|
+
* @version 126.0.0
|
|
16920
16895
|
*/
|
|
16921
16896
|
|
|
16922
16897
|
/**
|
|
@@ -17046,7 +17021,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17046
17021
|
/**
|
|
17047
17022
|
* Geolocation service.
|
|
17048
17023
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
17049
|
-
* @version
|
|
17024
|
+
* @version 126.0.0
|
|
17050
17025
|
*/
|
|
17051
17026
|
|
|
17052
17027
|
/**
|
|
@@ -17177,7 +17152,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17177
17152
|
/**
|
|
17178
17153
|
* Greetings service.
|
|
17179
17154
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
17180
|
-
* @version
|
|
17155
|
+
* @version 126.0.0
|
|
17181
17156
|
*/
|
|
17182
17157
|
|
|
17183
17158
|
/**
|
|
@@ -17632,7 +17607,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17632
17607
|
/**
|
|
17633
17608
|
* Groups service.
|
|
17634
17609
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
17635
|
-
* @version
|
|
17610
|
+
* @version 126.0.0
|
|
17636
17611
|
*/
|
|
17637
17612
|
|
|
17638
17613
|
/**
|
|
@@ -18037,7 +18012,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18037
18012
|
/**
|
|
18038
18013
|
* IdentityProvider service.
|
|
18039
18014
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
18040
|
-
* @version
|
|
18015
|
+
* @version 126.0.0
|
|
18041
18016
|
*/
|
|
18042
18017
|
|
|
18043
18018
|
/**
|
|
@@ -18793,7 +18768,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18793
18768
|
/**
|
|
18794
18769
|
* Integrations service.
|
|
18795
18770
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
18796
|
-
* @version
|
|
18771
|
+
* @version 126.0.0
|
|
18797
18772
|
*/
|
|
18798
18773
|
|
|
18799
18774
|
/**
|
|
@@ -20439,7 +20414,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20439
20414
|
/**
|
|
20440
20415
|
* Journey service.
|
|
20441
20416
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
20442
|
-
* @version
|
|
20417
|
+
* @version 126.0.0
|
|
20443
20418
|
*/
|
|
20444
20419
|
|
|
20445
20420
|
/**
|
|
@@ -21150,7 +21125,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21150
21125
|
/**
|
|
21151
21126
|
* Knowledge service.
|
|
21152
21127
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
21153
|
-
* @version
|
|
21128
|
+
* @version 126.0.0
|
|
21154
21129
|
*/
|
|
21155
21130
|
|
|
21156
21131
|
/**
|
|
@@ -21640,79 +21615,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21640
21615
|
);
|
|
21641
21616
|
}
|
|
21642
21617
|
|
|
21643
|
-
/**
|
|
21644
|
-
* Update specific context data of the knowledge base.
|
|
21645
|
-
*
|
|
21646
|
-
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
21647
|
-
* @param {String} contextId Context ID.
|
|
21648
|
-
* @param {Object} opts Optional parameters
|
|
21649
|
-
* @param {Object} opts.body
|
|
21650
|
-
*/
|
|
21651
|
-
patchKnowledgeKnowledgebaseContext(knowledgeBaseId, contextId, opts) {
|
|
21652
|
-
opts = opts || {};
|
|
21653
|
-
|
|
21654
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
21655
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
21656
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseContext';
|
|
21657
|
-
}
|
|
21658
|
-
// verify the required parameter 'contextId' is set
|
|
21659
|
-
if (contextId === undefined || contextId === null) {
|
|
21660
|
-
throw 'Missing the required parameter "contextId" when calling patchKnowledgeKnowledgebaseContext';
|
|
21661
|
-
}
|
|
21662
|
-
|
|
21663
|
-
return this.apiClient.callApi(
|
|
21664
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/contexts/{contextId}',
|
|
21665
|
-
'PATCH',
|
|
21666
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'contextId': contextId },
|
|
21667
|
-
{ },
|
|
21668
|
-
{ },
|
|
21669
|
-
{ },
|
|
21670
|
-
opts['body'],
|
|
21671
|
-
['PureCloud OAuth'],
|
|
21672
|
-
['application/json'],
|
|
21673
|
-
['application/json']
|
|
21674
|
-
);
|
|
21675
|
-
}
|
|
21676
|
-
|
|
21677
|
-
/**
|
|
21678
|
-
* Update context value.
|
|
21679
|
-
*
|
|
21680
|
-
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
21681
|
-
* @param {String} contextId Context ID.
|
|
21682
|
-
* @param {String} contextValueId Context Value ID.
|
|
21683
|
-
* @param {Object} opts Optional parameters
|
|
21684
|
-
* @param {Object} opts.body
|
|
21685
|
-
*/
|
|
21686
|
-
patchKnowledgeKnowledgebaseContextValue(knowledgeBaseId, contextId, contextValueId, opts) {
|
|
21687
|
-
opts = opts || {};
|
|
21688
|
-
|
|
21689
|
-
// verify the required parameter 'knowledgeBaseId' is set
|
|
21690
|
-
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
21691
|
-
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseContextValue';
|
|
21692
|
-
}
|
|
21693
|
-
// verify the required parameter 'contextId' is set
|
|
21694
|
-
if (contextId === undefined || contextId === null) {
|
|
21695
|
-
throw 'Missing the required parameter "contextId" when calling patchKnowledgeKnowledgebaseContextValue';
|
|
21696
|
-
}
|
|
21697
|
-
// verify the required parameter 'contextValueId' is set
|
|
21698
|
-
if (contextValueId === undefined || contextValueId === null) {
|
|
21699
|
-
throw 'Missing the required parameter "contextValueId" when calling patchKnowledgeKnowledgebaseContextValue';
|
|
21700
|
-
}
|
|
21701
|
-
|
|
21702
|
-
return this.apiClient.callApi(
|
|
21703
|
-
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/contexts/{contextId}/values/{contextValueId}',
|
|
21704
|
-
'PATCH',
|
|
21705
|
-
{ 'knowledgeBaseId': knowledgeBaseId,'contextId': contextId,'contextValueId': contextValueId },
|
|
21706
|
-
{ },
|
|
21707
|
-
{ },
|
|
21708
|
-
{ },
|
|
21709
|
-
opts['body'],
|
|
21710
|
-
['PureCloud OAuth'],
|
|
21711
|
-
['application/json'],
|
|
21712
|
-
['application/json']
|
|
21713
|
-
);
|
|
21714
|
-
}
|
|
21715
|
-
|
|
21716
21618
|
/**
|
|
21717
21619
|
* Update category
|
|
21718
21620
|
*
|
|
@@ -22123,7 +22025,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22123
22025
|
/**
|
|
22124
22026
|
* LanguageUnderstanding service.
|
|
22125
22027
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
22126
|
-
* @version
|
|
22028
|
+
* @version 126.0.0
|
|
22127
22029
|
*/
|
|
22128
22030
|
|
|
22129
22031
|
/**
|
|
@@ -22689,7 +22591,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22689
22591
|
}
|
|
22690
22592
|
|
|
22691
22593
|
/**
|
|
22692
|
-
* Save information for the draft
|
|
22594
|
+
* Save information for the draft. Either topic draft or intent draft should be sent.
|
|
22693
22595
|
*
|
|
22694
22596
|
* @param {String} minerId Miner ID
|
|
22695
22597
|
* @param {String} draftId Draft ID
|
|
@@ -22933,7 +22835,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22933
22835
|
}
|
|
22934
22836
|
|
|
22935
22837
|
/**
|
|
22936
|
-
* Start the mining process. Specify date range pair with mediaType
|
|
22838
|
+
* 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.
|
|
22937
22839
|
*
|
|
22938
22840
|
* @param {String} minerId Miner ID
|
|
22939
22841
|
* @param {Object} opts Optional parameters
|
|
@@ -23027,7 +22929,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23027
22929
|
/**
|
|
23028
22930
|
* Languages service.
|
|
23029
22931
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
23030
|
-
* @version
|
|
22932
|
+
* @version 126.0.0
|
|
23031
22933
|
*/
|
|
23032
22934
|
|
|
23033
22935
|
/**
|
|
@@ -23295,7 +23197,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23295
23197
|
/**
|
|
23296
23198
|
* Learning service.
|
|
23297
23199
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
23298
|
-
* @version
|
|
23200
|
+
* @version 126.0.0
|
|
23299
23201
|
*/
|
|
23300
23202
|
|
|
23301
23203
|
/**
|
|
@@ -23886,7 +23788,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23886
23788
|
/**
|
|
23887
23789
|
* License service.
|
|
23888
23790
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
23889
|
-
* @version
|
|
23791
|
+
* @version 126.0.0
|
|
23890
23792
|
*/
|
|
23891
23793
|
|
|
23892
23794
|
/**
|
|
@@ -24124,7 +24026,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24124
24026
|
/**
|
|
24125
24027
|
* Locations service.
|
|
24126
24028
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
24127
|
-
* @version
|
|
24029
|
+
* @version 126.0.0
|
|
24128
24030
|
*/
|
|
24129
24031
|
|
|
24130
24032
|
/**
|
|
@@ -24360,7 +24262,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24360
24262
|
/**
|
|
24361
24263
|
* MobileDevices service.
|
|
24362
24264
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
24363
|
-
* @version
|
|
24265
|
+
* @version 126.0.0
|
|
24364
24266
|
*/
|
|
24365
24267
|
|
|
24366
24268
|
/**
|
|
@@ -24511,7 +24413,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24511
24413
|
/**
|
|
24512
24414
|
* Notifications service.
|
|
24513
24415
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
24514
|
-
* @version
|
|
24416
|
+
* @version 126.0.0
|
|
24515
24417
|
*/
|
|
24516
24418
|
|
|
24517
24419
|
/**
|
|
@@ -24736,7 +24638,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24736
24638
|
/**
|
|
24737
24639
|
* OAuth service.
|
|
24738
24640
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
24739
|
-
* @version
|
|
24641
|
+
* @version 126.0.0
|
|
24740
24642
|
*/
|
|
24741
24643
|
|
|
24742
24644
|
/**
|
|
@@ -25094,7 +24996,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25094
24996
|
/**
|
|
25095
24997
|
* Objects service.
|
|
25096
24998
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
25097
|
-
* @version
|
|
24999
|
+
* @version 126.0.0
|
|
25098
25000
|
*/
|
|
25099
25001
|
|
|
25100
25002
|
/**
|
|
@@ -25365,7 +25267,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25365
25267
|
/**
|
|
25366
25268
|
* Organization service.
|
|
25367
25269
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
25368
|
-
* @version
|
|
25270
|
+
* @version 126.0.0
|
|
25369
25271
|
*/
|
|
25370
25272
|
|
|
25371
25273
|
/**
|
|
@@ -25768,7 +25670,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25768
25670
|
/**
|
|
25769
25671
|
* OrganizationAuthorization service.
|
|
25770
25672
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
25771
|
-
* @version
|
|
25673
|
+
* @version 126.0.0
|
|
25772
25674
|
*/
|
|
25773
25675
|
|
|
25774
25676
|
/**
|
|
@@ -25808,6 +25710,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25808
25710
|
);
|
|
25809
25711
|
}
|
|
25810
25712
|
|
|
25713
|
+
/**
|
|
25714
|
+
* Deletes cloned user
|
|
25715
|
+
*
|
|
25716
|
+
* @param {String} trusteeOrgId Trustee Organization Id
|
|
25717
|
+
* @param {String} trusteeUserId Id of the cloned user to delete
|
|
25718
|
+
*/
|
|
25719
|
+
deleteOrgauthorizationTrusteeCloneduser(trusteeOrgId, trusteeUserId) {
|
|
25720
|
+
// verify the required parameter 'trusteeOrgId' is set
|
|
25721
|
+
if (trusteeOrgId === undefined || trusteeOrgId === null) {
|
|
25722
|
+
throw 'Missing the required parameter "trusteeOrgId" when calling deleteOrgauthorizationTrusteeCloneduser';
|
|
25723
|
+
}
|
|
25724
|
+
// verify the required parameter 'trusteeUserId' is set
|
|
25725
|
+
if (trusteeUserId === undefined || trusteeUserId === null) {
|
|
25726
|
+
throw 'Missing the required parameter "trusteeUserId" when calling deleteOrgauthorizationTrusteeCloneduser';
|
|
25727
|
+
}
|
|
25728
|
+
|
|
25729
|
+
return this.apiClient.callApi(
|
|
25730
|
+
'/api/v2/orgauthorization/trustees/{trusteeOrgId}/clonedusers/{trusteeUserId}',
|
|
25731
|
+
'DELETE',
|
|
25732
|
+
{ 'trusteeOrgId': trusteeOrgId,'trusteeUserId': trusteeUserId },
|
|
25733
|
+
{ },
|
|
25734
|
+
{ },
|
|
25735
|
+
{ },
|
|
25736
|
+
null,
|
|
25737
|
+
['PureCloud OAuth'],
|
|
25738
|
+
['application/json'],
|
|
25739
|
+
['application/json']
|
|
25740
|
+
);
|
|
25741
|
+
}
|
|
25742
|
+
|
|
25811
25743
|
/**
|
|
25812
25744
|
* Delete Trustee User
|
|
25813
25745
|
*
|
|
@@ -25893,6 +25825,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25893
25825
|
);
|
|
25894
25826
|
}
|
|
25895
25827
|
|
|
25828
|
+
/**
|
|
25829
|
+
* Delete Cloned User
|
|
25830
|
+
*
|
|
25831
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
25832
|
+
* @param {String} trusteeUserId Trustee User Id
|
|
25833
|
+
*/
|
|
25834
|
+
deleteOrgauthorizationTrustorCloneduser(trustorOrgId, trusteeUserId) {
|
|
25835
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
25836
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
25837
|
+
throw 'Missing the required parameter "trustorOrgId" when calling deleteOrgauthorizationTrustorCloneduser';
|
|
25838
|
+
}
|
|
25839
|
+
// verify the required parameter 'trusteeUserId' is set
|
|
25840
|
+
if (trusteeUserId === undefined || trusteeUserId === null) {
|
|
25841
|
+
throw 'Missing the required parameter "trusteeUserId" when calling deleteOrgauthorizationTrustorCloneduser';
|
|
25842
|
+
}
|
|
25843
|
+
|
|
25844
|
+
return this.apiClient.callApi(
|
|
25845
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}',
|
|
25846
|
+
'DELETE',
|
|
25847
|
+
{ 'trustorOrgId': trustorOrgId,'trusteeUserId': trusteeUserId },
|
|
25848
|
+
{ },
|
|
25849
|
+
{ },
|
|
25850
|
+
{ },
|
|
25851
|
+
null,
|
|
25852
|
+
['PureCloud OAuth'],
|
|
25853
|
+
['application/json'],
|
|
25854
|
+
['application/json']
|
|
25855
|
+
);
|
|
25856
|
+
}
|
|
25857
|
+
|
|
25896
25858
|
/**
|
|
25897
25859
|
* Delete Trustee User
|
|
25898
25860
|
*
|
|
@@ -25973,6 +25935,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25973
25935
|
);
|
|
25974
25936
|
}
|
|
25975
25937
|
|
|
25938
|
+
/**
|
|
25939
|
+
* The list of cloned users from the trustee organization (i.e. users with a native user record).
|
|
25940
|
+
* There can be no more than 5 cloned users per organization, so results are represented as simple list and not paged
|
|
25941
|
+
* @param {String} trusteeOrgId Trustee Organization Id
|
|
25942
|
+
*/
|
|
25943
|
+
getOrgauthorizationTrusteeClonedusers(trusteeOrgId) {
|
|
25944
|
+
// verify the required parameter 'trusteeOrgId' is set
|
|
25945
|
+
if (trusteeOrgId === undefined || trusteeOrgId === null) {
|
|
25946
|
+
throw 'Missing the required parameter "trusteeOrgId" when calling getOrgauthorizationTrusteeClonedusers';
|
|
25947
|
+
}
|
|
25948
|
+
|
|
25949
|
+
return this.apiClient.callApi(
|
|
25950
|
+
'/api/v2/orgauthorization/trustees/{trusteeOrgId}/clonedusers',
|
|
25951
|
+
'GET',
|
|
25952
|
+
{ 'trusteeOrgId': trusteeOrgId },
|
|
25953
|
+
{ },
|
|
25954
|
+
{ },
|
|
25955
|
+
{ },
|
|
25956
|
+
null,
|
|
25957
|
+
['PureCloud OAuth'],
|
|
25958
|
+
['application/json'],
|
|
25959
|
+
['application/json']
|
|
25960
|
+
);
|
|
25961
|
+
}
|
|
25962
|
+
|
|
25976
25963
|
/**
|
|
25977
25964
|
* Get Trustee User
|
|
25978
25965
|
*
|
|
@@ -26088,6 +26075,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26088
26075
|
);
|
|
26089
26076
|
}
|
|
26090
26077
|
|
|
26078
|
+
/**
|
|
26079
|
+
* Get organization authorization trust with Customer Care, if one exists.
|
|
26080
|
+
*
|
|
26081
|
+
*/
|
|
26082
|
+
getOrgauthorizationTrusteesDefault() {
|
|
26083
|
+
|
|
26084
|
+
return this.apiClient.callApi(
|
|
26085
|
+
'/api/v2/orgauthorization/trustees/default',
|
|
26086
|
+
'GET',
|
|
26087
|
+
{ },
|
|
26088
|
+
{ },
|
|
26089
|
+
{ },
|
|
26090
|
+
{ },
|
|
26091
|
+
null,
|
|
26092
|
+
['PureCloud OAuth'],
|
|
26093
|
+
['application/json'],
|
|
26094
|
+
['application/json']
|
|
26095
|
+
);
|
|
26096
|
+
}
|
|
26097
|
+
|
|
26091
26098
|
/**
|
|
26092
26099
|
* Get Org Trust
|
|
26093
26100
|
*
|
|
@@ -26113,6 +26120,61 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26113
26120
|
);
|
|
26114
26121
|
}
|
|
26115
26122
|
|
|
26123
|
+
/**
|
|
26124
|
+
* Get Cloned User
|
|
26125
|
+
*
|
|
26126
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
26127
|
+
* @param {String} trusteeUserId Trustee User Id
|
|
26128
|
+
*/
|
|
26129
|
+
getOrgauthorizationTrustorCloneduser(trustorOrgId, trusteeUserId) {
|
|
26130
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
26131
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
26132
|
+
throw 'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustorCloneduser';
|
|
26133
|
+
}
|
|
26134
|
+
// verify the required parameter 'trusteeUserId' is set
|
|
26135
|
+
if (trusteeUserId === undefined || trusteeUserId === null) {
|
|
26136
|
+
throw 'Missing the required parameter "trusteeUserId" when calling getOrgauthorizationTrustorCloneduser';
|
|
26137
|
+
}
|
|
26138
|
+
|
|
26139
|
+
return this.apiClient.callApi(
|
|
26140
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}',
|
|
26141
|
+
'GET',
|
|
26142
|
+
{ 'trustorOrgId': trustorOrgId,'trusteeUserId': trusteeUserId },
|
|
26143
|
+
{ },
|
|
26144
|
+
{ },
|
|
26145
|
+
{ },
|
|
26146
|
+
null,
|
|
26147
|
+
['PureCloud OAuth'],
|
|
26148
|
+
['application/json'],
|
|
26149
|
+
['application/json']
|
|
26150
|
+
);
|
|
26151
|
+
}
|
|
26152
|
+
|
|
26153
|
+
/**
|
|
26154
|
+
* The list of cloned users in the trustor organization (i.e. users with a native user record).
|
|
26155
|
+
*
|
|
26156
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
26157
|
+
*/
|
|
26158
|
+
getOrgauthorizationTrustorClonedusers(trustorOrgId) {
|
|
26159
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
26160
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
26161
|
+
throw 'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustorClonedusers';
|
|
26162
|
+
}
|
|
26163
|
+
|
|
26164
|
+
return this.apiClient.callApi(
|
|
26165
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers',
|
|
26166
|
+
'GET',
|
|
26167
|
+
{ 'trustorOrgId': trustorOrgId },
|
|
26168
|
+
{ },
|
|
26169
|
+
{ },
|
|
26170
|
+
{ },
|
|
26171
|
+
null,
|
|
26172
|
+
['PureCloud OAuth'],
|
|
26173
|
+
['application/json'],
|
|
26174
|
+
['application/json']
|
|
26175
|
+
);
|
|
26176
|
+
}
|
|
26177
|
+
|
|
26116
26178
|
/**
|
|
26117
26179
|
* Get Trustee User
|
|
26118
26180
|
*
|
|
@@ -26310,6 +26372,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26310
26372
|
);
|
|
26311
26373
|
}
|
|
26312
26374
|
|
|
26375
|
+
/**
|
|
26376
|
+
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
26377
|
+
*
|
|
26378
|
+
* @param {Object} opts Optional parameters
|
|
26379
|
+
* @param {Boolean} opts.assignDefaultRole Assign Admin role to default pairing with Customer Care
|
|
26380
|
+
* @param {Boolean} opts.autoExpire Automatically expire pairing after 30 days
|
|
26381
|
+
*/
|
|
26382
|
+
postOrgauthorizationTrusteesDefault(opts) {
|
|
26383
|
+
opts = opts || {};
|
|
26384
|
+
|
|
26385
|
+
|
|
26386
|
+
return this.apiClient.callApi(
|
|
26387
|
+
'/api/v2/orgauthorization/trustees/default',
|
|
26388
|
+
'POST',
|
|
26389
|
+
{ },
|
|
26390
|
+
{ 'assignDefaultRole': opts['assignDefaultRole'],'autoExpire': opts['autoExpire'] },
|
|
26391
|
+
{ },
|
|
26392
|
+
{ },
|
|
26393
|
+
null,
|
|
26394
|
+
['PureCloud OAuth'],
|
|
26395
|
+
['application/json'],
|
|
26396
|
+
['application/json']
|
|
26397
|
+
);
|
|
26398
|
+
}
|
|
26399
|
+
|
|
26313
26400
|
/**
|
|
26314
26401
|
* Get Org Trustor Audits
|
|
26315
26402
|
*
|
|
@@ -26442,6 +26529,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26442
26529
|
);
|
|
26443
26530
|
}
|
|
26444
26531
|
|
|
26532
|
+
/**
|
|
26533
|
+
* Creates a clone of the trustee user in the trustor org.
|
|
26534
|
+
*
|
|
26535
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
26536
|
+
* @param {String} trusteeUserId Trustee User Id
|
|
26537
|
+
*/
|
|
26538
|
+
putOrgauthorizationTrustorCloneduser(trustorOrgId, trusteeUserId) {
|
|
26539
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
26540
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
26541
|
+
throw 'Missing the required parameter "trustorOrgId" when calling putOrgauthorizationTrustorCloneduser';
|
|
26542
|
+
}
|
|
26543
|
+
// verify the required parameter 'trusteeUserId' is set
|
|
26544
|
+
if (trusteeUserId === undefined || trusteeUserId === null) {
|
|
26545
|
+
throw 'Missing the required parameter "trusteeUserId" when calling putOrgauthorizationTrustorCloneduser';
|
|
26546
|
+
}
|
|
26547
|
+
|
|
26548
|
+
return this.apiClient.callApi(
|
|
26549
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}',
|
|
26550
|
+
'PUT',
|
|
26551
|
+
{ 'trustorOrgId': trustorOrgId,'trusteeUserId': trusteeUserId },
|
|
26552
|
+
{ },
|
|
26553
|
+
{ },
|
|
26554
|
+
{ },
|
|
26555
|
+
null,
|
|
26556
|
+
['PureCloud OAuth'],
|
|
26557
|
+
['application/json'],
|
|
26558
|
+
['application/json']
|
|
26559
|
+
);
|
|
26560
|
+
}
|
|
26561
|
+
|
|
26445
26562
|
/**
|
|
26446
26563
|
* Add a Trustee user to the trust.
|
|
26447
26564
|
*
|
|
@@ -26478,7 +26595,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26478
26595
|
/**
|
|
26479
26596
|
* Outbound service.
|
|
26480
26597
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
26481
|
-
* @version
|
|
26598
|
+
* @version 126.0.0
|
|
26482
26599
|
*/
|
|
26483
26600
|
|
|
26484
26601
|
/**
|
|
@@ -29504,7 +29621,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29504
29621
|
/**
|
|
29505
29622
|
* Presence service.
|
|
29506
29623
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
29507
|
-
* @version
|
|
29624
|
+
* @version 126.0.0
|
|
29508
29625
|
*/
|
|
29509
29626
|
|
|
29510
29627
|
/**
|
|
@@ -29876,7 +29993,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29876
29993
|
/**
|
|
29877
29994
|
* Quality service.
|
|
29878
29995
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
29879
|
-
* @version
|
|
29996
|
+
* @version 126.0.0
|
|
29880
29997
|
*/
|
|
29881
29998
|
|
|
29882
29999
|
/**
|
|
@@ -30249,7 +30366,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30249
30366
|
|
|
30250
30367
|
/**
|
|
30251
30368
|
* Queries Evaluations and returns a paged list
|
|
30252
|
-
* Query params must include one of conversationId, evaluatorUserId, or agentUserId
|
|
30369
|
+
* 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.
|
|
30253
30370
|
* @param {Object} opts Optional parameters
|
|
30254
30371
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
30255
30372
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -31404,7 +31521,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31404
31521
|
/**
|
|
31405
31522
|
* Recording service.
|
|
31406
31523
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
31407
|
-
* @version
|
|
31524
|
+
* @version 126.0.0
|
|
31408
31525
|
*/
|
|
31409
31526
|
|
|
31410
31527
|
/**
|
|
@@ -32923,7 +33040,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32923
33040
|
/**
|
|
32924
33041
|
* ResponseManagement service.
|
|
32925
33042
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
32926
|
-
* @version
|
|
33043
|
+
* @version 126.0.0
|
|
32927
33044
|
*/
|
|
32928
33045
|
|
|
32929
33046
|
/**
|
|
@@ -33248,7 +33365,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33248
33365
|
/**
|
|
33249
33366
|
* Routing service.
|
|
33250
33367
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
33251
|
-
* @version
|
|
33368
|
+
* @version 126.0.0
|
|
33252
33369
|
*/
|
|
33253
33370
|
|
|
33254
33371
|
/**
|
|
@@ -34404,12 +34521,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34404
34521
|
}
|
|
34405
34522
|
|
|
34406
34523
|
/**
|
|
34407
|
-
* Get a paged listing of simplified queue objects. Can be used to get a digest of all queues in an organization.
|
|
34524
|
+
* Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization.
|
|
34408
34525
|
*
|
|
34409
34526
|
* @param {Object} opts Optional parameters
|
|
34410
34527
|
* @param {Number} opts.pageSize Page size [max value is 500] (default to 25)
|
|
34411
34528
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
34412
|
-
* @param {Object} opts.sortBy Sort by (default to name)
|
|
34413
34529
|
* @param {Object} opts.sortOrder Sort order (default to asc)
|
|
34414
34530
|
*/
|
|
34415
34531
|
getRoutingQueuesDivisionviewsAll(opts) {
|
|
@@ -34420,7 +34536,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34420
34536
|
'/api/v2/routing/queues/divisionviews/all',
|
|
34421
34537
|
'GET',
|
|
34422
34538
|
{ },
|
|
34423
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'
|
|
34539
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'] },
|
|
34424
34540
|
{ },
|
|
34425
34541
|
{ },
|
|
34426
34542
|
null,
|
|
@@ -36168,7 +36284,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36168
36284
|
/**
|
|
36169
36285
|
* SCIM service.
|
|
36170
36286
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
36171
|
-
* @version
|
|
36287
|
+
* @version 126.0.0
|
|
36172
36288
|
*/
|
|
36173
36289
|
|
|
36174
36290
|
/**
|
|
@@ -37045,7 +37161,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37045
37161
|
/**
|
|
37046
37162
|
* Scripts service.
|
|
37047
37163
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
37048
|
-
* @version
|
|
37164
|
+
* @version 126.0.0
|
|
37049
37165
|
*/
|
|
37050
37166
|
|
|
37051
37167
|
/**
|
|
@@ -37398,7 +37514,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37398
37514
|
/**
|
|
37399
37515
|
* Search service.
|
|
37400
37516
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
37401
|
-
* @version
|
|
37517
|
+
* @version 126.0.0
|
|
37402
37518
|
*/
|
|
37403
37519
|
|
|
37404
37520
|
/**
|
|
@@ -37933,7 +38049,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37933
38049
|
/**
|
|
37934
38050
|
* SpeechTextAnalytics service.
|
|
37935
38051
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
37936
|
-
* @version
|
|
38052
|
+
* @version 126.0.0
|
|
37937
38053
|
*/
|
|
37938
38054
|
|
|
37939
38055
|
/**
|
|
@@ -38104,7 +38220,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38104
38220
|
|
|
38105
38221
|
/**
|
|
38106
38222
|
* Get list of supported Speech & Text Analytics dialects
|
|
38107
|
-
*
|
|
38223
|
+
* This api has been deprecated. Use api/v2/topics/dialects instead
|
|
38108
38224
|
*/
|
|
38109
38225
|
getSpeechandtextanalyticsDialects() {
|
|
38110
38226
|
|
|
@@ -38786,7 +38902,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38786
38902
|
/**
|
|
38787
38903
|
* Stations service.
|
|
38788
38904
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
38789
|
-
* @version
|
|
38905
|
+
* @version 126.0.0
|
|
38790
38906
|
*/
|
|
38791
38907
|
|
|
38792
38908
|
/**
|
|
@@ -38933,7 +39049,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38933
39049
|
/**
|
|
38934
39050
|
* Suggest service.
|
|
38935
39051
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
38936
|
-
* @version
|
|
39052
|
+
* @version 126.0.0
|
|
38937
39053
|
*/
|
|
38938
39054
|
|
|
38939
39055
|
/**
|
|
@@ -39072,7 +39188,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39072
39188
|
/**
|
|
39073
39189
|
* Telephony service.
|
|
39074
39190
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
39075
|
-
* @version
|
|
39191
|
+
* @version 126.0.0
|
|
39076
39192
|
*/
|
|
39077
39193
|
|
|
39078
39194
|
/**
|
|
@@ -39180,7 +39296,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39180
39296
|
/**
|
|
39181
39297
|
* TelephonyProvidersEdge service.
|
|
39182
39298
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
39183
|
-
* @version
|
|
39299
|
+
* @version 126.0.0
|
|
39184
39300
|
*/
|
|
39185
39301
|
|
|
39186
39302
|
/**
|
|
@@ -42793,7 +42909,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42793
42909
|
/**
|
|
42794
42910
|
* Textbots service.
|
|
42795
42911
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
42796
|
-
* @version
|
|
42912
|
+
* @version 126.0.0
|
|
42797
42913
|
*/
|
|
42798
42914
|
|
|
42799
42915
|
/**
|
|
@@ -42894,7 +43010,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42894
43010
|
/**
|
|
42895
43011
|
* Tokens service.
|
|
42896
43012
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
42897
|
-
* @version
|
|
43013
|
+
* @version 126.0.0
|
|
42898
43014
|
*/
|
|
42899
43015
|
|
|
42900
43016
|
/**
|
|
@@ -43000,7 +43116,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43000
43116
|
/**
|
|
43001
43117
|
* Uploads service.
|
|
43002
43118
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
43003
|
-
* @version
|
|
43119
|
+
* @version 126.0.0
|
|
43004
43120
|
*/
|
|
43005
43121
|
|
|
43006
43122
|
/**
|
|
@@ -43176,7 +43292,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43176
43292
|
/**
|
|
43177
43293
|
* Usage service.
|
|
43178
43294
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
43179
|
-
* @version
|
|
43295
|
+
* @version 126.0.0
|
|
43180
43296
|
*/
|
|
43181
43297
|
|
|
43182
43298
|
/**
|
|
@@ -43247,7 +43363,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43247
43363
|
/**
|
|
43248
43364
|
* UserRecordings service.
|
|
43249
43365
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
43250
|
-
* @version
|
|
43366
|
+
* @version 126.0.0
|
|
43251
43367
|
*/
|
|
43252
43368
|
|
|
43253
43369
|
/**
|
|
@@ -43431,7 +43547,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43431
43547
|
/**
|
|
43432
43548
|
* Users service.
|
|
43433
43549
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
43434
|
-
* @version
|
|
43550
|
+
* @version 126.0.0
|
|
43435
43551
|
*/
|
|
43436
43552
|
|
|
43437
43553
|
/**
|
|
@@ -45733,7 +45849,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45733
45849
|
/**
|
|
45734
45850
|
* Utilities service.
|
|
45735
45851
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
45736
|
-
* @version
|
|
45852
|
+
* @version 126.0.0
|
|
45737
45853
|
*/
|
|
45738
45854
|
|
|
45739
45855
|
/**
|
|
@@ -45844,7 +45960,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45844
45960
|
/**
|
|
45845
45961
|
* Voicemail service.
|
|
45846
45962
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
45847
|
-
* @version
|
|
45963
|
+
* @version 126.0.0
|
|
45848
45964
|
*/
|
|
45849
45965
|
|
|
45850
45966
|
/**
|
|
@@ -46511,7 +46627,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46511
46627
|
/**
|
|
46512
46628
|
* WebChat service.
|
|
46513
46629
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
46514
|
-
* @version
|
|
46630
|
+
* @version 126.0.0
|
|
46515
46631
|
*/
|
|
46516
46632
|
|
|
46517
46633
|
/**
|
|
@@ -47055,7 +47171,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47055
47171
|
/**
|
|
47056
47172
|
* WebDeployments service.
|
|
47057
47173
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
47058
|
-
* @version
|
|
47174
|
+
* @version 126.0.0
|
|
47059
47175
|
*/
|
|
47060
47176
|
|
|
47061
47177
|
/**
|
|
@@ -47410,7 +47526,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47410
47526
|
/**
|
|
47411
47527
|
* WebMessaging service.
|
|
47412
47528
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
47413
|
-
* @version
|
|
47529
|
+
* @version 126.0.0
|
|
47414
47530
|
*/
|
|
47415
47531
|
|
|
47416
47532
|
/**
|
|
@@ -47456,7 +47572,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47456
47572
|
/**
|
|
47457
47573
|
* Widgets service.
|
|
47458
47574
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
47459
|
-
* @version
|
|
47575
|
+
* @version 126.0.0
|
|
47460
47576
|
*/
|
|
47461
47577
|
|
|
47462
47578
|
/**
|
|
@@ -47602,7 +47718,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47602
47718
|
/**
|
|
47603
47719
|
* WorkforceManagement service.
|
|
47604
47720
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
47605
|
-
* @version
|
|
47721
|
+
* @version 126.0.0
|
|
47606
47722
|
*/
|
|
47607
47723
|
|
|
47608
47724
|
/**
|
|
@@ -47877,6 +47993,66 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47877
47993
|
);
|
|
47878
47994
|
}
|
|
47879
47995
|
|
|
47996
|
+
/**
|
|
47997
|
+
* Deletes a time off limit object
|
|
47998
|
+
*
|
|
47999
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
48000
|
+
* @param {String} timeOffLimitId The ID of the time off limit object to delete
|
|
48001
|
+
*/
|
|
48002
|
+
deleteWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
48003
|
+
// verify the required parameter 'managementUnitId' is set
|
|
48004
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
48005
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitTimeofflimit';
|
|
48006
|
+
}
|
|
48007
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
48008
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
48009
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling deleteWorkforcemanagementManagementunitTimeofflimit';
|
|
48010
|
+
}
|
|
48011
|
+
|
|
48012
|
+
return this.apiClient.callApi(
|
|
48013
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
48014
|
+
'DELETE',
|
|
48015
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
48016
|
+
{ },
|
|
48017
|
+
{ },
|
|
48018
|
+
{ },
|
|
48019
|
+
null,
|
|
48020
|
+
['PureCloud OAuth'],
|
|
48021
|
+
['application/json'],
|
|
48022
|
+
['application/json']
|
|
48023
|
+
);
|
|
48024
|
+
}
|
|
48025
|
+
|
|
48026
|
+
/**
|
|
48027
|
+
* Deletes a time off plan
|
|
48028
|
+
*
|
|
48029
|
+
* @param {String} managementUnitId The management unit ID.
|
|
48030
|
+
* @param {String} timeOffPlanId The ID of the time off plan to delete
|
|
48031
|
+
*/
|
|
48032
|
+
deleteWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
48033
|
+
// verify the required parameter 'managementUnitId' is set
|
|
48034
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
48035
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitTimeoffplan';
|
|
48036
|
+
}
|
|
48037
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
48038
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
48039
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling deleteWorkforcemanagementManagementunitTimeoffplan';
|
|
48040
|
+
}
|
|
48041
|
+
|
|
48042
|
+
return this.apiClient.callApi(
|
|
48043
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
48044
|
+
'DELETE',
|
|
48045
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
48046
|
+
{ },
|
|
48047
|
+
{ },
|
|
48048
|
+
{ },
|
|
48049
|
+
null,
|
|
48050
|
+
['PureCloud OAuth'],
|
|
48051
|
+
['application/json'],
|
|
48052
|
+
['application/json']
|
|
48053
|
+
);
|
|
48054
|
+
}
|
|
48055
|
+
|
|
47880
48056
|
/**
|
|
47881
48057
|
* Delete a work plan
|
|
47882
48058
|
*
|
|
@@ -49118,6 +49294,116 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49118
49294
|
);
|
|
49119
49295
|
}
|
|
49120
49296
|
|
|
49297
|
+
/**
|
|
49298
|
+
* Gets a time off limit object
|
|
49299
|
+
* Returns properties of time off limit object, but not daily values.
|
|
49300
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
49301
|
+
* @param {String} timeOffLimitId The ID of the time off limit to fetch
|
|
49302
|
+
*/
|
|
49303
|
+
getWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
49304
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49305
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49306
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeofflimit';
|
|
49307
|
+
}
|
|
49308
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
49309
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
49310
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling getWorkforcemanagementManagementunitTimeofflimit';
|
|
49311
|
+
}
|
|
49312
|
+
|
|
49313
|
+
return this.apiClient.callApi(
|
|
49314
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
49315
|
+
'GET',
|
|
49316
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
49317
|
+
{ },
|
|
49318
|
+
{ },
|
|
49319
|
+
{ },
|
|
49320
|
+
null,
|
|
49321
|
+
['PureCloud OAuth'],
|
|
49322
|
+
['application/json'],
|
|
49323
|
+
['application/json']
|
|
49324
|
+
);
|
|
49325
|
+
}
|
|
49326
|
+
|
|
49327
|
+
/**
|
|
49328
|
+
* Gets a list of time off limit objects under management unit.
|
|
49329
|
+
* Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.
|
|
49330
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
49331
|
+
*/
|
|
49332
|
+
getWorkforcemanagementManagementunitTimeofflimits(managementUnitId) {
|
|
49333
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49334
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49335
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeofflimits';
|
|
49336
|
+
}
|
|
49337
|
+
|
|
49338
|
+
return this.apiClient.callApi(
|
|
49339
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits',
|
|
49340
|
+
'GET',
|
|
49341
|
+
{ 'managementUnitId': managementUnitId },
|
|
49342
|
+
{ },
|
|
49343
|
+
{ },
|
|
49344
|
+
{ },
|
|
49345
|
+
null,
|
|
49346
|
+
['PureCloud OAuth'],
|
|
49347
|
+
['application/json'],
|
|
49348
|
+
['application/json']
|
|
49349
|
+
);
|
|
49350
|
+
}
|
|
49351
|
+
|
|
49352
|
+
/**
|
|
49353
|
+
* Gets a time off plan
|
|
49354
|
+
*
|
|
49355
|
+
* @param {String} managementUnitId The management unit ID.
|
|
49356
|
+
* @param {String} timeOffPlanId The ID of the time off plan to fetch
|
|
49357
|
+
*/
|
|
49358
|
+
getWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
49359
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49360
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49361
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeoffplan';
|
|
49362
|
+
}
|
|
49363
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
49364
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
49365
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling getWorkforcemanagementManagementunitTimeoffplan';
|
|
49366
|
+
}
|
|
49367
|
+
|
|
49368
|
+
return this.apiClient.callApi(
|
|
49369
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
49370
|
+
'GET',
|
|
49371
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
49372
|
+
{ },
|
|
49373
|
+
{ },
|
|
49374
|
+
{ },
|
|
49375
|
+
null,
|
|
49376
|
+
['PureCloud OAuth'],
|
|
49377
|
+
['application/json'],
|
|
49378
|
+
['application/json']
|
|
49379
|
+
);
|
|
49380
|
+
}
|
|
49381
|
+
|
|
49382
|
+
/**
|
|
49383
|
+
* Gets a list of time off plans
|
|
49384
|
+
*
|
|
49385
|
+
* @param {String} managementUnitId The management unit ID.
|
|
49386
|
+
*/
|
|
49387
|
+
getWorkforcemanagementManagementunitTimeoffplans(managementUnitId) {
|
|
49388
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49389
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49390
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeoffplans';
|
|
49391
|
+
}
|
|
49392
|
+
|
|
49393
|
+
return this.apiClient.callApi(
|
|
49394
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans',
|
|
49395
|
+
'GET',
|
|
49396
|
+
{ 'managementUnitId': managementUnitId },
|
|
49397
|
+
{ },
|
|
49398
|
+
{ },
|
|
49399
|
+
{ },
|
|
49400
|
+
null,
|
|
49401
|
+
['PureCloud OAuth'],
|
|
49402
|
+
['application/json'],
|
|
49403
|
+
['application/json']
|
|
49404
|
+
);
|
|
49405
|
+
}
|
|
49406
|
+
|
|
49121
49407
|
/**
|
|
49122
49408
|
* Get a time off request
|
|
49123
49409
|
*
|
|
@@ -49153,6 +49439,41 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49153
49439
|
);
|
|
49154
49440
|
}
|
|
49155
49441
|
|
|
49442
|
+
/**
|
|
49443
|
+
* Retrieves time off limit, allocated and waitlisted values according to specific time off request
|
|
49444
|
+
*
|
|
49445
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
49446
|
+
* @param {String} userId The userId to whom the time off request applies.
|
|
49447
|
+
* @param {String} timeOffRequestId The ID of the time off request, which dates and activityCodeId determine limit values to retrieve
|
|
49448
|
+
*/
|
|
49449
|
+
getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits(managementUnitId, userId, timeOffRequestId) {
|
|
49450
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49451
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49452
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
49453
|
+
}
|
|
49454
|
+
// verify the required parameter 'userId' is set
|
|
49455
|
+
if (userId === undefined || userId === null) {
|
|
49456
|
+
throw 'Missing the required parameter "userId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
49457
|
+
}
|
|
49458
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
49459
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
49460
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
49461
|
+
}
|
|
49462
|
+
|
|
49463
|
+
return this.apiClient.callApi(
|
|
49464
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeofflimits',
|
|
49465
|
+
'GET',
|
|
49466
|
+
{ 'managementUnitId': managementUnitId,'userId': userId,'timeOffRequestId': timeOffRequestId },
|
|
49467
|
+
{ },
|
|
49468
|
+
{ },
|
|
49469
|
+
{ },
|
|
49470
|
+
null,
|
|
49471
|
+
['PureCloud OAuth'],
|
|
49472
|
+
['application/json'],
|
|
49473
|
+
['application/json']
|
|
49474
|
+
);
|
|
49475
|
+
}
|
|
49476
|
+
|
|
49156
49477
|
/**
|
|
49157
49478
|
* Get a list of time off requests for a given user
|
|
49158
49479
|
*
|
|
@@ -49586,6 +49907,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49586
49907
|
);
|
|
49587
49908
|
}
|
|
49588
49909
|
|
|
49910
|
+
/**
|
|
49911
|
+
* Get the daily waitlist positions of a time off request for the current user
|
|
49912
|
+
*
|
|
49913
|
+
* @param {String} timeOffRequestId Time Off Request Id
|
|
49914
|
+
*/
|
|
49915
|
+
getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId) {
|
|
49916
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
49917
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
49918
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementTimeoffrequestWaitlistpositions';
|
|
49919
|
+
}
|
|
49920
|
+
|
|
49921
|
+
return this.apiClient.callApi(
|
|
49922
|
+
'/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}/waitlistpositions',
|
|
49923
|
+
'GET',
|
|
49924
|
+
{ 'timeOffRequestId': timeOffRequestId },
|
|
49925
|
+
{ },
|
|
49926
|
+
{ },
|
|
49927
|
+
{ },
|
|
49928
|
+
null,
|
|
49929
|
+
['PureCloud OAuth'],
|
|
49930
|
+
['application/json'],
|
|
49931
|
+
['application/json']
|
|
49932
|
+
);
|
|
49933
|
+
}
|
|
49934
|
+
|
|
49589
49935
|
/**
|
|
49590
49936
|
* Get a list of time off requests for the current user
|
|
49591
49937
|
*
|
|
@@ -49804,6 +50150,74 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49804
50150
|
);
|
|
49805
50151
|
}
|
|
49806
50152
|
|
|
50153
|
+
/**
|
|
50154
|
+
* Updates a time off limit object.
|
|
50155
|
+
* Updates time off limit object properties, but not daily values.
|
|
50156
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
50157
|
+
* @param {String} timeOffLimitId The id of time off limit object to update
|
|
50158
|
+
* @param {Object} opts Optional parameters
|
|
50159
|
+
* @param {Object} opts.body body
|
|
50160
|
+
*/
|
|
50161
|
+
patchWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId, opts) {
|
|
50162
|
+
opts = opts || {};
|
|
50163
|
+
|
|
50164
|
+
// verify the required parameter 'managementUnitId' is set
|
|
50165
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
50166
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
50167
|
+
}
|
|
50168
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
50169
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
50170
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
50171
|
+
}
|
|
50172
|
+
|
|
50173
|
+
return this.apiClient.callApi(
|
|
50174
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
50175
|
+
'PATCH',
|
|
50176
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
50177
|
+
{ },
|
|
50178
|
+
{ },
|
|
50179
|
+
{ },
|
|
50180
|
+
opts['body'],
|
|
50181
|
+
['PureCloud OAuth'],
|
|
50182
|
+
['application/json'],
|
|
50183
|
+
['application/json']
|
|
50184
|
+
);
|
|
50185
|
+
}
|
|
50186
|
+
|
|
50187
|
+
/**
|
|
50188
|
+
* Updates a time off plan
|
|
50189
|
+
*
|
|
50190
|
+
* @param {String} managementUnitId The management unit ID.
|
|
50191
|
+
* @param {String} timeOffPlanId The ID of the time off plan to update
|
|
50192
|
+
* @param {Object} opts Optional parameters
|
|
50193
|
+
* @param {Object} opts.body body
|
|
50194
|
+
*/
|
|
50195
|
+
patchWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId, opts) {
|
|
50196
|
+
opts = opts || {};
|
|
50197
|
+
|
|
50198
|
+
// verify the required parameter 'managementUnitId' is set
|
|
50199
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
50200
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
50201
|
+
}
|
|
50202
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
50203
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
50204
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
50205
|
+
}
|
|
50206
|
+
|
|
50207
|
+
return this.apiClient.callApi(
|
|
50208
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
50209
|
+
'PATCH',
|
|
50210
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
50211
|
+
{ },
|
|
50212
|
+
{ },
|
|
50213
|
+
{ },
|
|
50214
|
+
opts['body'],
|
|
50215
|
+
['PureCloud OAuth'],
|
|
50216
|
+
['application/json'],
|
|
50217
|
+
['application/json']
|
|
50218
|
+
);
|
|
50219
|
+
}
|
|
50220
|
+
|
|
49807
50221
|
/**
|
|
49808
50222
|
* Update a time off request
|
|
49809
50223
|
*
|
|
@@ -50665,6 +51079,93 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50665
51079
|
);
|
|
50666
51080
|
}
|
|
50667
51081
|
|
|
51082
|
+
/**
|
|
51083
|
+
* Creates a new time off limit object under management unit.
|
|
51084
|
+
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
51085
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51086
|
+
* @param {Object} opts Optional parameters
|
|
51087
|
+
* @param {Object} opts.body body
|
|
51088
|
+
*/
|
|
51089
|
+
postWorkforcemanagementManagementunitTimeofflimits(managementUnitId, opts) {
|
|
51090
|
+
opts = opts || {};
|
|
51091
|
+
|
|
51092
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51093
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51094
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimits';
|
|
51095
|
+
}
|
|
51096
|
+
|
|
51097
|
+
return this.apiClient.callApi(
|
|
51098
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits',
|
|
51099
|
+
'POST',
|
|
51100
|
+
{ 'managementUnitId': managementUnitId },
|
|
51101
|
+
{ },
|
|
51102
|
+
{ },
|
|
51103
|
+
{ },
|
|
51104
|
+
opts['body'],
|
|
51105
|
+
['PureCloud OAuth'],
|
|
51106
|
+
['application/json'],
|
|
51107
|
+
['application/json']
|
|
51108
|
+
);
|
|
51109
|
+
}
|
|
51110
|
+
|
|
51111
|
+
/**
|
|
51112
|
+
* Retrieves time off limit related values based on a given set of filters.
|
|
51113
|
+
*
|
|
51114
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51115
|
+
* @param {Object} opts Optional parameters
|
|
51116
|
+
* @param {Object} opts.body body
|
|
51117
|
+
*/
|
|
51118
|
+
postWorkforcemanagementManagementunitTimeofflimitsValuesQuery(managementUnitId, opts) {
|
|
51119
|
+
opts = opts || {};
|
|
51120
|
+
|
|
51121
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51122
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51123
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimitsValuesQuery';
|
|
51124
|
+
}
|
|
51125
|
+
|
|
51126
|
+
return this.apiClient.callApi(
|
|
51127
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/values/query',
|
|
51128
|
+
'POST',
|
|
51129
|
+
{ 'managementUnitId': managementUnitId },
|
|
51130
|
+
{ },
|
|
51131
|
+
{ },
|
|
51132
|
+
{ },
|
|
51133
|
+
opts['body'],
|
|
51134
|
+
['PureCloud OAuth'],
|
|
51135
|
+
['application/json'],
|
|
51136
|
+
['application/json']
|
|
51137
|
+
);
|
|
51138
|
+
}
|
|
51139
|
+
|
|
51140
|
+
/**
|
|
51141
|
+
* Creates a new time off plan
|
|
51142
|
+
*
|
|
51143
|
+
* @param {String} managementUnitId The management unit ID.
|
|
51144
|
+
* @param {Object} opts Optional parameters
|
|
51145
|
+
* @param {Object} opts.body body
|
|
51146
|
+
*/
|
|
51147
|
+
postWorkforcemanagementManagementunitTimeoffplans(managementUnitId, opts) {
|
|
51148
|
+
opts = opts || {};
|
|
51149
|
+
|
|
51150
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51151
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51152
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffplans';
|
|
51153
|
+
}
|
|
51154
|
+
|
|
51155
|
+
return this.apiClient.callApi(
|
|
51156
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans',
|
|
51157
|
+
'POST',
|
|
51158
|
+
{ 'managementUnitId': managementUnitId },
|
|
51159
|
+
{ },
|
|
51160
|
+
{ },
|
|
51161
|
+
{ },
|
|
51162
|
+
opts['body'],
|
|
51163
|
+
['PureCloud OAuth'],
|
|
51164
|
+
['application/json'],
|
|
51165
|
+
['application/json']
|
|
51166
|
+
);
|
|
51167
|
+
}
|
|
51168
|
+
|
|
50668
51169
|
/**
|
|
50669
51170
|
* Create a new time off request
|
|
50670
51171
|
*
|
|
@@ -50723,6 +51224,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50723
51224
|
);
|
|
50724
51225
|
}
|
|
50725
51226
|
|
|
51227
|
+
/**
|
|
51228
|
+
* Retrieves daily waitlist position for a list of time off requests
|
|
51229
|
+
*
|
|
51230
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51231
|
+
* @param {Object} opts Optional parameters
|
|
51232
|
+
* @param {Object} opts.body body
|
|
51233
|
+
*/
|
|
51234
|
+
postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery(managementUnitId, opts) {
|
|
51235
|
+
opts = opts || {};
|
|
51236
|
+
|
|
51237
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51238
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51239
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery';
|
|
51240
|
+
}
|
|
51241
|
+
|
|
51242
|
+
return this.apiClient.callApi(
|
|
51243
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/waitlistpositions/query',
|
|
51244
|
+
'POST',
|
|
51245
|
+
{ 'managementUnitId': managementUnitId },
|
|
51246
|
+
{ },
|
|
51247
|
+
{ },
|
|
51248
|
+
{ },
|
|
51249
|
+
opts['body'],
|
|
51250
|
+
['PureCloud OAuth'],
|
|
51251
|
+
['application/json'],
|
|
51252
|
+
['application/json']
|
|
51253
|
+
);
|
|
51254
|
+
}
|
|
51255
|
+
|
|
50726
51256
|
/**
|
|
50727
51257
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
50728
51258
|
*
|
|
@@ -51106,6 +51636,30 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51106
51636
|
);
|
|
51107
51637
|
}
|
|
51108
51638
|
|
|
51639
|
+
/**
|
|
51640
|
+
* Queries available time off for the current user
|
|
51641
|
+
*
|
|
51642
|
+
* @param {Object} opts Optional parameters
|
|
51643
|
+
* @param {Object} opts.body body
|
|
51644
|
+
*/
|
|
51645
|
+
postWorkforcemanagementTimeofflimitsAvailableQuery(opts) {
|
|
51646
|
+
opts = opts || {};
|
|
51647
|
+
|
|
51648
|
+
|
|
51649
|
+
return this.apiClient.callApi(
|
|
51650
|
+
'/api/v2/workforcemanagement/timeofflimits/available/query',
|
|
51651
|
+
'POST',
|
|
51652
|
+
{ },
|
|
51653
|
+
{ },
|
|
51654
|
+
{ },
|
|
51655
|
+
{ },
|
|
51656
|
+
opts['body'],
|
|
51657
|
+
['PureCloud OAuth'],
|
|
51658
|
+
['application/json'],
|
|
51659
|
+
['application/json']
|
|
51660
|
+
);
|
|
51661
|
+
}
|
|
51662
|
+
|
|
51109
51663
|
/**
|
|
51110
51664
|
* Create a time off request for the current user
|
|
51111
51665
|
*
|
|
@@ -51130,6 +51684,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51130
51684
|
);
|
|
51131
51685
|
}
|
|
51132
51686
|
|
|
51687
|
+
/**
|
|
51688
|
+
* Sets daily values for a date range of time off limit object
|
|
51689
|
+
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
51690
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51691
|
+
* @param {String} timeOffLimitId The ID of the time off limit object to set values for
|
|
51692
|
+
* @param {Object} opts Optional parameters
|
|
51693
|
+
* @param {Object} opts.body body
|
|
51694
|
+
*/
|
|
51695
|
+
putWorkforcemanagementManagementunitTimeofflimitValues(managementUnitId, timeOffLimitId, opts) {
|
|
51696
|
+
opts = opts || {};
|
|
51697
|
+
|
|
51698
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51699
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51700
|
+
throw 'Missing the required parameter "managementUnitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
51701
|
+
}
|
|
51702
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
51703
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
51704
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
51705
|
+
}
|
|
51706
|
+
|
|
51707
|
+
return this.apiClient.callApi(
|
|
51708
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}/values',
|
|
51709
|
+
'PUT',
|
|
51710
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
51711
|
+
{ },
|
|
51712
|
+
{ },
|
|
51713
|
+
{ },
|
|
51714
|
+
opts['body'],
|
|
51715
|
+
['PureCloud OAuth'],
|
|
51716
|
+
['application/json'],
|
|
51717
|
+
['application/json']
|
|
51718
|
+
);
|
|
51719
|
+
}
|
|
51720
|
+
|
|
51133
51721
|
}
|
|
51134
51722
|
|
|
51135
51723
|
/**
|
|
@@ -51161,7 +51749,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51161
51749
|
* </pre>
|
|
51162
51750
|
* </p>
|
|
51163
51751
|
* @module purecloud-platform-client-v2/index
|
|
51164
|
-
* @version
|
|
51752
|
+
* @version 126.0.0
|
|
51165
51753
|
*/
|
|
51166
51754
|
class platformClient {
|
|
51167
51755
|
constructor() {
|