purecloud-platform-client-v2 124.0.0 → 127.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 +936 -138
- package/dist/web-amd/purecloud-platform-client-v2.js +936 -138
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +896 -142
- package/dist/web-cjs/purecloud-platform-client-v2.js +909 -1305
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +403 -36
- 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 -1
- 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 +7 -3
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +21 -10
- 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 +116 -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/configuration.js +42 -35
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -256,27 +256,29 @@ class Configuration {
|
|
|
256
256
|
}
|
|
257
257
|
|
|
258
258
|
liveLoadConfig() {
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
// do nothing
|
|
259
|
+
if (typeof window === 'undefined') {
|
|
260
|
+
// Please don't remove the typeof window === 'undefined' check here!
|
|
261
|
+
// This safeguards the browser environment from using `fs`, which is only
|
|
262
|
+
// available in node environment.
|
|
263
|
+
this.updateConfigFromFile();
|
|
264
|
+
|
|
265
|
+
if (this.live_reload_config && this.live_reload_config === true) {
|
|
266
|
+
try {
|
|
267
|
+
const fs = require('fs');
|
|
268
|
+
fs.watchFile(this.configPath, { persistent: false }, (eventType, filename) => {
|
|
269
|
+
this.updateConfigFromFile();
|
|
270
|
+
if (!this.live_reload_config) {
|
|
271
|
+
fs.unwatchFile(this.configPath);
|
|
272
|
+
}
|
|
273
|
+
});
|
|
274
|
+
} catch (err) {
|
|
275
|
+
// do nothing
|
|
276
|
+
}
|
|
278
277
|
}
|
|
278
|
+
return;
|
|
279
279
|
}
|
|
280
|
+
// If in browser, don't read config file, use default values
|
|
281
|
+
this.configPath = '';
|
|
280
282
|
}
|
|
281
283
|
|
|
282
284
|
setConfigPath(path) {
|
|
@@ -287,24 +289,29 @@ class Configuration {
|
|
|
287
289
|
}
|
|
288
290
|
|
|
289
291
|
updateConfigFromFile() {
|
|
290
|
-
|
|
292
|
+
if (typeof window === 'undefined') {
|
|
293
|
+
// Please don't remove the typeof window === 'undefined' check here!
|
|
294
|
+
// This safeguards the browser environment from using `fs`, which is only
|
|
295
|
+
// available in node environment.
|
|
296
|
+
const ConfigParser = require('configparser');
|
|
291
297
|
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
298
|
+
try {
|
|
299
|
+
var configparser = new ConfigParser();
|
|
300
|
+
configparser.read(this.configPath); // If no error catched, indicates it's INI format
|
|
301
|
+
this.config = configparser;
|
|
302
|
+
} catch (error) {
|
|
303
|
+
if (error.name && error.name === 'MissingSectionHeaderError') {
|
|
304
|
+
// Not INI format, see if it's JSON format
|
|
305
|
+
const fs = require('fs');
|
|
306
|
+
var configData = fs.readFileSync(this.configPath, 'utf8');
|
|
307
|
+
this.config = {
|
|
308
|
+
_sections: JSON.parse(configData), // To match INI data format
|
|
309
|
+
};
|
|
310
|
+
}
|
|
304
311
|
}
|
|
305
|
-
}
|
|
306
312
|
|
|
307
|
-
|
|
313
|
+
if (this.config) this.updateConfigValues();
|
|
314
|
+
}
|
|
308
315
|
}
|
|
309
316
|
|
|
310
317
|
updateConfigValues() {
|
|
@@ -386,7 +393,7 @@ class Configuration {
|
|
|
386
393
|
|
|
387
394
|
/**
|
|
388
395
|
* @module purecloud-platform-client-v2/ApiClient
|
|
389
|
-
* @version
|
|
396
|
+
* @version 127.0.0
|
|
390
397
|
*/
|
|
391
398
|
class ApiClient {
|
|
392
399
|
/**
|
|
@@ -1333,7 +1340,7 @@ class ApiClient {
|
|
|
1333
1340
|
|
|
1334
1341
|
// set header parameters
|
|
1335
1342
|
request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
|
|
1336
|
-
//request.set({ 'purecloud-sdk': '
|
|
1343
|
+
//request.set({ 'purecloud-sdk': '127.0.0' });
|
|
1337
1344
|
|
|
1338
1345
|
// set request timeout
|
|
1339
1346
|
request.timeout(that.timeout);
|
|
@@ -1433,7 +1440,7 @@ class AlertingApi {
|
|
|
1433
1440
|
/**
|
|
1434
1441
|
* Alerting service.
|
|
1435
1442
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1436
|
-
* @version
|
|
1443
|
+
* @version 127.0.0
|
|
1437
1444
|
*/
|
|
1438
1445
|
|
|
1439
1446
|
/**
|
|
@@ -1747,7 +1754,7 @@ class AnalyticsApi {
|
|
|
1747
1754
|
/**
|
|
1748
1755
|
* Analytics service.
|
|
1749
1756
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1750
|
-
* @version
|
|
1757
|
+
* @version 127.0.0
|
|
1751
1758
|
*/
|
|
1752
1759
|
|
|
1753
1760
|
/**
|
|
@@ -2343,31 +2350,6 @@ class AnalyticsApi {
|
|
|
2343
2350
|
);
|
|
2344
2351
|
}
|
|
2345
2352
|
|
|
2346
|
-
/**
|
|
2347
|
-
* Patch AnalyticsReportingSettings values for an organization
|
|
2348
|
-
*
|
|
2349
|
-
* @param {Object} body AnalyticsReportingSettingsRequest
|
|
2350
|
-
*/
|
|
2351
|
-
patchAnalyticsReportingSettings(body) {
|
|
2352
|
-
// verify the required parameter 'body' is set
|
|
2353
|
-
if (body === undefined || body === null) {
|
|
2354
|
-
throw 'Missing the required parameter "body" when calling patchAnalyticsReportingSettings';
|
|
2355
|
-
}
|
|
2356
|
-
|
|
2357
|
-
return this.apiClient.callApi(
|
|
2358
|
-
'/api/v2/analytics/reporting/settings',
|
|
2359
|
-
'PATCH',
|
|
2360
|
-
{ },
|
|
2361
|
-
{ },
|
|
2362
|
-
{ },
|
|
2363
|
-
{ },
|
|
2364
|
-
body,
|
|
2365
|
-
['PureCloud OAuth'],
|
|
2366
|
-
['application/json'],
|
|
2367
|
-
['application/json']
|
|
2368
|
-
);
|
|
2369
|
-
}
|
|
2370
|
-
|
|
2371
2353
|
/**
|
|
2372
2354
|
* Query for bot aggregates
|
|
2373
2355
|
*
|
|
@@ -2909,7 +2891,7 @@ class ArchitectApi {
|
|
|
2909
2891
|
/**
|
|
2910
2892
|
* Architect service.
|
|
2911
2893
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2912
|
-
* @version
|
|
2894
|
+
* @version 127.0.0
|
|
2913
2895
|
*/
|
|
2914
2896
|
|
|
2915
2897
|
/**
|
|
@@ -5905,7 +5887,7 @@ class AuditApi {
|
|
|
5905
5887
|
/**
|
|
5906
5888
|
* Audit service.
|
|
5907
5889
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
5908
|
-
* @version
|
|
5890
|
+
* @version 127.0.0
|
|
5909
5891
|
*/
|
|
5910
5892
|
|
|
5911
5893
|
/**
|
|
@@ -6076,7 +6058,7 @@ class AuthorizationApi {
|
|
|
6076
6058
|
/**
|
|
6077
6059
|
* Authorization service.
|
|
6078
6060
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6079
|
-
* @version
|
|
6061
|
+
* @version 127.0.0
|
|
6080
6062
|
*/
|
|
6081
6063
|
|
|
6082
6064
|
/**
|
|
@@ -7259,7 +7241,7 @@ class BillingApi {
|
|
|
7259
7241
|
/**
|
|
7260
7242
|
* Billing service.
|
|
7261
7243
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7262
|
-
* @version
|
|
7244
|
+
* @version 127.0.0
|
|
7263
7245
|
*/
|
|
7264
7246
|
|
|
7265
7247
|
/**
|
|
@@ -7339,7 +7321,7 @@ class ChatApi {
|
|
|
7339
7321
|
/**
|
|
7340
7322
|
* Chat service.
|
|
7341
7323
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7342
|
-
* @version
|
|
7324
|
+
* @version 127.0.0
|
|
7343
7325
|
*/
|
|
7344
7326
|
|
|
7345
7327
|
/**
|
|
@@ -7430,7 +7412,7 @@ class CoachingApi {
|
|
|
7430
7412
|
/**
|
|
7431
7413
|
* Coaching service.
|
|
7432
7414
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7433
|
-
* @version
|
|
7415
|
+
* @version 127.0.0
|
|
7434
7416
|
*/
|
|
7435
7417
|
|
|
7436
7418
|
/**
|
|
@@ -8005,7 +7987,7 @@ class ContentManagementApi {
|
|
|
8005
7987
|
/**
|
|
8006
7988
|
* ContentManagement service.
|
|
8007
7989
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8008
|
-
* @version
|
|
7990
|
+
* @version 127.0.0
|
|
8009
7991
|
*/
|
|
8010
7992
|
|
|
8011
7993
|
/**
|
|
@@ -9145,7 +9127,7 @@ class ConversationsApi {
|
|
|
9145
9127
|
/**
|
|
9146
9128
|
* Conversations service.
|
|
9147
9129
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9148
|
-
* @version
|
|
9130
|
+
* @version 127.0.0
|
|
9149
9131
|
*/
|
|
9150
9132
|
|
|
9151
9133
|
/**
|
|
@@ -13534,7 +13516,7 @@ class DataExtensionsApi {
|
|
|
13534
13516
|
/**
|
|
13535
13517
|
* DataExtensions service.
|
|
13536
13518
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
13537
|
-
* @version
|
|
13519
|
+
* @version 127.0.0
|
|
13538
13520
|
*/
|
|
13539
13521
|
|
|
13540
13522
|
/**
|
|
@@ -13620,7 +13602,7 @@ class ExternalContactsApi {
|
|
|
13620
13602
|
/**
|
|
13621
13603
|
* ExternalContacts service.
|
|
13622
13604
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
13623
|
-
* @version
|
|
13605
|
+
* @version 127.0.0
|
|
13624
13606
|
*/
|
|
13625
13607
|
|
|
13626
13608
|
/**
|
|
@@ -15363,7 +15345,7 @@ class FaxApi {
|
|
|
15363
15345
|
/**
|
|
15364
15346
|
* Fax service.
|
|
15365
15347
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
15366
|
-
* @version
|
|
15348
|
+
* @version 127.0.0
|
|
15367
15349
|
*/
|
|
15368
15350
|
|
|
15369
15351
|
/**
|
|
@@ -15534,7 +15516,7 @@ class FlowsApi {
|
|
|
15534
15516
|
/**
|
|
15535
15517
|
* Flows service.
|
|
15536
15518
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
15537
|
-
* @version
|
|
15519
|
+
* @version 127.0.0
|
|
15538
15520
|
*/
|
|
15539
15521
|
|
|
15540
15522
|
/**
|
|
@@ -15605,7 +15587,7 @@ class GamificationApi {
|
|
|
15605
15587
|
/**
|
|
15606
15588
|
* Gamification service.
|
|
15607
15589
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
15608
|
-
* @version
|
|
15590
|
+
* @version 127.0.0
|
|
15609
15591
|
*/
|
|
15610
15592
|
|
|
15611
15593
|
/**
|
|
@@ -16911,7 +16893,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
16911
16893
|
/**
|
|
16912
16894
|
* GeneralDataProtectionRegulation service.
|
|
16913
16895
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
16914
|
-
* @version
|
|
16896
|
+
* @version 127.0.0
|
|
16915
16897
|
*/
|
|
16916
16898
|
|
|
16917
16899
|
/**
|
|
@@ -17041,7 +17023,7 @@ class GeolocationApi {
|
|
|
17041
17023
|
/**
|
|
17042
17024
|
* Geolocation service.
|
|
17043
17025
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
17044
|
-
* @version
|
|
17026
|
+
* @version 127.0.0
|
|
17045
17027
|
*/
|
|
17046
17028
|
|
|
17047
17029
|
/**
|
|
@@ -17172,7 +17154,7 @@ class GreetingsApi {
|
|
|
17172
17154
|
/**
|
|
17173
17155
|
* Greetings service.
|
|
17174
17156
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
17175
|
-
* @version
|
|
17157
|
+
* @version 127.0.0
|
|
17176
17158
|
*/
|
|
17177
17159
|
|
|
17178
17160
|
/**
|
|
@@ -17627,7 +17609,7 @@ class GroupsApi {
|
|
|
17627
17609
|
/**
|
|
17628
17610
|
* Groups service.
|
|
17629
17611
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
17630
|
-
* @version
|
|
17612
|
+
* @version 127.0.0
|
|
17631
17613
|
*/
|
|
17632
17614
|
|
|
17633
17615
|
/**
|
|
@@ -18032,7 +18014,7 @@ class IdentityProviderApi {
|
|
|
18032
18014
|
/**
|
|
18033
18015
|
* IdentityProvider service.
|
|
18034
18016
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
18035
|
-
* @version
|
|
18017
|
+
* @version 127.0.0
|
|
18036
18018
|
*/
|
|
18037
18019
|
|
|
18038
18020
|
/**
|
|
@@ -18788,7 +18770,7 @@ class IntegrationsApi {
|
|
|
18788
18770
|
/**
|
|
18789
18771
|
* Integrations service.
|
|
18790
18772
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
18791
|
-
* @version
|
|
18773
|
+
* @version 127.0.0
|
|
18792
18774
|
*/
|
|
18793
18775
|
|
|
18794
18776
|
/**
|
|
@@ -20434,7 +20416,7 @@ class JourneyApi {
|
|
|
20434
20416
|
/**
|
|
20435
20417
|
* Journey service.
|
|
20436
20418
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
20437
|
-
* @version
|
|
20419
|
+
* @version 127.0.0
|
|
20438
20420
|
*/
|
|
20439
20421
|
|
|
20440
20422
|
/**
|
|
@@ -21145,7 +21127,7 @@ class KnowledgeApi {
|
|
|
21145
21127
|
/**
|
|
21146
21128
|
* Knowledge service.
|
|
21147
21129
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
21148
|
-
* @version
|
|
21130
|
+
* @version 127.0.0
|
|
21149
21131
|
*/
|
|
21150
21132
|
|
|
21151
21133
|
/**
|
|
@@ -22045,7 +22027,7 @@ class LanguageUnderstandingApi {
|
|
|
22045
22027
|
/**
|
|
22046
22028
|
* LanguageUnderstanding service.
|
|
22047
22029
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
22048
|
-
* @version
|
|
22030
|
+
* @version 127.0.0
|
|
22049
22031
|
*/
|
|
22050
22032
|
|
|
22051
22033
|
/**
|
|
@@ -22611,7 +22593,7 @@ class LanguageUnderstandingApi {
|
|
|
22611
22593
|
}
|
|
22612
22594
|
|
|
22613
22595
|
/**
|
|
22614
|
-
* Save information for the draft
|
|
22596
|
+
* Save information for the draft. Either topic draft or intent draft should be sent.
|
|
22615
22597
|
*
|
|
22616
22598
|
* @param {String} minerId Miner ID
|
|
22617
22599
|
* @param {String} draftId Draft ID
|
|
@@ -22855,7 +22837,7 @@ class LanguageUnderstandingApi {
|
|
|
22855
22837
|
}
|
|
22856
22838
|
|
|
22857
22839
|
/**
|
|
22858
|
-
* 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.
|
|
22859
22841
|
*
|
|
22860
22842
|
* @param {String} minerId Miner ID
|
|
22861
22843
|
* @param {Object} opts Optional parameters
|
|
@@ -22949,7 +22931,7 @@ class LanguagesApi {
|
|
|
22949
22931
|
/**
|
|
22950
22932
|
* Languages service.
|
|
22951
22933
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
22952
|
-
* @version
|
|
22934
|
+
* @version 127.0.0
|
|
22953
22935
|
*/
|
|
22954
22936
|
|
|
22955
22937
|
/**
|
|
@@ -23217,7 +23199,7 @@ class LearningApi {
|
|
|
23217
23199
|
/**
|
|
23218
23200
|
* Learning service.
|
|
23219
23201
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
23220
|
-
* @version
|
|
23202
|
+
* @version 127.0.0
|
|
23221
23203
|
*/
|
|
23222
23204
|
|
|
23223
23205
|
/**
|
|
@@ -23808,7 +23790,7 @@ class LicenseApi {
|
|
|
23808
23790
|
/**
|
|
23809
23791
|
* License service.
|
|
23810
23792
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
23811
|
-
* @version
|
|
23793
|
+
* @version 127.0.0
|
|
23812
23794
|
*/
|
|
23813
23795
|
|
|
23814
23796
|
/**
|
|
@@ -24046,7 +24028,7 @@ class LocationsApi {
|
|
|
24046
24028
|
/**
|
|
24047
24029
|
* Locations service.
|
|
24048
24030
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
24049
|
-
* @version
|
|
24031
|
+
* @version 127.0.0
|
|
24050
24032
|
*/
|
|
24051
24033
|
|
|
24052
24034
|
/**
|
|
@@ -24282,7 +24264,7 @@ class MobileDevicesApi {
|
|
|
24282
24264
|
/**
|
|
24283
24265
|
* MobileDevices service.
|
|
24284
24266
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
24285
|
-
* @version
|
|
24267
|
+
* @version 127.0.0
|
|
24286
24268
|
*/
|
|
24287
24269
|
|
|
24288
24270
|
/**
|
|
@@ -24433,7 +24415,7 @@ class NotificationsApi {
|
|
|
24433
24415
|
/**
|
|
24434
24416
|
* Notifications service.
|
|
24435
24417
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
24436
|
-
* @version
|
|
24418
|
+
* @version 127.0.0
|
|
24437
24419
|
*/
|
|
24438
24420
|
|
|
24439
24421
|
/**
|
|
@@ -24658,7 +24640,7 @@ class OAuthApi {
|
|
|
24658
24640
|
/**
|
|
24659
24641
|
* OAuth service.
|
|
24660
24642
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
24661
|
-
* @version
|
|
24643
|
+
* @version 127.0.0
|
|
24662
24644
|
*/
|
|
24663
24645
|
|
|
24664
24646
|
/**
|
|
@@ -25016,7 +24998,7 @@ class ObjectsApi {
|
|
|
25016
24998
|
/**
|
|
25017
24999
|
* Objects service.
|
|
25018
25000
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
25019
|
-
* @version
|
|
25001
|
+
* @version 127.0.0
|
|
25020
25002
|
*/
|
|
25021
25003
|
|
|
25022
25004
|
/**
|
|
@@ -25287,7 +25269,7 @@ class OrganizationApi {
|
|
|
25287
25269
|
/**
|
|
25288
25270
|
* Organization service.
|
|
25289
25271
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
25290
|
-
* @version
|
|
25272
|
+
* @version 127.0.0
|
|
25291
25273
|
*/
|
|
25292
25274
|
|
|
25293
25275
|
/**
|
|
@@ -25690,7 +25672,7 @@ class OrganizationAuthorizationApi {
|
|
|
25690
25672
|
/**
|
|
25691
25673
|
* OrganizationAuthorization service.
|
|
25692
25674
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
25693
|
-
* @version
|
|
25675
|
+
* @version 127.0.0
|
|
25694
25676
|
*/
|
|
25695
25677
|
|
|
25696
25678
|
/**
|
|
@@ -25730,6 +25712,36 @@ class OrganizationAuthorizationApi {
|
|
|
25730
25712
|
);
|
|
25731
25713
|
}
|
|
25732
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
|
+
|
|
25733
25745
|
/**
|
|
25734
25746
|
* Delete Trustee User
|
|
25735
25747
|
*
|
|
@@ -25815,6 +25827,36 @@ class OrganizationAuthorizationApi {
|
|
|
25815
25827
|
);
|
|
25816
25828
|
}
|
|
25817
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
|
+
|
|
25818
25860
|
/**
|
|
25819
25861
|
* Delete Trustee User
|
|
25820
25862
|
*
|
|
@@ -25895,6 +25937,31 @@ class OrganizationAuthorizationApi {
|
|
|
25895
25937
|
);
|
|
25896
25938
|
}
|
|
25897
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
|
+
|
|
25898
25965
|
/**
|
|
25899
25966
|
* Get Trustee User
|
|
25900
25967
|
*
|
|
@@ -26010,6 +26077,26 @@ class OrganizationAuthorizationApi {
|
|
|
26010
26077
|
);
|
|
26011
26078
|
}
|
|
26012
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
|
+
|
|
26013
26100
|
/**
|
|
26014
26101
|
* Get Org Trust
|
|
26015
26102
|
*
|
|
@@ -26035,6 +26122,61 @@ class OrganizationAuthorizationApi {
|
|
|
26035
26122
|
);
|
|
26036
26123
|
}
|
|
26037
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
|
+
|
|
26038
26180
|
/**
|
|
26039
26181
|
* Get Trustee User
|
|
26040
26182
|
*
|
|
@@ -26232,6 +26374,31 @@ class OrganizationAuthorizationApi {
|
|
|
26232
26374
|
);
|
|
26233
26375
|
}
|
|
26234
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
|
+
|
|
26235
26402
|
/**
|
|
26236
26403
|
* Get Org Trustor Audits
|
|
26237
26404
|
*
|
|
@@ -26364,6 +26531,36 @@ class OrganizationAuthorizationApi {
|
|
|
26364
26531
|
);
|
|
26365
26532
|
}
|
|
26366
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
|
+
|
|
26367
26564
|
/**
|
|
26368
26565
|
* Add a Trustee user to the trust.
|
|
26369
26566
|
*
|
|
@@ -26400,7 +26597,7 @@ class OutboundApi {
|
|
|
26400
26597
|
/**
|
|
26401
26598
|
* Outbound service.
|
|
26402
26599
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
26403
|
-
* @version
|
|
26600
|
+
* @version 127.0.0
|
|
26404
26601
|
*/
|
|
26405
26602
|
|
|
26406
26603
|
/**
|
|
@@ -29426,7 +29623,7 @@ class PresenceApi {
|
|
|
29426
29623
|
/**
|
|
29427
29624
|
* Presence service.
|
|
29428
29625
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
29429
|
-
* @version
|
|
29626
|
+
* @version 127.0.0
|
|
29430
29627
|
*/
|
|
29431
29628
|
|
|
29432
29629
|
/**
|
|
@@ -29798,7 +29995,7 @@ class QualityApi {
|
|
|
29798
29995
|
/**
|
|
29799
29996
|
* Quality service.
|
|
29800
29997
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
29801
|
-
* @version
|
|
29998
|
+
* @version 127.0.0
|
|
29802
29999
|
*/
|
|
29803
30000
|
|
|
29804
30001
|
/**
|
|
@@ -30171,7 +30368,7 @@ class QualityApi {
|
|
|
30171
30368
|
|
|
30172
30369
|
/**
|
|
30173
30370
|
* Queries Evaluations and returns a paged list
|
|
30174
|
-
* 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.
|
|
30175
30372
|
* @param {Object} opts Optional parameters
|
|
30176
30373
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
30177
30374
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -31326,7 +31523,7 @@ class RecordingApi {
|
|
|
31326
31523
|
/**
|
|
31327
31524
|
* Recording service.
|
|
31328
31525
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
31329
|
-
* @version
|
|
31526
|
+
* @version 127.0.0
|
|
31330
31527
|
*/
|
|
31331
31528
|
|
|
31332
31529
|
/**
|
|
@@ -31922,6 +32119,8 @@ class RecordingApi {
|
|
|
31922
32119
|
* @param {Object} opts Optional parameters
|
|
31923
32120
|
* @param {Number} opts.pageSize Page size. Maximum is 100. (default to 25)
|
|
31924
32121
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
32122
|
+
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
|
|
32123
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
31925
32124
|
*/
|
|
31926
32125
|
getRecordingJobFailedrecordings(jobId, opts) {
|
|
31927
32126
|
opts = opts || {};
|
|
@@ -31935,7 +32134,7 @@ class RecordingApi {
|
|
|
31935
32134
|
'/api/v2/recording/jobs/{jobId}/failedrecordings',
|
|
31936
32135
|
'GET',
|
|
31937
32136
|
{ 'jobId': jobId },
|
|
31938
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
32137
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] },
|
|
31939
32138
|
{ },
|
|
31940
32139
|
{ },
|
|
31941
32140
|
null,
|
|
@@ -31955,6 +32154,8 @@ class RecordingApi {
|
|
|
31955
32154
|
* @param {Object} opts.state Filter by state
|
|
31956
32155
|
* @param {Boolean} opts.showOnlyMyJobs Show only my jobs
|
|
31957
32156
|
* @param {Object} opts.jobType Job Type (Can be left empty for both)
|
|
32157
|
+
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
|
|
32158
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
31958
32159
|
*/
|
|
31959
32160
|
getRecordingJobs(opts) {
|
|
31960
32161
|
opts = opts || {};
|
|
@@ -31964,7 +32165,7 @@ class RecordingApi {
|
|
|
31964
32165
|
'/api/v2/recording/jobs',
|
|
31965
32166
|
'GET',
|
|
31966
32167
|
{ },
|
|
31967
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'state': opts['state'],'showOnlyMyJobs': opts['showOnlyMyJobs'],'jobType': opts['jobType'] },
|
|
32168
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'state': opts['state'],'showOnlyMyJobs': opts['showOnlyMyJobs'],'jobType': opts['jobType'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] },
|
|
31968
32169
|
{ },
|
|
31969
32170
|
{ },
|
|
31970
32171
|
null,
|
|
@@ -32845,7 +33046,7 @@ class ResponseManagementApi {
|
|
|
32845
33046
|
/**
|
|
32846
33047
|
* ResponseManagement service.
|
|
32847
33048
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
32848
|
-
* @version
|
|
33049
|
+
* @version 127.0.0
|
|
32849
33050
|
*/
|
|
32850
33051
|
|
|
32851
33052
|
/**
|
|
@@ -33170,7 +33371,7 @@ class RoutingApi {
|
|
|
33170
33371
|
/**
|
|
33171
33372
|
* Routing service.
|
|
33172
33373
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
33173
|
-
* @version
|
|
33374
|
+
* @version 127.0.0
|
|
33174
33375
|
*/
|
|
33175
33376
|
|
|
33176
33377
|
/**
|
|
@@ -33483,8 +33684,12 @@ class RoutingApi {
|
|
|
33483
33684
|
* Delete a phone number provisioned for SMS.
|
|
33484
33685
|
*
|
|
33485
33686
|
* @param {String} addressId Address ID
|
|
33687
|
+
* @param {Object} opts Optional parameters
|
|
33688
|
+
* @param {Boolean} opts.async Delete a phone number for SMS in an asynchronous manner. If the async parameter value is true, this initiates the deletion of a provisioned phone number. (default to false)
|
|
33486
33689
|
*/
|
|
33487
|
-
deleteRoutingSmsPhonenumber(addressId) {
|
|
33690
|
+
deleteRoutingSmsPhonenumber(addressId, opts) {
|
|
33691
|
+
opts = opts || {};
|
|
33692
|
+
|
|
33488
33693
|
// verify the required parameter 'addressId' is set
|
|
33489
33694
|
if (addressId === undefined || addressId === null) {
|
|
33490
33695
|
throw 'Missing the required parameter "addressId" when calling deleteRoutingSmsPhonenumber';
|
|
@@ -33494,7 +33699,7 @@ class RoutingApi {
|
|
|
33494
33699
|
'/api/v2/routing/sms/phonenumbers/{addressId}',
|
|
33495
33700
|
'DELETE',
|
|
33496
33701
|
{ 'addressId': addressId },
|
|
33497
|
-
{
|
|
33702
|
+
{ 'async': opts['async'] },
|
|
33498
33703
|
{ },
|
|
33499
33704
|
{ },
|
|
33500
33705
|
null,
|
|
@@ -34322,12 +34527,11 @@ class RoutingApi {
|
|
|
34322
34527
|
}
|
|
34323
34528
|
|
|
34324
34529
|
/**
|
|
34325
|
-
* Get a paged listing of simplified queue objects. Can be used to get a digest of all queues in an organization.
|
|
34530
|
+
* Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization.
|
|
34326
34531
|
*
|
|
34327
34532
|
* @param {Object} opts Optional parameters
|
|
34328
34533
|
* @param {Number} opts.pageSize Page size [max value is 500] (default to 25)
|
|
34329
34534
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
34330
|
-
* @param {Object} opts.sortBy Sort by (default to name)
|
|
34331
34535
|
* @param {Object} opts.sortOrder Sort order (default to asc)
|
|
34332
34536
|
*/
|
|
34333
34537
|
getRoutingQueuesDivisionviewsAll(opts) {
|
|
@@ -34338,7 +34542,7 @@ class RoutingApi {
|
|
|
34338
34542
|
'/api/v2/routing/queues/divisionviews/all',
|
|
34339
34543
|
'GET',
|
|
34340
34544
|
{ },
|
|
34341
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'
|
|
34545
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'] },
|
|
34342
34546
|
{ },
|
|
34343
34547
|
{ },
|
|
34344
34548
|
null,
|
|
@@ -35641,8 +35845,12 @@ class RoutingApi {
|
|
|
35641
35845
|
* Provision a phone number for SMS
|
|
35642
35846
|
*
|
|
35643
35847
|
* @param {Object} body SmsPhoneNumber
|
|
35848
|
+
* @param {Object} opts Optional parameters
|
|
35849
|
+
* @param {Boolean} opts.async Provision a new phone number for SMS in an asynchronous manner. If the async parameter value is true, this initiates the provisioning of a new phone number. Check the phoneNumber's provisioningStatus for completion of this request. (default to false)
|
|
35644
35850
|
*/
|
|
35645
|
-
postRoutingSmsPhonenumbers(body) {
|
|
35851
|
+
postRoutingSmsPhonenumbers(body, opts) {
|
|
35852
|
+
opts = opts || {};
|
|
35853
|
+
|
|
35646
35854
|
// verify the required parameter 'body' is set
|
|
35647
35855
|
if (body === undefined || body === null) {
|
|
35648
35856
|
throw 'Missing the required parameter "body" when calling postRoutingSmsPhonenumbers';
|
|
@@ -35652,7 +35860,7 @@ class RoutingApi {
|
|
|
35652
35860
|
'/api/v2/routing/sms/phonenumbers',
|
|
35653
35861
|
'POST',
|
|
35654
35862
|
{ },
|
|
35655
|
-
{
|
|
35863
|
+
{ 'async': opts['async'] },
|
|
35656
35864
|
{ },
|
|
35657
35865
|
{ },
|
|
35658
35866
|
body,
|
|
@@ -35897,8 +36105,12 @@ class RoutingApi {
|
|
|
35897
36105
|
*
|
|
35898
36106
|
* @param {String} addressId Address ID
|
|
35899
36107
|
* @param {Object} body SmsPhoneNumber
|
|
36108
|
+
* @param {Object} opts Optional parameters
|
|
36109
|
+
* @param {Boolean} opts.async Update an existing phone number for SMS in an asynchronous manner. If the async parameter value is true, this initiates the update of a provisioned phone number. Check the phoneNumber's provisioningStatus for the progress of this request. (default to false)
|
|
35900
36110
|
*/
|
|
35901
|
-
putRoutingSmsPhonenumber(addressId, body) {
|
|
36111
|
+
putRoutingSmsPhonenumber(addressId, body, opts) {
|
|
36112
|
+
opts = opts || {};
|
|
36113
|
+
|
|
35902
36114
|
// verify the required parameter 'addressId' is set
|
|
35903
36115
|
if (addressId === undefined || addressId === null) {
|
|
35904
36116
|
throw 'Missing the required parameter "addressId" when calling putRoutingSmsPhonenumber';
|
|
@@ -35912,7 +36124,7 @@ class RoutingApi {
|
|
|
35912
36124
|
'/api/v2/routing/sms/phonenumbers/{addressId}',
|
|
35913
36125
|
'PUT',
|
|
35914
36126
|
{ 'addressId': addressId },
|
|
35915
|
-
{
|
|
36127
|
+
{ 'async': opts['async'] },
|
|
35916
36128
|
{ },
|
|
35917
36129
|
{ },
|
|
35918
36130
|
body,
|
|
@@ -36078,7 +36290,7 @@ class SCIMApi {
|
|
|
36078
36290
|
/**
|
|
36079
36291
|
* SCIM service.
|
|
36080
36292
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
36081
|
-
* @version
|
|
36293
|
+
* @version 127.0.0
|
|
36082
36294
|
*/
|
|
36083
36295
|
|
|
36084
36296
|
/**
|
|
@@ -36955,7 +37167,7 @@ class ScriptsApi {
|
|
|
36955
37167
|
/**
|
|
36956
37168
|
* Scripts service.
|
|
36957
37169
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
36958
|
-
* @version
|
|
37170
|
+
* @version 127.0.0
|
|
36959
37171
|
*/
|
|
36960
37172
|
|
|
36961
37173
|
/**
|
|
@@ -37308,7 +37520,7 @@ class SearchApi {
|
|
|
37308
37520
|
/**
|
|
37309
37521
|
* Search service.
|
|
37310
37522
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
37311
|
-
* @version
|
|
37523
|
+
* @version 127.0.0
|
|
37312
37524
|
*/
|
|
37313
37525
|
|
|
37314
37526
|
/**
|
|
@@ -37843,7 +38055,7 @@ class SpeechTextAnalyticsApi {
|
|
|
37843
38055
|
/**
|
|
37844
38056
|
* SpeechTextAnalytics service.
|
|
37845
38057
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
37846
|
-
* @version
|
|
38058
|
+
* @version 127.0.0
|
|
37847
38059
|
*/
|
|
37848
38060
|
|
|
37849
38061
|
/**
|
|
@@ -37887,6 +38099,51 @@ class SpeechTextAnalyticsApi {
|
|
|
37887
38099
|
);
|
|
37888
38100
|
}
|
|
37889
38101
|
|
|
38102
|
+
/**
|
|
38103
|
+
* Delete All Speech & Text Analytics SentimentFeedback
|
|
38104
|
+
*
|
|
38105
|
+
*/
|
|
38106
|
+
deleteSpeechandtextanalyticsSentimentfeedback() {
|
|
38107
|
+
|
|
38108
|
+
return this.apiClient.callApi(
|
|
38109
|
+
'/api/v2/speechandtextanalytics/sentimentfeedback',
|
|
38110
|
+
'DELETE',
|
|
38111
|
+
{ },
|
|
38112
|
+
{ },
|
|
38113
|
+
{ },
|
|
38114
|
+
{ },
|
|
38115
|
+
null,
|
|
38116
|
+
['PureCloud OAuth'],
|
|
38117
|
+
['application/json'],
|
|
38118
|
+
['application/json']
|
|
38119
|
+
);
|
|
38120
|
+
}
|
|
38121
|
+
|
|
38122
|
+
/**
|
|
38123
|
+
* Delete a Speech & Text Analytics SentimentFeedback by Id
|
|
38124
|
+
*
|
|
38125
|
+
* @param {String} sentimentFeedbackId The Id of the SentimentFeedback
|
|
38126
|
+
*/
|
|
38127
|
+
deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId(sentimentFeedbackId) {
|
|
38128
|
+
// verify the required parameter 'sentimentFeedbackId' is set
|
|
38129
|
+
if (sentimentFeedbackId === undefined || sentimentFeedbackId === null) {
|
|
38130
|
+
throw 'Missing the required parameter "sentimentFeedbackId" when calling deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId';
|
|
38131
|
+
}
|
|
38132
|
+
|
|
38133
|
+
return this.apiClient.callApi(
|
|
38134
|
+
'/api/v2/speechandtextanalytics/sentimentfeedback/{sentimentFeedbackId}',
|
|
38135
|
+
'DELETE',
|
|
38136
|
+
{ 'sentimentFeedbackId': sentimentFeedbackId },
|
|
38137
|
+
{ },
|
|
38138
|
+
{ },
|
|
38139
|
+
{ },
|
|
38140
|
+
null,
|
|
38141
|
+
['PureCloud OAuth'],
|
|
38142
|
+
['application/json'],
|
|
38143
|
+
['application/json']
|
|
38144
|
+
);
|
|
38145
|
+
}
|
|
38146
|
+
|
|
37890
38147
|
/**
|
|
37891
38148
|
* Delete a Speech & Text Analytics topic by id
|
|
37892
38149
|
*
|
|
@@ -37969,7 +38226,7 @@ class SpeechTextAnalyticsApi {
|
|
|
37969
38226
|
|
|
37970
38227
|
/**
|
|
37971
38228
|
* Get list of supported Speech & Text Analytics dialects
|
|
37972
|
-
*
|
|
38229
|
+
* This api has been deprecated. Use api/v2/topics/dialects instead
|
|
37973
38230
|
*/
|
|
37974
38231
|
getSpeechandtextanalyticsDialects() {
|
|
37975
38232
|
|
|
@@ -38162,6 +38419,50 @@ class SpeechTextAnalyticsApi {
|
|
|
38162
38419
|
);
|
|
38163
38420
|
}
|
|
38164
38421
|
|
|
38422
|
+
/**
|
|
38423
|
+
* Get the list of Speech & Text Analytics sentiment supported dialects
|
|
38424
|
+
*
|
|
38425
|
+
*/
|
|
38426
|
+
getSpeechandtextanalyticsSentimentDialects() {
|
|
38427
|
+
|
|
38428
|
+
return this.apiClient.callApi(
|
|
38429
|
+
'/api/v2/speechandtextanalytics/sentiment/dialects',
|
|
38430
|
+
'GET',
|
|
38431
|
+
{ },
|
|
38432
|
+
{ },
|
|
38433
|
+
{ },
|
|
38434
|
+
{ },
|
|
38435
|
+
null,
|
|
38436
|
+
['PureCloud OAuth'],
|
|
38437
|
+
['application/json'],
|
|
38438
|
+
['application/json']
|
|
38439
|
+
);
|
|
38440
|
+
}
|
|
38441
|
+
|
|
38442
|
+
/**
|
|
38443
|
+
* Get the list of Speech & Text Analytics SentimentFeedback
|
|
38444
|
+
*
|
|
38445
|
+
* @param {Object} opts Optional parameters
|
|
38446
|
+
* @param {String} opts.dialect The key for filter the listing by dialect, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard
|
|
38447
|
+
*/
|
|
38448
|
+
getSpeechandtextanalyticsSentimentfeedback(opts) {
|
|
38449
|
+
opts = opts || {};
|
|
38450
|
+
|
|
38451
|
+
|
|
38452
|
+
return this.apiClient.callApi(
|
|
38453
|
+
'/api/v2/speechandtextanalytics/sentimentfeedback',
|
|
38454
|
+
'GET',
|
|
38455
|
+
{ },
|
|
38456
|
+
{ 'dialect': opts['dialect'] },
|
|
38457
|
+
{ },
|
|
38458
|
+
{ },
|
|
38459
|
+
null,
|
|
38460
|
+
['PureCloud OAuth'],
|
|
38461
|
+
['application/json'],
|
|
38462
|
+
['application/json']
|
|
38463
|
+
);
|
|
38464
|
+
}
|
|
38465
|
+
|
|
38165
38466
|
/**
|
|
38166
38467
|
* Get Speech And Text Analytics Settings
|
|
38167
38468
|
*
|
|
@@ -38406,6 +38707,31 @@ class SpeechTextAnalyticsApi {
|
|
|
38406
38707
|
);
|
|
38407
38708
|
}
|
|
38408
38709
|
|
|
38710
|
+
/**
|
|
38711
|
+
* Create a Speech & Text Analytics SentimentFeedback
|
|
38712
|
+
*
|
|
38713
|
+
* @param {Object} body The SentimentFeedback to create
|
|
38714
|
+
*/
|
|
38715
|
+
postSpeechandtextanalyticsSentimentfeedback(body) {
|
|
38716
|
+
// verify the required parameter 'body' is set
|
|
38717
|
+
if (body === undefined || body === null) {
|
|
38718
|
+
throw 'Missing the required parameter "body" when calling postSpeechandtextanalyticsSentimentfeedback';
|
|
38719
|
+
}
|
|
38720
|
+
|
|
38721
|
+
return this.apiClient.callApi(
|
|
38722
|
+
'/api/v2/speechandtextanalytics/sentimentfeedback',
|
|
38723
|
+
'POST',
|
|
38724
|
+
{ },
|
|
38725
|
+
{ },
|
|
38726
|
+
{ },
|
|
38727
|
+
{ },
|
|
38728
|
+
body,
|
|
38729
|
+
['PureCloud OAuth'],
|
|
38730
|
+
['application/json'],
|
|
38731
|
+
['application/json']
|
|
38732
|
+
);
|
|
38733
|
+
}
|
|
38734
|
+
|
|
38409
38735
|
/**
|
|
38410
38736
|
* Create new Speech & Text Analytics topic
|
|
38411
38737
|
*
|
|
@@ -38602,7 +38928,7 @@ class StationsApi {
|
|
|
38602
38928
|
/**
|
|
38603
38929
|
* Stations service.
|
|
38604
38930
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
38605
|
-
* @version
|
|
38931
|
+
* @version 127.0.0
|
|
38606
38932
|
*/
|
|
38607
38933
|
|
|
38608
38934
|
/**
|
|
@@ -38749,7 +39075,7 @@ class SuggestApi {
|
|
|
38749
39075
|
/**
|
|
38750
39076
|
* Suggest service.
|
|
38751
39077
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
38752
|
-
* @version
|
|
39078
|
+
* @version 127.0.0
|
|
38753
39079
|
*/
|
|
38754
39080
|
|
|
38755
39081
|
/**
|
|
@@ -38888,7 +39214,7 @@ class TelephonyApi {
|
|
|
38888
39214
|
/**
|
|
38889
39215
|
* Telephony service.
|
|
38890
39216
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
38891
|
-
* @version
|
|
39217
|
+
* @version 127.0.0
|
|
38892
39218
|
*/
|
|
38893
39219
|
|
|
38894
39220
|
/**
|
|
@@ -38996,7 +39322,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
38996
39322
|
/**
|
|
38997
39323
|
* TelephonyProvidersEdge service.
|
|
38998
39324
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
38999
|
-
* @version
|
|
39325
|
+
* @version 127.0.0
|
|
39000
39326
|
*/
|
|
39001
39327
|
|
|
39002
39328
|
/**
|
|
@@ -42609,7 +42935,7 @@ class TextbotsApi {
|
|
|
42609
42935
|
/**
|
|
42610
42936
|
* Textbots service.
|
|
42611
42937
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
42612
|
-
* @version
|
|
42938
|
+
* @version 127.0.0
|
|
42613
42939
|
*/
|
|
42614
42940
|
|
|
42615
42941
|
/**
|
|
@@ -42710,7 +43036,7 @@ class TokensApi {
|
|
|
42710
43036
|
/**
|
|
42711
43037
|
* Tokens service.
|
|
42712
43038
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
42713
|
-
* @version
|
|
43039
|
+
* @version 127.0.0
|
|
42714
43040
|
*/
|
|
42715
43041
|
|
|
42716
43042
|
/**
|
|
@@ -42816,7 +43142,7 @@ class UploadsApi {
|
|
|
42816
43142
|
/**
|
|
42817
43143
|
* Uploads service.
|
|
42818
43144
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
42819
|
-
* @version
|
|
43145
|
+
* @version 127.0.0
|
|
42820
43146
|
*/
|
|
42821
43147
|
|
|
42822
43148
|
/**
|
|
@@ -42992,7 +43318,7 @@ class UsageApi {
|
|
|
42992
43318
|
/**
|
|
42993
43319
|
* Usage service.
|
|
42994
43320
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
42995
|
-
* @version
|
|
43321
|
+
* @version 127.0.0
|
|
42996
43322
|
*/
|
|
42997
43323
|
|
|
42998
43324
|
/**
|
|
@@ -43063,7 +43389,7 @@ class UserRecordingsApi {
|
|
|
43063
43389
|
/**
|
|
43064
43390
|
* UserRecordings service.
|
|
43065
43391
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
43066
|
-
* @version
|
|
43392
|
+
* @version 127.0.0
|
|
43067
43393
|
*/
|
|
43068
43394
|
|
|
43069
43395
|
/**
|
|
@@ -43247,7 +43573,7 @@ class UsersApi {
|
|
|
43247
43573
|
/**
|
|
43248
43574
|
* Users service.
|
|
43249
43575
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
43250
|
-
* @version
|
|
43576
|
+
* @version 127.0.0
|
|
43251
43577
|
*/
|
|
43252
43578
|
|
|
43253
43579
|
/**
|
|
@@ -45549,7 +45875,7 @@ class UtilitiesApi {
|
|
|
45549
45875
|
/**
|
|
45550
45876
|
* Utilities service.
|
|
45551
45877
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
45552
|
-
* @version
|
|
45878
|
+
* @version 127.0.0
|
|
45553
45879
|
*/
|
|
45554
45880
|
|
|
45555
45881
|
/**
|
|
@@ -45660,7 +45986,7 @@ class VoicemailApi {
|
|
|
45660
45986
|
/**
|
|
45661
45987
|
* Voicemail service.
|
|
45662
45988
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
45663
|
-
* @version
|
|
45989
|
+
* @version 127.0.0
|
|
45664
45990
|
*/
|
|
45665
45991
|
|
|
45666
45992
|
/**
|
|
@@ -46327,7 +46653,7 @@ class WebChatApi {
|
|
|
46327
46653
|
/**
|
|
46328
46654
|
* WebChat service.
|
|
46329
46655
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
46330
|
-
* @version
|
|
46656
|
+
* @version 127.0.0
|
|
46331
46657
|
*/
|
|
46332
46658
|
|
|
46333
46659
|
/**
|
|
@@ -46871,7 +47197,7 @@ class WebDeploymentsApi {
|
|
|
46871
47197
|
/**
|
|
46872
47198
|
* WebDeployments service.
|
|
46873
47199
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
46874
|
-
* @version
|
|
47200
|
+
* @version 127.0.0
|
|
46875
47201
|
*/
|
|
46876
47202
|
|
|
46877
47203
|
/**
|
|
@@ -47226,7 +47552,7 @@ class WebMessagingApi {
|
|
|
47226
47552
|
/**
|
|
47227
47553
|
* WebMessaging service.
|
|
47228
47554
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
47229
|
-
* @version
|
|
47555
|
+
* @version 127.0.0
|
|
47230
47556
|
*/
|
|
47231
47557
|
|
|
47232
47558
|
/**
|
|
@@ -47272,7 +47598,7 @@ class WidgetsApi {
|
|
|
47272
47598
|
/**
|
|
47273
47599
|
* Widgets service.
|
|
47274
47600
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
47275
|
-
* @version
|
|
47601
|
+
* @version 127.0.0
|
|
47276
47602
|
*/
|
|
47277
47603
|
|
|
47278
47604
|
/**
|
|
@@ -47418,7 +47744,7 @@ class WorkforceManagementApi {
|
|
|
47418
47744
|
/**
|
|
47419
47745
|
* WorkforceManagement service.
|
|
47420
47746
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
47421
|
-
* @version
|
|
47747
|
+
* @version 127.0.0
|
|
47422
47748
|
*/
|
|
47423
47749
|
|
|
47424
47750
|
/**
|
|
@@ -47693,6 +48019,66 @@ class WorkforceManagementApi {
|
|
|
47693
48019
|
);
|
|
47694
48020
|
}
|
|
47695
48021
|
|
|
48022
|
+
/**
|
|
48023
|
+
* Deletes a time off limit object
|
|
48024
|
+
*
|
|
48025
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
48026
|
+
* @param {String} timeOffLimitId The ID of the time off limit object to delete
|
|
48027
|
+
*/
|
|
48028
|
+
deleteWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
48029
|
+
// verify the required parameter 'managementUnitId' is set
|
|
48030
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
48031
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitTimeofflimit';
|
|
48032
|
+
}
|
|
48033
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
48034
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
48035
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling deleteWorkforcemanagementManagementunitTimeofflimit';
|
|
48036
|
+
}
|
|
48037
|
+
|
|
48038
|
+
return this.apiClient.callApi(
|
|
48039
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
48040
|
+
'DELETE',
|
|
48041
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
48042
|
+
{ },
|
|
48043
|
+
{ },
|
|
48044
|
+
{ },
|
|
48045
|
+
null,
|
|
48046
|
+
['PureCloud OAuth'],
|
|
48047
|
+
['application/json'],
|
|
48048
|
+
['application/json']
|
|
48049
|
+
);
|
|
48050
|
+
}
|
|
48051
|
+
|
|
48052
|
+
/**
|
|
48053
|
+
* Deletes a time off plan
|
|
48054
|
+
*
|
|
48055
|
+
* @param {String} managementUnitId The management unit ID.
|
|
48056
|
+
* @param {String} timeOffPlanId The ID of the time off plan to delete
|
|
48057
|
+
*/
|
|
48058
|
+
deleteWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
48059
|
+
// verify the required parameter 'managementUnitId' is set
|
|
48060
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
48061
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitTimeoffplan';
|
|
48062
|
+
}
|
|
48063
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
48064
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
48065
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling deleteWorkforcemanagementManagementunitTimeoffplan';
|
|
48066
|
+
}
|
|
48067
|
+
|
|
48068
|
+
return this.apiClient.callApi(
|
|
48069
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
48070
|
+
'DELETE',
|
|
48071
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
48072
|
+
{ },
|
|
48073
|
+
{ },
|
|
48074
|
+
{ },
|
|
48075
|
+
null,
|
|
48076
|
+
['PureCloud OAuth'],
|
|
48077
|
+
['application/json'],
|
|
48078
|
+
['application/json']
|
|
48079
|
+
);
|
|
48080
|
+
}
|
|
48081
|
+
|
|
47696
48082
|
/**
|
|
47697
48083
|
* Delete a work plan
|
|
47698
48084
|
*
|
|
@@ -48934,6 +49320,116 @@ class WorkforceManagementApi {
|
|
|
48934
49320
|
);
|
|
48935
49321
|
}
|
|
48936
49322
|
|
|
49323
|
+
/**
|
|
49324
|
+
* Gets a time off limit object
|
|
49325
|
+
* Returns properties of time off limit object, but not daily values.
|
|
49326
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
49327
|
+
* @param {String} timeOffLimitId The ID of the time off limit to fetch
|
|
49328
|
+
*/
|
|
49329
|
+
getWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
49330
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49331
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49332
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeofflimit';
|
|
49333
|
+
}
|
|
49334
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
49335
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
49336
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling getWorkforcemanagementManagementunitTimeofflimit';
|
|
49337
|
+
}
|
|
49338
|
+
|
|
49339
|
+
return this.apiClient.callApi(
|
|
49340
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
49341
|
+
'GET',
|
|
49342
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
49343
|
+
{ },
|
|
49344
|
+
{ },
|
|
49345
|
+
{ },
|
|
49346
|
+
null,
|
|
49347
|
+
['PureCloud OAuth'],
|
|
49348
|
+
['application/json'],
|
|
49349
|
+
['application/json']
|
|
49350
|
+
);
|
|
49351
|
+
}
|
|
49352
|
+
|
|
49353
|
+
/**
|
|
49354
|
+
* Gets a list of time off limit objects under management unit.
|
|
49355
|
+
* Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.
|
|
49356
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
49357
|
+
*/
|
|
49358
|
+
getWorkforcemanagementManagementunitTimeofflimits(managementUnitId) {
|
|
49359
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49360
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49361
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeofflimits';
|
|
49362
|
+
}
|
|
49363
|
+
|
|
49364
|
+
return this.apiClient.callApi(
|
|
49365
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits',
|
|
49366
|
+
'GET',
|
|
49367
|
+
{ 'managementUnitId': managementUnitId },
|
|
49368
|
+
{ },
|
|
49369
|
+
{ },
|
|
49370
|
+
{ },
|
|
49371
|
+
null,
|
|
49372
|
+
['PureCloud OAuth'],
|
|
49373
|
+
['application/json'],
|
|
49374
|
+
['application/json']
|
|
49375
|
+
);
|
|
49376
|
+
}
|
|
49377
|
+
|
|
49378
|
+
/**
|
|
49379
|
+
* Gets a time off plan
|
|
49380
|
+
*
|
|
49381
|
+
* @param {String} managementUnitId The management unit ID.
|
|
49382
|
+
* @param {String} timeOffPlanId The ID of the time off plan to fetch
|
|
49383
|
+
*/
|
|
49384
|
+
getWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
49385
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49386
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49387
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeoffplan';
|
|
49388
|
+
}
|
|
49389
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
49390
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
49391
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling getWorkforcemanagementManagementunitTimeoffplan';
|
|
49392
|
+
}
|
|
49393
|
+
|
|
49394
|
+
return this.apiClient.callApi(
|
|
49395
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
49396
|
+
'GET',
|
|
49397
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
49398
|
+
{ },
|
|
49399
|
+
{ },
|
|
49400
|
+
{ },
|
|
49401
|
+
null,
|
|
49402
|
+
['PureCloud OAuth'],
|
|
49403
|
+
['application/json'],
|
|
49404
|
+
['application/json']
|
|
49405
|
+
);
|
|
49406
|
+
}
|
|
49407
|
+
|
|
49408
|
+
/**
|
|
49409
|
+
* Gets a list of time off plans
|
|
49410
|
+
*
|
|
49411
|
+
* @param {String} managementUnitId The management unit ID.
|
|
49412
|
+
*/
|
|
49413
|
+
getWorkforcemanagementManagementunitTimeoffplans(managementUnitId) {
|
|
49414
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49415
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49416
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeoffplans';
|
|
49417
|
+
}
|
|
49418
|
+
|
|
49419
|
+
return this.apiClient.callApi(
|
|
49420
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans',
|
|
49421
|
+
'GET',
|
|
49422
|
+
{ 'managementUnitId': managementUnitId },
|
|
49423
|
+
{ },
|
|
49424
|
+
{ },
|
|
49425
|
+
{ },
|
|
49426
|
+
null,
|
|
49427
|
+
['PureCloud OAuth'],
|
|
49428
|
+
['application/json'],
|
|
49429
|
+
['application/json']
|
|
49430
|
+
);
|
|
49431
|
+
}
|
|
49432
|
+
|
|
48937
49433
|
/**
|
|
48938
49434
|
* Get a time off request
|
|
48939
49435
|
*
|
|
@@ -48969,6 +49465,41 @@ class WorkforceManagementApi {
|
|
|
48969
49465
|
);
|
|
48970
49466
|
}
|
|
48971
49467
|
|
|
49468
|
+
/**
|
|
49469
|
+
* Retrieves time off limit, allocated and waitlisted values according to specific time off request
|
|
49470
|
+
*
|
|
49471
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
49472
|
+
* @param {String} userId The userId to whom the time off request applies.
|
|
49473
|
+
* @param {String} timeOffRequestId The ID of the time off request, which dates and activityCodeId determine limit values to retrieve
|
|
49474
|
+
*/
|
|
49475
|
+
getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits(managementUnitId, userId, timeOffRequestId) {
|
|
49476
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49477
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49478
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
49479
|
+
}
|
|
49480
|
+
// verify the required parameter 'userId' is set
|
|
49481
|
+
if (userId === undefined || userId === null) {
|
|
49482
|
+
throw 'Missing the required parameter "userId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
49483
|
+
}
|
|
49484
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
49485
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
49486
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
49487
|
+
}
|
|
49488
|
+
|
|
49489
|
+
return this.apiClient.callApi(
|
|
49490
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeofflimits',
|
|
49491
|
+
'GET',
|
|
49492
|
+
{ 'managementUnitId': managementUnitId,'userId': userId,'timeOffRequestId': timeOffRequestId },
|
|
49493
|
+
{ },
|
|
49494
|
+
{ },
|
|
49495
|
+
{ },
|
|
49496
|
+
null,
|
|
49497
|
+
['PureCloud OAuth'],
|
|
49498
|
+
['application/json'],
|
|
49499
|
+
['application/json']
|
|
49500
|
+
);
|
|
49501
|
+
}
|
|
49502
|
+
|
|
48972
49503
|
/**
|
|
48973
49504
|
* Get a list of time off requests for a given user
|
|
48974
49505
|
*
|
|
@@ -49402,6 +49933,31 @@ class WorkforceManagementApi {
|
|
|
49402
49933
|
);
|
|
49403
49934
|
}
|
|
49404
49935
|
|
|
49936
|
+
/**
|
|
49937
|
+
* Get the daily waitlist positions of a time off request for the current user
|
|
49938
|
+
*
|
|
49939
|
+
* @param {String} timeOffRequestId Time Off Request Id
|
|
49940
|
+
*/
|
|
49941
|
+
getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId) {
|
|
49942
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
49943
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
49944
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementTimeoffrequestWaitlistpositions';
|
|
49945
|
+
}
|
|
49946
|
+
|
|
49947
|
+
return this.apiClient.callApi(
|
|
49948
|
+
'/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}/waitlistpositions',
|
|
49949
|
+
'GET',
|
|
49950
|
+
{ 'timeOffRequestId': timeOffRequestId },
|
|
49951
|
+
{ },
|
|
49952
|
+
{ },
|
|
49953
|
+
{ },
|
|
49954
|
+
null,
|
|
49955
|
+
['PureCloud OAuth'],
|
|
49956
|
+
['application/json'],
|
|
49957
|
+
['application/json']
|
|
49958
|
+
);
|
|
49959
|
+
}
|
|
49960
|
+
|
|
49405
49961
|
/**
|
|
49406
49962
|
* Get a list of time off requests for the current user
|
|
49407
49963
|
*
|
|
@@ -49620,6 +50176,74 @@ class WorkforceManagementApi {
|
|
|
49620
50176
|
);
|
|
49621
50177
|
}
|
|
49622
50178
|
|
|
50179
|
+
/**
|
|
50180
|
+
* Updates a time off limit object.
|
|
50181
|
+
* Updates time off limit object properties, but not daily values.
|
|
50182
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
50183
|
+
* @param {String} timeOffLimitId The id of time off limit object to update
|
|
50184
|
+
* @param {Object} opts Optional parameters
|
|
50185
|
+
* @param {Object} opts.body body
|
|
50186
|
+
*/
|
|
50187
|
+
patchWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId, opts) {
|
|
50188
|
+
opts = opts || {};
|
|
50189
|
+
|
|
50190
|
+
// verify the required parameter 'managementUnitId' is set
|
|
50191
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
50192
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
50193
|
+
}
|
|
50194
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
50195
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
50196
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
50197
|
+
}
|
|
50198
|
+
|
|
50199
|
+
return this.apiClient.callApi(
|
|
50200
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
50201
|
+
'PATCH',
|
|
50202
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
50203
|
+
{ },
|
|
50204
|
+
{ },
|
|
50205
|
+
{ },
|
|
50206
|
+
opts['body'],
|
|
50207
|
+
['PureCloud OAuth'],
|
|
50208
|
+
['application/json'],
|
|
50209
|
+
['application/json']
|
|
50210
|
+
);
|
|
50211
|
+
}
|
|
50212
|
+
|
|
50213
|
+
/**
|
|
50214
|
+
* Updates a time off plan
|
|
50215
|
+
*
|
|
50216
|
+
* @param {String} managementUnitId The management unit ID.
|
|
50217
|
+
* @param {String} timeOffPlanId The ID of the time off plan to update
|
|
50218
|
+
* @param {Object} opts Optional parameters
|
|
50219
|
+
* @param {Object} opts.body body
|
|
50220
|
+
*/
|
|
50221
|
+
patchWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId, opts) {
|
|
50222
|
+
opts = opts || {};
|
|
50223
|
+
|
|
50224
|
+
// verify the required parameter 'managementUnitId' is set
|
|
50225
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
50226
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
50227
|
+
}
|
|
50228
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
50229
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
50230
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
50231
|
+
}
|
|
50232
|
+
|
|
50233
|
+
return this.apiClient.callApi(
|
|
50234
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
50235
|
+
'PATCH',
|
|
50236
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
50237
|
+
{ },
|
|
50238
|
+
{ },
|
|
50239
|
+
{ },
|
|
50240
|
+
opts['body'],
|
|
50241
|
+
['PureCloud OAuth'],
|
|
50242
|
+
['application/json'],
|
|
50243
|
+
['application/json']
|
|
50244
|
+
);
|
|
50245
|
+
}
|
|
50246
|
+
|
|
49623
50247
|
/**
|
|
49624
50248
|
* Update a time off request
|
|
49625
50249
|
*
|
|
@@ -50481,6 +51105,93 @@ class WorkforceManagementApi {
|
|
|
50481
51105
|
);
|
|
50482
51106
|
}
|
|
50483
51107
|
|
|
51108
|
+
/**
|
|
51109
|
+
* Creates a new time off limit object under management unit.
|
|
51110
|
+
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
51111
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51112
|
+
* @param {Object} opts Optional parameters
|
|
51113
|
+
* @param {Object} opts.body body
|
|
51114
|
+
*/
|
|
51115
|
+
postWorkforcemanagementManagementunitTimeofflimits(managementUnitId, opts) {
|
|
51116
|
+
opts = opts || {};
|
|
51117
|
+
|
|
51118
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51119
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51120
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimits';
|
|
51121
|
+
}
|
|
51122
|
+
|
|
51123
|
+
return this.apiClient.callApi(
|
|
51124
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits',
|
|
51125
|
+
'POST',
|
|
51126
|
+
{ 'managementUnitId': managementUnitId },
|
|
51127
|
+
{ },
|
|
51128
|
+
{ },
|
|
51129
|
+
{ },
|
|
51130
|
+
opts['body'],
|
|
51131
|
+
['PureCloud OAuth'],
|
|
51132
|
+
['application/json'],
|
|
51133
|
+
['application/json']
|
|
51134
|
+
);
|
|
51135
|
+
}
|
|
51136
|
+
|
|
51137
|
+
/**
|
|
51138
|
+
* Retrieves time off limit related values based on a given set of filters.
|
|
51139
|
+
*
|
|
51140
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51141
|
+
* @param {Object} opts Optional parameters
|
|
51142
|
+
* @param {Object} opts.body body
|
|
51143
|
+
*/
|
|
51144
|
+
postWorkforcemanagementManagementunitTimeofflimitsValuesQuery(managementUnitId, opts) {
|
|
51145
|
+
opts = opts || {};
|
|
51146
|
+
|
|
51147
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51148
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51149
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimitsValuesQuery';
|
|
51150
|
+
}
|
|
51151
|
+
|
|
51152
|
+
return this.apiClient.callApi(
|
|
51153
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/values/query',
|
|
51154
|
+
'POST',
|
|
51155
|
+
{ 'managementUnitId': managementUnitId },
|
|
51156
|
+
{ },
|
|
51157
|
+
{ },
|
|
51158
|
+
{ },
|
|
51159
|
+
opts['body'],
|
|
51160
|
+
['PureCloud OAuth'],
|
|
51161
|
+
['application/json'],
|
|
51162
|
+
['application/json']
|
|
51163
|
+
);
|
|
51164
|
+
}
|
|
51165
|
+
|
|
51166
|
+
/**
|
|
51167
|
+
* Creates a new time off plan
|
|
51168
|
+
*
|
|
51169
|
+
* @param {String} managementUnitId The management unit ID.
|
|
51170
|
+
* @param {Object} opts Optional parameters
|
|
51171
|
+
* @param {Object} opts.body body
|
|
51172
|
+
*/
|
|
51173
|
+
postWorkforcemanagementManagementunitTimeoffplans(managementUnitId, opts) {
|
|
51174
|
+
opts = opts || {};
|
|
51175
|
+
|
|
51176
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51177
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51178
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffplans';
|
|
51179
|
+
}
|
|
51180
|
+
|
|
51181
|
+
return this.apiClient.callApi(
|
|
51182
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans',
|
|
51183
|
+
'POST',
|
|
51184
|
+
{ 'managementUnitId': managementUnitId },
|
|
51185
|
+
{ },
|
|
51186
|
+
{ },
|
|
51187
|
+
{ },
|
|
51188
|
+
opts['body'],
|
|
51189
|
+
['PureCloud OAuth'],
|
|
51190
|
+
['application/json'],
|
|
51191
|
+
['application/json']
|
|
51192
|
+
);
|
|
51193
|
+
}
|
|
51194
|
+
|
|
50484
51195
|
/**
|
|
50485
51196
|
* Create a new time off request
|
|
50486
51197
|
*
|
|
@@ -50539,6 +51250,35 @@ class WorkforceManagementApi {
|
|
|
50539
51250
|
);
|
|
50540
51251
|
}
|
|
50541
51252
|
|
|
51253
|
+
/**
|
|
51254
|
+
* Retrieves daily waitlist position for a list of time off requests
|
|
51255
|
+
*
|
|
51256
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51257
|
+
* @param {Object} opts Optional parameters
|
|
51258
|
+
* @param {Object} opts.body body
|
|
51259
|
+
*/
|
|
51260
|
+
postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery(managementUnitId, opts) {
|
|
51261
|
+
opts = opts || {};
|
|
51262
|
+
|
|
51263
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51264
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51265
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery';
|
|
51266
|
+
}
|
|
51267
|
+
|
|
51268
|
+
return this.apiClient.callApi(
|
|
51269
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/waitlistpositions/query',
|
|
51270
|
+
'POST',
|
|
51271
|
+
{ 'managementUnitId': managementUnitId },
|
|
51272
|
+
{ },
|
|
51273
|
+
{ },
|
|
51274
|
+
{ },
|
|
51275
|
+
opts['body'],
|
|
51276
|
+
['PureCloud OAuth'],
|
|
51277
|
+
['application/json'],
|
|
51278
|
+
['application/json']
|
|
51279
|
+
);
|
|
51280
|
+
}
|
|
51281
|
+
|
|
50542
51282
|
/**
|
|
50543
51283
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
50544
51284
|
*
|
|
@@ -50922,6 +51662,30 @@ class WorkforceManagementApi {
|
|
|
50922
51662
|
);
|
|
50923
51663
|
}
|
|
50924
51664
|
|
|
51665
|
+
/**
|
|
51666
|
+
* Queries available time off for the current user
|
|
51667
|
+
*
|
|
51668
|
+
* @param {Object} opts Optional parameters
|
|
51669
|
+
* @param {Object} opts.body body
|
|
51670
|
+
*/
|
|
51671
|
+
postWorkforcemanagementTimeofflimitsAvailableQuery(opts) {
|
|
51672
|
+
opts = opts || {};
|
|
51673
|
+
|
|
51674
|
+
|
|
51675
|
+
return this.apiClient.callApi(
|
|
51676
|
+
'/api/v2/workforcemanagement/timeofflimits/available/query',
|
|
51677
|
+
'POST',
|
|
51678
|
+
{ },
|
|
51679
|
+
{ },
|
|
51680
|
+
{ },
|
|
51681
|
+
{ },
|
|
51682
|
+
opts['body'],
|
|
51683
|
+
['PureCloud OAuth'],
|
|
51684
|
+
['application/json'],
|
|
51685
|
+
['application/json']
|
|
51686
|
+
);
|
|
51687
|
+
}
|
|
51688
|
+
|
|
50925
51689
|
/**
|
|
50926
51690
|
* Create a time off request for the current user
|
|
50927
51691
|
*
|
|
@@ -50946,6 +51710,40 @@ class WorkforceManagementApi {
|
|
|
50946
51710
|
);
|
|
50947
51711
|
}
|
|
50948
51712
|
|
|
51713
|
+
/**
|
|
51714
|
+
* Sets daily values for a date range of time off limit object
|
|
51715
|
+
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
51716
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51717
|
+
* @param {String} timeOffLimitId The ID of the time off limit object to set values for
|
|
51718
|
+
* @param {Object} opts Optional parameters
|
|
51719
|
+
* @param {Object} opts.body body
|
|
51720
|
+
*/
|
|
51721
|
+
putWorkforcemanagementManagementunitTimeofflimitValues(managementUnitId, timeOffLimitId, opts) {
|
|
51722
|
+
opts = opts || {};
|
|
51723
|
+
|
|
51724
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51725
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51726
|
+
throw 'Missing the required parameter "managementUnitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
51727
|
+
}
|
|
51728
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
51729
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
51730
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
51731
|
+
}
|
|
51732
|
+
|
|
51733
|
+
return this.apiClient.callApi(
|
|
51734
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}/values',
|
|
51735
|
+
'PUT',
|
|
51736
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
51737
|
+
{ },
|
|
51738
|
+
{ },
|
|
51739
|
+
{ },
|
|
51740
|
+
opts['body'],
|
|
51741
|
+
['PureCloud OAuth'],
|
|
51742
|
+
['application/json'],
|
|
51743
|
+
['application/json']
|
|
51744
|
+
);
|
|
51745
|
+
}
|
|
51746
|
+
|
|
50949
51747
|
}
|
|
50950
51748
|
|
|
50951
51749
|
/**
|
|
@@ -50977,7 +51775,7 @@ class WorkforceManagementApi {
|
|
|
50977
51775
|
* </pre>
|
|
50978
51776
|
* </p>
|
|
50979
51777
|
* @module purecloud-platform-client-v2/index
|
|
50980
|
-
* @version
|
|
51778
|
+
* @version 127.0.0
|
|
50981
51779
|
*/
|
|
50982
51780
|
class platformClient {
|
|
50983
51781
|
constructor() {
|