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
|
@@ -254,27 +254,29 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
254
254
|
}
|
|
255
255
|
|
|
256
256
|
liveLoadConfig() {
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
// do nothing
|
|
257
|
+
if (typeof window === 'undefined') {
|
|
258
|
+
// Please don't remove the typeof window === 'undefined' check here!
|
|
259
|
+
// This safeguards the browser environment from using `fs`, which is only
|
|
260
|
+
// available in node environment.
|
|
261
|
+
this.updateConfigFromFile();
|
|
262
|
+
|
|
263
|
+
if (this.live_reload_config && this.live_reload_config === true) {
|
|
264
|
+
try {
|
|
265
|
+
const fs = require('fs');
|
|
266
|
+
fs.watchFile(this.configPath, { persistent: false }, (eventType, filename) => {
|
|
267
|
+
this.updateConfigFromFile();
|
|
268
|
+
if (!this.live_reload_config) {
|
|
269
|
+
fs.unwatchFile(this.configPath);
|
|
270
|
+
}
|
|
271
|
+
});
|
|
272
|
+
} catch (err) {
|
|
273
|
+
// do nothing
|
|
274
|
+
}
|
|
276
275
|
}
|
|
276
|
+
return;
|
|
277
277
|
}
|
|
278
|
+
// If in browser, don't read config file, use default values
|
|
279
|
+
this.configPath = '';
|
|
278
280
|
}
|
|
279
281
|
|
|
280
282
|
setConfigPath(path) {
|
|
@@ -285,24 +287,29 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
285
287
|
}
|
|
286
288
|
|
|
287
289
|
updateConfigFromFile() {
|
|
288
|
-
|
|
290
|
+
if (typeof window === 'undefined') {
|
|
291
|
+
// Please don't remove the typeof window === 'undefined' check here!
|
|
292
|
+
// This safeguards the browser environment from using `fs`, which is only
|
|
293
|
+
// available in node environment.
|
|
294
|
+
const ConfigParser = require('configparser');
|
|
289
295
|
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
296
|
+
try {
|
|
297
|
+
var configparser = new ConfigParser();
|
|
298
|
+
configparser.read(this.configPath); // If no error catched, indicates it's INI format
|
|
299
|
+
this.config = configparser;
|
|
300
|
+
} catch (error) {
|
|
301
|
+
if (error.name && error.name === 'MissingSectionHeaderError') {
|
|
302
|
+
// Not INI format, see if it's JSON format
|
|
303
|
+
const fs = require('fs');
|
|
304
|
+
var configData = fs.readFileSync(this.configPath, 'utf8');
|
|
305
|
+
this.config = {
|
|
306
|
+
_sections: JSON.parse(configData), // To match INI data format
|
|
307
|
+
};
|
|
308
|
+
}
|
|
302
309
|
}
|
|
303
|
-
}
|
|
304
310
|
|
|
305
|
-
|
|
311
|
+
if (this.config) this.updateConfigValues();
|
|
312
|
+
}
|
|
306
313
|
}
|
|
307
314
|
|
|
308
315
|
updateConfigValues() {
|
|
@@ -384,7 +391,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
384
391
|
|
|
385
392
|
/**
|
|
386
393
|
* @module purecloud-platform-client-v2/ApiClient
|
|
387
|
-
* @version
|
|
394
|
+
* @version 127.0.0
|
|
388
395
|
*/
|
|
389
396
|
class ApiClient {
|
|
390
397
|
/**
|
|
@@ -1331,7 +1338,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1331
1338
|
|
|
1332
1339
|
// set header parameters
|
|
1333
1340
|
request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
|
|
1334
|
-
//request.set({ 'purecloud-sdk': '
|
|
1341
|
+
//request.set({ 'purecloud-sdk': '127.0.0' });
|
|
1335
1342
|
|
|
1336
1343
|
// set request timeout
|
|
1337
1344
|
request.timeout(that.timeout);
|
|
@@ -1431,7 +1438,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1431
1438
|
/**
|
|
1432
1439
|
* Alerting service.
|
|
1433
1440
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1434
|
-
* @version
|
|
1441
|
+
* @version 127.0.0
|
|
1435
1442
|
*/
|
|
1436
1443
|
|
|
1437
1444
|
/**
|
|
@@ -1745,7 +1752,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1745
1752
|
/**
|
|
1746
1753
|
* Analytics service.
|
|
1747
1754
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1748
|
-
* @version
|
|
1755
|
+
* @version 127.0.0
|
|
1749
1756
|
*/
|
|
1750
1757
|
|
|
1751
1758
|
/**
|
|
@@ -2341,31 +2348,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2341
2348
|
);
|
|
2342
2349
|
}
|
|
2343
2350
|
|
|
2344
|
-
/**
|
|
2345
|
-
* Patch AnalyticsReportingSettings values for an organization
|
|
2346
|
-
*
|
|
2347
|
-
* @param {Object} body AnalyticsReportingSettingsRequest
|
|
2348
|
-
*/
|
|
2349
|
-
patchAnalyticsReportingSettings(body) {
|
|
2350
|
-
// verify the required parameter 'body' is set
|
|
2351
|
-
if (body === undefined || body === null) {
|
|
2352
|
-
throw 'Missing the required parameter "body" when calling patchAnalyticsReportingSettings';
|
|
2353
|
-
}
|
|
2354
|
-
|
|
2355
|
-
return this.apiClient.callApi(
|
|
2356
|
-
'/api/v2/analytics/reporting/settings',
|
|
2357
|
-
'PATCH',
|
|
2358
|
-
{ },
|
|
2359
|
-
{ },
|
|
2360
|
-
{ },
|
|
2361
|
-
{ },
|
|
2362
|
-
body,
|
|
2363
|
-
['PureCloud OAuth'],
|
|
2364
|
-
['application/json'],
|
|
2365
|
-
['application/json']
|
|
2366
|
-
);
|
|
2367
|
-
}
|
|
2368
|
-
|
|
2369
2351
|
/**
|
|
2370
2352
|
* Query for bot aggregates
|
|
2371
2353
|
*
|
|
@@ -2907,7 +2889,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2907
2889
|
/**
|
|
2908
2890
|
* Architect service.
|
|
2909
2891
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2910
|
-
* @version
|
|
2892
|
+
* @version 127.0.0
|
|
2911
2893
|
*/
|
|
2912
2894
|
|
|
2913
2895
|
/**
|
|
@@ -5903,7 +5885,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5903
5885
|
/**
|
|
5904
5886
|
* Audit service.
|
|
5905
5887
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
5906
|
-
* @version
|
|
5888
|
+
* @version 127.0.0
|
|
5907
5889
|
*/
|
|
5908
5890
|
|
|
5909
5891
|
/**
|
|
@@ -6074,7 +6056,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6074
6056
|
/**
|
|
6075
6057
|
* Authorization service.
|
|
6076
6058
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6077
|
-
* @version
|
|
6059
|
+
* @version 127.0.0
|
|
6078
6060
|
*/
|
|
6079
6061
|
|
|
6080
6062
|
/**
|
|
@@ -7257,7 +7239,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7257
7239
|
/**
|
|
7258
7240
|
* Billing service.
|
|
7259
7241
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7260
|
-
* @version
|
|
7242
|
+
* @version 127.0.0
|
|
7261
7243
|
*/
|
|
7262
7244
|
|
|
7263
7245
|
/**
|
|
@@ -7337,7 +7319,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7337
7319
|
/**
|
|
7338
7320
|
* Chat service.
|
|
7339
7321
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7340
|
-
* @version
|
|
7322
|
+
* @version 127.0.0
|
|
7341
7323
|
*/
|
|
7342
7324
|
|
|
7343
7325
|
/**
|
|
@@ -7428,7 +7410,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7428
7410
|
/**
|
|
7429
7411
|
* Coaching service.
|
|
7430
7412
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7431
|
-
* @version
|
|
7413
|
+
* @version 127.0.0
|
|
7432
7414
|
*/
|
|
7433
7415
|
|
|
7434
7416
|
/**
|
|
@@ -8003,7 +7985,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8003
7985
|
/**
|
|
8004
7986
|
* ContentManagement service.
|
|
8005
7987
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8006
|
-
* @version
|
|
7988
|
+
* @version 127.0.0
|
|
8007
7989
|
*/
|
|
8008
7990
|
|
|
8009
7991
|
/**
|
|
@@ -9143,7 +9125,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9143
9125
|
/**
|
|
9144
9126
|
* Conversations service.
|
|
9145
9127
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9146
|
-
* @version
|
|
9128
|
+
* @version 127.0.0
|
|
9147
9129
|
*/
|
|
9148
9130
|
|
|
9149
9131
|
/**
|
|
@@ -13532,7 +13514,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13532
13514
|
/**
|
|
13533
13515
|
* DataExtensions service.
|
|
13534
13516
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
13535
|
-
* @version
|
|
13517
|
+
* @version 127.0.0
|
|
13536
13518
|
*/
|
|
13537
13519
|
|
|
13538
13520
|
/**
|
|
@@ -13618,7 +13600,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13618
13600
|
/**
|
|
13619
13601
|
* ExternalContacts service.
|
|
13620
13602
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
13621
|
-
* @version
|
|
13603
|
+
* @version 127.0.0
|
|
13622
13604
|
*/
|
|
13623
13605
|
|
|
13624
13606
|
/**
|
|
@@ -15361,7 +15343,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15361
15343
|
/**
|
|
15362
15344
|
* Fax service.
|
|
15363
15345
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
15364
|
-
* @version
|
|
15346
|
+
* @version 127.0.0
|
|
15365
15347
|
*/
|
|
15366
15348
|
|
|
15367
15349
|
/**
|
|
@@ -15532,7 +15514,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15532
15514
|
/**
|
|
15533
15515
|
* Flows service.
|
|
15534
15516
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
15535
|
-
* @version
|
|
15517
|
+
* @version 127.0.0
|
|
15536
15518
|
*/
|
|
15537
15519
|
|
|
15538
15520
|
/**
|
|
@@ -15603,7 +15585,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15603
15585
|
/**
|
|
15604
15586
|
* Gamification service.
|
|
15605
15587
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
15606
|
-
* @version
|
|
15588
|
+
* @version 127.0.0
|
|
15607
15589
|
*/
|
|
15608
15590
|
|
|
15609
15591
|
/**
|
|
@@ -16909,7 +16891,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16909
16891
|
/**
|
|
16910
16892
|
* GeneralDataProtectionRegulation service.
|
|
16911
16893
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
16912
|
-
* @version
|
|
16894
|
+
* @version 127.0.0
|
|
16913
16895
|
*/
|
|
16914
16896
|
|
|
16915
16897
|
/**
|
|
@@ -17039,7 +17021,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17039
17021
|
/**
|
|
17040
17022
|
* Geolocation service.
|
|
17041
17023
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
17042
|
-
* @version
|
|
17024
|
+
* @version 127.0.0
|
|
17043
17025
|
*/
|
|
17044
17026
|
|
|
17045
17027
|
/**
|
|
@@ -17170,7 +17152,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17170
17152
|
/**
|
|
17171
17153
|
* Greetings service.
|
|
17172
17154
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
17173
|
-
* @version
|
|
17155
|
+
* @version 127.0.0
|
|
17174
17156
|
*/
|
|
17175
17157
|
|
|
17176
17158
|
/**
|
|
@@ -17625,7 +17607,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17625
17607
|
/**
|
|
17626
17608
|
* Groups service.
|
|
17627
17609
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
17628
|
-
* @version
|
|
17610
|
+
* @version 127.0.0
|
|
17629
17611
|
*/
|
|
17630
17612
|
|
|
17631
17613
|
/**
|
|
@@ -18030,7 +18012,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18030
18012
|
/**
|
|
18031
18013
|
* IdentityProvider service.
|
|
18032
18014
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
18033
|
-
* @version
|
|
18015
|
+
* @version 127.0.0
|
|
18034
18016
|
*/
|
|
18035
18017
|
|
|
18036
18018
|
/**
|
|
@@ -18786,7 +18768,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18786
18768
|
/**
|
|
18787
18769
|
* Integrations service.
|
|
18788
18770
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
18789
|
-
* @version
|
|
18771
|
+
* @version 127.0.0
|
|
18790
18772
|
*/
|
|
18791
18773
|
|
|
18792
18774
|
/**
|
|
@@ -20432,7 +20414,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20432
20414
|
/**
|
|
20433
20415
|
* Journey service.
|
|
20434
20416
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
20435
|
-
* @version
|
|
20417
|
+
* @version 127.0.0
|
|
20436
20418
|
*/
|
|
20437
20419
|
|
|
20438
20420
|
/**
|
|
@@ -21143,7 +21125,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21143
21125
|
/**
|
|
21144
21126
|
* Knowledge service.
|
|
21145
21127
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
21146
|
-
* @version
|
|
21128
|
+
* @version 127.0.0
|
|
21147
21129
|
*/
|
|
21148
21130
|
|
|
21149
21131
|
/**
|
|
@@ -22043,7 +22025,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22043
22025
|
/**
|
|
22044
22026
|
* LanguageUnderstanding service.
|
|
22045
22027
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
22046
|
-
* @version
|
|
22028
|
+
* @version 127.0.0
|
|
22047
22029
|
*/
|
|
22048
22030
|
|
|
22049
22031
|
/**
|
|
@@ -22609,7 +22591,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22609
22591
|
}
|
|
22610
22592
|
|
|
22611
22593
|
/**
|
|
22612
|
-
* Save information for the draft
|
|
22594
|
+
* Save information for the draft. Either topic draft or intent draft should be sent.
|
|
22613
22595
|
*
|
|
22614
22596
|
* @param {String} minerId Miner ID
|
|
22615
22597
|
* @param {String} draftId Draft ID
|
|
@@ -22853,7 +22835,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22853
22835
|
}
|
|
22854
22836
|
|
|
22855
22837
|
/**
|
|
22856
|
-
* 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.
|
|
22857
22839
|
*
|
|
22858
22840
|
* @param {String} minerId Miner ID
|
|
22859
22841
|
* @param {Object} opts Optional parameters
|
|
@@ -22947,7 +22929,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22947
22929
|
/**
|
|
22948
22930
|
* Languages service.
|
|
22949
22931
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
22950
|
-
* @version
|
|
22932
|
+
* @version 127.0.0
|
|
22951
22933
|
*/
|
|
22952
22934
|
|
|
22953
22935
|
/**
|
|
@@ -23215,7 +23197,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23215
23197
|
/**
|
|
23216
23198
|
* Learning service.
|
|
23217
23199
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
23218
|
-
* @version
|
|
23200
|
+
* @version 127.0.0
|
|
23219
23201
|
*/
|
|
23220
23202
|
|
|
23221
23203
|
/**
|
|
@@ -23806,7 +23788,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23806
23788
|
/**
|
|
23807
23789
|
* License service.
|
|
23808
23790
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
23809
|
-
* @version
|
|
23791
|
+
* @version 127.0.0
|
|
23810
23792
|
*/
|
|
23811
23793
|
|
|
23812
23794
|
/**
|
|
@@ -24044,7 +24026,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24044
24026
|
/**
|
|
24045
24027
|
* Locations service.
|
|
24046
24028
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
24047
|
-
* @version
|
|
24029
|
+
* @version 127.0.0
|
|
24048
24030
|
*/
|
|
24049
24031
|
|
|
24050
24032
|
/**
|
|
@@ -24280,7 +24262,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24280
24262
|
/**
|
|
24281
24263
|
* MobileDevices service.
|
|
24282
24264
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
24283
|
-
* @version
|
|
24265
|
+
* @version 127.0.0
|
|
24284
24266
|
*/
|
|
24285
24267
|
|
|
24286
24268
|
/**
|
|
@@ -24431,7 +24413,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24431
24413
|
/**
|
|
24432
24414
|
* Notifications service.
|
|
24433
24415
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
24434
|
-
* @version
|
|
24416
|
+
* @version 127.0.0
|
|
24435
24417
|
*/
|
|
24436
24418
|
|
|
24437
24419
|
/**
|
|
@@ -24656,7 +24638,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24656
24638
|
/**
|
|
24657
24639
|
* OAuth service.
|
|
24658
24640
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
24659
|
-
* @version
|
|
24641
|
+
* @version 127.0.0
|
|
24660
24642
|
*/
|
|
24661
24643
|
|
|
24662
24644
|
/**
|
|
@@ -25014,7 +24996,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25014
24996
|
/**
|
|
25015
24997
|
* Objects service.
|
|
25016
24998
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
25017
|
-
* @version
|
|
24999
|
+
* @version 127.0.0
|
|
25018
25000
|
*/
|
|
25019
25001
|
|
|
25020
25002
|
/**
|
|
@@ -25285,7 +25267,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25285
25267
|
/**
|
|
25286
25268
|
* Organization service.
|
|
25287
25269
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
25288
|
-
* @version
|
|
25270
|
+
* @version 127.0.0
|
|
25289
25271
|
*/
|
|
25290
25272
|
|
|
25291
25273
|
/**
|
|
@@ -25688,7 +25670,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25688
25670
|
/**
|
|
25689
25671
|
* OrganizationAuthorization service.
|
|
25690
25672
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
25691
|
-
* @version
|
|
25673
|
+
* @version 127.0.0
|
|
25692
25674
|
*/
|
|
25693
25675
|
|
|
25694
25676
|
/**
|
|
@@ -25728,6 +25710,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25728
25710
|
);
|
|
25729
25711
|
}
|
|
25730
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
|
+
|
|
25731
25743
|
/**
|
|
25732
25744
|
* Delete Trustee User
|
|
25733
25745
|
*
|
|
@@ -25813,6 +25825,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25813
25825
|
);
|
|
25814
25826
|
}
|
|
25815
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
|
+
|
|
25816
25858
|
/**
|
|
25817
25859
|
* Delete Trustee User
|
|
25818
25860
|
*
|
|
@@ -25893,6 +25935,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25893
25935
|
);
|
|
25894
25936
|
}
|
|
25895
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
|
+
|
|
25896
25963
|
/**
|
|
25897
25964
|
* Get Trustee User
|
|
25898
25965
|
*
|
|
@@ -26008,6 +26075,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26008
26075
|
);
|
|
26009
26076
|
}
|
|
26010
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
|
+
|
|
26011
26098
|
/**
|
|
26012
26099
|
* Get Org Trust
|
|
26013
26100
|
*
|
|
@@ -26033,6 +26120,61 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26033
26120
|
);
|
|
26034
26121
|
}
|
|
26035
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
|
+
|
|
26036
26178
|
/**
|
|
26037
26179
|
* Get Trustee User
|
|
26038
26180
|
*
|
|
@@ -26230,6 +26372,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26230
26372
|
);
|
|
26231
26373
|
}
|
|
26232
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
|
+
|
|
26233
26400
|
/**
|
|
26234
26401
|
* Get Org Trustor Audits
|
|
26235
26402
|
*
|
|
@@ -26362,6 +26529,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26362
26529
|
);
|
|
26363
26530
|
}
|
|
26364
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
|
+
|
|
26365
26562
|
/**
|
|
26366
26563
|
* Add a Trustee user to the trust.
|
|
26367
26564
|
*
|
|
@@ -26398,7 +26595,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26398
26595
|
/**
|
|
26399
26596
|
* Outbound service.
|
|
26400
26597
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
26401
|
-
* @version
|
|
26598
|
+
* @version 127.0.0
|
|
26402
26599
|
*/
|
|
26403
26600
|
|
|
26404
26601
|
/**
|
|
@@ -29424,7 +29621,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29424
29621
|
/**
|
|
29425
29622
|
* Presence service.
|
|
29426
29623
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
29427
|
-
* @version
|
|
29624
|
+
* @version 127.0.0
|
|
29428
29625
|
*/
|
|
29429
29626
|
|
|
29430
29627
|
/**
|
|
@@ -29796,7 +29993,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29796
29993
|
/**
|
|
29797
29994
|
* Quality service.
|
|
29798
29995
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
29799
|
-
* @version
|
|
29996
|
+
* @version 127.0.0
|
|
29800
29997
|
*/
|
|
29801
29998
|
|
|
29802
29999
|
/**
|
|
@@ -30169,7 +30366,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30169
30366
|
|
|
30170
30367
|
/**
|
|
30171
30368
|
* Queries Evaluations and returns a paged list
|
|
30172
|
-
* 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.
|
|
30173
30370
|
* @param {Object} opts Optional parameters
|
|
30174
30371
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
30175
30372
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -31324,7 +31521,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31324
31521
|
/**
|
|
31325
31522
|
* Recording service.
|
|
31326
31523
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
31327
|
-
* @version
|
|
31524
|
+
* @version 127.0.0
|
|
31328
31525
|
*/
|
|
31329
31526
|
|
|
31330
31527
|
/**
|
|
@@ -31920,6 +32117,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31920
32117
|
* @param {Object} opts Optional parameters
|
|
31921
32118
|
* @param {Number} opts.pageSize Page size. Maximum is 100. (default to 25)
|
|
31922
32119
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
32120
|
+
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
|
|
32121
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
31923
32122
|
*/
|
|
31924
32123
|
getRecordingJobFailedrecordings(jobId, opts) {
|
|
31925
32124
|
opts = opts || {};
|
|
@@ -31933,7 +32132,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31933
32132
|
'/api/v2/recording/jobs/{jobId}/failedrecordings',
|
|
31934
32133
|
'GET',
|
|
31935
32134
|
{ 'jobId': jobId },
|
|
31936
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
32135
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] },
|
|
31937
32136
|
{ },
|
|
31938
32137
|
{ },
|
|
31939
32138
|
null,
|
|
@@ -31953,6 +32152,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31953
32152
|
* @param {Object} opts.state Filter by state
|
|
31954
32153
|
* @param {Boolean} opts.showOnlyMyJobs Show only my jobs
|
|
31955
32154
|
* @param {Object} opts.jobType Job Type (Can be left empty for both)
|
|
32155
|
+
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
|
|
32156
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
31956
32157
|
*/
|
|
31957
32158
|
getRecordingJobs(opts) {
|
|
31958
32159
|
opts = opts || {};
|
|
@@ -31962,7 +32163,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31962
32163
|
'/api/v2/recording/jobs',
|
|
31963
32164
|
'GET',
|
|
31964
32165
|
{ },
|
|
31965
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'state': opts['state'],'showOnlyMyJobs': opts['showOnlyMyJobs'],'jobType': opts['jobType'] },
|
|
32166
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'state': opts['state'],'showOnlyMyJobs': opts['showOnlyMyJobs'],'jobType': opts['jobType'],'includeTotal': opts['includeTotal'],'cursor': opts['cursor'] },
|
|
31966
32167
|
{ },
|
|
31967
32168
|
{ },
|
|
31968
32169
|
null,
|
|
@@ -32843,7 +33044,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32843
33044
|
/**
|
|
32844
33045
|
* ResponseManagement service.
|
|
32845
33046
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
32846
|
-
* @version
|
|
33047
|
+
* @version 127.0.0
|
|
32847
33048
|
*/
|
|
32848
33049
|
|
|
32849
33050
|
/**
|
|
@@ -33168,7 +33369,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33168
33369
|
/**
|
|
33169
33370
|
* Routing service.
|
|
33170
33371
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
33171
|
-
* @version
|
|
33372
|
+
* @version 127.0.0
|
|
33172
33373
|
*/
|
|
33173
33374
|
|
|
33174
33375
|
/**
|
|
@@ -33481,8 +33682,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33481
33682
|
* Delete a phone number provisioned for SMS.
|
|
33482
33683
|
*
|
|
33483
33684
|
* @param {String} addressId Address ID
|
|
33685
|
+
* @param {Object} opts Optional parameters
|
|
33686
|
+
* @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)
|
|
33484
33687
|
*/
|
|
33485
|
-
deleteRoutingSmsPhonenumber(addressId) {
|
|
33688
|
+
deleteRoutingSmsPhonenumber(addressId, opts) {
|
|
33689
|
+
opts = opts || {};
|
|
33690
|
+
|
|
33486
33691
|
// verify the required parameter 'addressId' is set
|
|
33487
33692
|
if (addressId === undefined || addressId === null) {
|
|
33488
33693
|
throw 'Missing the required parameter "addressId" when calling deleteRoutingSmsPhonenumber';
|
|
@@ -33492,7 +33697,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33492
33697
|
'/api/v2/routing/sms/phonenumbers/{addressId}',
|
|
33493
33698
|
'DELETE',
|
|
33494
33699
|
{ 'addressId': addressId },
|
|
33495
|
-
{
|
|
33700
|
+
{ 'async': opts['async'] },
|
|
33496
33701
|
{ },
|
|
33497
33702
|
{ },
|
|
33498
33703
|
null,
|
|
@@ -34320,12 +34525,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34320
34525
|
}
|
|
34321
34526
|
|
|
34322
34527
|
/**
|
|
34323
|
-
* Get a paged listing of simplified queue objects. Can be used to get a digest of all queues in an organization.
|
|
34528
|
+
* Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization.
|
|
34324
34529
|
*
|
|
34325
34530
|
* @param {Object} opts Optional parameters
|
|
34326
34531
|
* @param {Number} opts.pageSize Page size [max value is 500] (default to 25)
|
|
34327
34532
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
34328
|
-
* @param {Object} opts.sortBy Sort by (default to name)
|
|
34329
34533
|
* @param {Object} opts.sortOrder Sort order (default to asc)
|
|
34330
34534
|
*/
|
|
34331
34535
|
getRoutingQueuesDivisionviewsAll(opts) {
|
|
@@ -34336,7 +34540,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34336
34540
|
'/api/v2/routing/queues/divisionviews/all',
|
|
34337
34541
|
'GET',
|
|
34338
34542
|
{ },
|
|
34339
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'
|
|
34543
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'] },
|
|
34340
34544
|
{ },
|
|
34341
34545
|
{ },
|
|
34342
34546
|
null,
|
|
@@ -35639,8 +35843,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35639
35843
|
* Provision a phone number for SMS
|
|
35640
35844
|
*
|
|
35641
35845
|
* @param {Object} body SmsPhoneNumber
|
|
35846
|
+
* @param {Object} opts Optional parameters
|
|
35847
|
+
* @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)
|
|
35642
35848
|
*/
|
|
35643
|
-
postRoutingSmsPhonenumbers(body) {
|
|
35849
|
+
postRoutingSmsPhonenumbers(body, opts) {
|
|
35850
|
+
opts = opts || {};
|
|
35851
|
+
|
|
35644
35852
|
// verify the required parameter 'body' is set
|
|
35645
35853
|
if (body === undefined || body === null) {
|
|
35646
35854
|
throw 'Missing the required parameter "body" when calling postRoutingSmsPhonenumbers';
|
|
@@ -35650,7 +35858,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35650
35858
|
'/api/v2/routing/sms/phonenumbers',
|
|
35651
35859
|
'POST',
|
|
35652
35860
|
{ },
|
|
35653
|
-
{
|
|
35861
|
+
{ 'async': opts['async'] },
|
|
35654
35862
|
{ },
|
|
35655
35863
|
{ },
|
|
35656
35864
|
body,
|
|
@@ -35895,8 +36103,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35895
36103
|
*
|
|
35896
36104
|
* @param {String} addressId Address ID
|
|
35897
36105
|
* @param {Object} body SmsPhoneNumber
|
|
36106
|
+
* @param {Object} opts Optional parameters
|
|
36107
|
+
* @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)
|
|
35898
36108
|
*/
|
|
35899
|
-
putRoutingSmsPhonenumber(addressId, body) {
|
|
36109
|
+
putRoutingSmsPhonenumber(addressId, body, opts) {
|
|
36110
|
+
opts = opts || {};
|
|
36111
|
+
|
|
35900
36112
|
// verify the required parameter 'addressId' is set
|
|
35901
36113
|
if (addressId === undefined || addressId === null) {
|
|
35902
36114
|
throw 'Missing the required parameter "addressId" when calling putRoutingSmsPhonenumber';
|
|
@@ -35910,7 +36122,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35910
36122
|
'/api/v2/routing/sms/phonenumbers/{addressId}',
|
|
35911
36123
|
'PUT',
|
|
35912
36124
|
{ 'addressId': addressId },
|
|
35913
|
-
{
|
|
36125
|
+
{ 'async': opts['async'] },
|
|
35914
36126
|
{ },
|
|
35915
36127
|
{ },
|
|
35916
36128
|
body,
|
|
@@ -36076,7 +36288,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36076
36288
|
/**
|
|
36077
36289
|
* SCIM service.
|
|
36078
36290
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
36079
|
-
* @version
|
|
36291
|
+
* @version 127.0.0
|
|
36080
36292
|
*/
|
|
36081
36293
|
|
|
36082
36294
|
/**
|
|
@@ -36953,7 +37165,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36953
37165
|
/**
|
|
36954
37166
|
* Scripts service.
|
|
36955
37167
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
36956
|
-
* @version
|
|
37168
|
+
* @version 127.0.0
|
|
36957
37169
|
*/
|
|
36958
37170
|
|
|
36959
37171
|
/**
|
|
@@ -37306,7 +37518,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37306
37518
|
/**
|
|
37307
37519
|
* Search service.
|
|
37308
37520
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
37309
|
-
* @version
|
|
37521
|
+
* @version 127.0.0
|
|
37310
37522
|
*/
|
|
37311
37523
|
|
|
37312
37524
|
/**
|
|
@@ -37841,7 +38053,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37841
38053
|
/**
|
|
37842
38054
|
* SpeechTextAnalytics service.
|
|
37843
38055
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
37844
|
-
* @version
|
|
38056
|
+
* @version 127.0.0
|
|
37845
38057
|
*/
|
|
37846
38058
|
|
|
37847
38059
|
/**
|
|
@@ -37885,6 +38097,51 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37885
38097
|
);
|
|
37886
38098
|
}
|
|
37887
38099
|
|
|
38100
|
+
/**
|
|
38101
|
+
* Delete All Speech & Text Analytics SentimentFeedback
|
|
38102
|
+
*
|
|
38103
|
+
*/
|
|
38104
|
+
deleteSpeechandtextanalyticsSentimentfeedback() {
|
|
38105
|
+
|
|
38106
|
+
return this.apiClient.callApi(
|
|
38107
|
+
'/api/v2/speechandtextanalytics/sentimentfeedback',
|
|
38108
|
+
'DELETE',
|
|
38109
|
+
{ },
|
|
38110
|
+
{ },
|
|
38111
|
+
{ },
|
|
38112
|
+
{ },
|
|
38113
|
+
null,
|
|
38114
|
+
['PureCloud OAuth'],
|
|
38115
|
+
['application/json'],
|
|
38116
|
+
['application/json']
|
|
38117
|
+
);
|
|
38118
|
+
}
|
|
38119
|
+
|
|
38120
|
+
/**
|
|
38121
|
+
* Delete a Speech & Text Analytics SentimentFeedback by Id
|
|
38122
|
+
*
|
|
38123
|
+
* @param {String} sentimentFeedbackId The Id of the SentimentFeedback
|
|
38124
|
+
*/
|
|
38125
|
+
deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId(sentimentFeedbackId) {
|
|
38126
|
+
// verify the required parameter 'sentimentFeedbackId' is set
|
|
38127
|
+
if (sentimentFeedbackId === undefined || sentimentFeedbackId === null) {
|
|
38128
|
+
throw 'Missing the required parameter "sentimentFeedbackId" when calling deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId';
|
|
38129
|
+
}
|
|
38130
|
+
|
|
38131
|
+
return this.apiClient.callApi(
|
|
38132
|
+
'/api/v2/speechandtextanalytics/sentimentfeedback/{sentimentFeedbackId}',
|
|
38133
|
+
'DELETE',
|
|
38134
|
+
{ 'sentimentFeedbackId': sentimentFeedbackId },
|
|
38135
|
+
{ },
|
|
38136
|
+
{ },
|
|
38137
|
+
{ },
|
|
38138
|
+
null,
|
|
38139
|
+
['PureCloud OAuth'],
|
|
38140
|
+
['application/json'],
|
|
38141
|
+
['application/json']
|
|
38142
|
+
);
|
|
38143
|
+
}
|
|
38144
|
+
|
|
37888
38145
|
/**
|
|
37889
38146
|
* Delete a Speech & Text Analytics topic by id
|
|
37890
38147
|
*
|
|
@@ -37967,7 +38224,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37967
38224
|
|
|
37968
38225
|
/**
|
|
37969
38226
|
* Get list of supported Speech & Text Analytics dialects
|
|
37970
|
-
*
|
|
38227
|
+
* This api has been deprecated. Use api/v2/topics/dialects instead
|
|
37971
38228
|
*/
|
|
37972
38229
|
getSpeechandtextanalyticsDialects() {
|
|
37973
38230
|
|
|
@@ -38160,6 +38417,50 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38160
38417
|
);
|
|
38161
38418
|
}
|
|
38162
38419
|
|
|
38420
|
+
/**
|
|
38421
|
+
* Get the list of Speech & Text Analytics sentiment supported dialects
|
|
38422
|
+
*
|
|
38423
|
+
*/
|
|
38424
|
+
getSpeechandtextanalyticsSentimentDialects() {
|
|
38425
|
+
|
|
38426
|
+
return this.apiClient.callApi(
|
|
38427
|
+
'/api/v2/speechandtextanalytics/sentiment/dialects',
|
|
38428
|
+
'GET',
|
|
38429
|
+
{ },
|
|
38430
|
+
{ },
|
|
38431
|
+
{ },
|
|
38432
|
+
{ },
|
|
38433
|
+
null,
|
|
38434
|
+
['PureCloud OAuth'],
|
|
38435
|
+
['application/json'],
|
|
38436
|
+
['application/json']
|
|
38437
|
+
);
|
|
38438
|
+
}
|
|
38439
|
+
|
|
38440
|
+
/**
|
|
38441
|
+
* Get the list of Speech & Text Analytics SentimentFeedback
|
|
38442
|
+
*
|
|
38443
|
+
* @param {Object} opts Optional parameters
|
|
38444
|
+
* @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
|
|
38445
|
+
*/
|
|
38446
|
+
getSpeechandtextanalyticsSentimentfeedback(opts) {
|
|
38447
|
+
opts = opts || {};
|
|
38448
|
+
|
|
38449
|
+
|
|
38450
|
+
return this.apiClient.callApi(
|
|
38451
|
+
'/api/v2/speechandtextanalytics/sentimentfeedback',
|
|
38452
|
+
'GET',
|
|
38453
|
+
{ },
|
|
38454
|
+
{ 'dialect': opts['dialect'] },
|
|
38455
|
+
{ },
|
|
38456
|
+
{ },
|
|
38457
|
+
null,
|
|
38458
|
+
['PureCloud OAuth'],
|
|
38459
|
+
['application/json'],
|
|
38460
|
+
['application/json']
|
|
38461
|
+
);
|
|
38462
|
+
}
|
|
38463
|
+
|
|
38163
38464
|
/**
|
|
38164
38465
|
* Get Speech And Text Analytics Settings
|
|
38165
38466
|
*
|
|
@@ -38404,6 +38705,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38404
38705
|
);
|
|
38405
38706
|
}
|
|
38406
38707
|
|
|
38708
|
+
/**
|
|
38709
|
+
* Create a Speech & Text Analytics SentimentFeedback
|
|
38710
|
+
*
|
|
38711
|
+
* @param {Object} body The SentimentFeedback to create
|
|
38712
|
+
*/
|
|
38713
|
+
postSpeechandtextanalyticsSentimentfeedback(body) {
|
|
38714
|
+
// verify the required parameter 'body' is set
|
|
38715
|
+
if (body === undefined || body === null) {
|
|
38716
|
+
throw 'Missing the required parameter "body" when calling postSpeechandtextanalyticsSentimentfeedback';
|
|
38717
|
+
}
|
|
38718
|
+
|
|
38719
|
+
return this.apiClient.callApi(
|
|
38720
|
+
'/api/v2/speechandtextanalytics/sentimentfeedback',
|
|
38721
|
+
'POST',
|
|
38722
|
+
{ },
|
|
38723
|
+
{ },
|
|
38724
|
+
{ },
|
|
38725
|
+
{ },
|
|
38726
|
+
body,
|
|
38727
|
+
['PureCloud OAuth'],
|
|
38728
|
+
['application/json'],
|
|
38729
|
+
['application/json']
|
|
38730
|
+
);
|
|
38731
|
+
}
|
|
38732
|
+
|
|
38407
38733
|
/**
|
|
38408
38734
|
* Create new Speech & Text Analytics topic
|
|
38409
38735
|
*
|
|
@@ -38600,7 +38926,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38600
38926
|
/**
|
|
38601
38927
|
* Stations service.
|
|
38602
38928
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
38603
|
-
* @version
|
|
38929
|
+
* @version 127.0.0
|
|
38604
38930
|
*/
|
|
38605
38931
|
|
|
38606
38932
|
/**
|
|
@@ -38747,7 +39073,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38747
39073
|
/**
|
|
38748
39074
|
* Suggest service.
|
|
38749
39075
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
38750
|
-
* @version
|
|
39076
|
+
* @version 127.0.0
|
|
38751
39077
|
*/
|
|
38752
39078
|
|
|
38753
39079
|
/**
|
|
@@ -38886,7 +39212,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38886
39212
|
/**
|
|
38887
39213
|
* Telephony service.
|
|
38888
39214
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
38889
|
-
* @version
|
|
39215
|
+
* @version 127.0.0
|
|
38890
39216
|
*/
|
|
38891
39217
|
|
|
38892
39218
|
/**
|
|
@@ -38994,7 +39320,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38994
39320
|
/**
|
|
38995
39321
|
* TelephonyProvidersEdge service.
|
|
38996
39322
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
38997
|
-
* @version
|
|
39323
|
+
* @version 127.0.0
|
|
38998
39324
|
*/
|
|
38999
39325
|
|
|
39000
39326
|
/**
|
|
@@ -42607,7 +42933,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42607
42933
|
/**
|
|
42608
42934
|
* Textbots service.
|
|
42609
42935
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
42610
|
-
* @version
|
|
42936
|
+
* @version 127.0.0
|
|
42611
42937
|
*/
|
|
42612
42938
|
|
|
42613
42939
|
/**
|
|
@@ -42708,7 +43034,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42708
43034
|
/**
|
|
42709
43035
|
* Tokens service.
|
|
42710
43036
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
42711
|
-
* @version
|
|
43037
|
+
* @version 127.0.0
|
|
42712
43038
|
*/
|
|
42713
43039
|
|
|
42714
43040
|
/**
|
|
@@ -42814,7 +43140,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42814
43140
|
/**
|
|
42815
43141
|
* Uploads service.
|
|
42816
43142
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
42817
|
-
* @version
|
|
43143
|
+
* @version 127.0.0
|
|
42818
43144
|
*/
|
|
42819
43145
|
|
|
42820
43146
|
/**
|
|
@@ -42990,7 +43316,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42990
43316
|
/**
|
|
42991
43317
|
* Usage service.
|
|
42992
43318
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
42993
|
-
* @version
|
|
43319
|
+
* @version 127.0.0
|
|
42994
43320
|
*/
|
|
42995
43321
|
|
|
42996
43322
|
/**
|
|
@@ -43061,7 +43387,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43061
43387
|
/**
|
|
43062
43388
|
* UserRecordings service.
|
|
43063
43389
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
43064
|
-
* @version
|
|
43390
|
+
* @version 127.0.0
|
|
43065
43391
|
*/
|
|
43066
43392
|
|
|
43067
43393
|
/**
|
|
@@ -43245,7 +43571,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43245
43571
|
/**
|
|
43246
43572
|
* Users service.
|
|
43247
43573
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
43248
|
-
* @version
|
|
43574
|
+
* @version 127.0.0
|
|
43249
43575
|
*/
|
|
43250
43576
|
|
|
43251
43577
|
/**
|
|
@@ -45547,7 +45873,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45547
45873
|
/**
|
|
45548
45874
|
* Utilities service.
|
|
45549
45875
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
45550
|
-
* @version
|
|
45876
|
+
* @version 127.0.0
|
|
45551
45877
|
*/
|
|
45552
45878
|
|
|
45553
45879
|
/**
|
|
@@ -45658,7 +45984,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45658
45984
|
/**
|
|
45659
45985
|
* Voicemail service.
|
|
45660
45986
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
45661
|
-
* @version
|
|
45987
|
+
* @version 127.0.0
|
|
45662
45988
|
*/
|
|
45663
45989
|
|
|
45664
45990
|
/**
|
|
@@ -46325,7 +46651,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46325
46651
|
/**
|
|
46326
46652
|
* WebChat service.
|
|
46327
46653
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
46328
|
-
* @version
|
|
46654
|
+
* @version 127.0.0
|
|
46329
46655
|
*/
|
|
46330
46656
|
|
|
46331
46657
|
/**
|
|
@@ -46869,7 +47195,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46869
47195
|
/**
|
|
46870
47196
|
* WebDeployments service.
|
|
46871
47197
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
46872
|
-
* @version
|
|
47198
|
+
* @version 127.0.0
|
|
46873
47199
|
*/
|
|
46874
47200
|
|
|
46875
47201
|
/**
|
|
@@ -47224,7 +47550,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47224
47550
|
/**
|
|
47225
47551
|
* WebMessaging service.
|
|
47226
47552
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
47227
|
-
* @version
|
|
47553
|
+
* @version 127.0.0
|
|
47228
47554
|
*/
|
|
47229
47555
|
|
|
47230
47556
|
/**
|
|
@@ -47270,7 +47596,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47270
47596
|
/**
|
|
47271
47597
|
* Widgets service.
|
|
47272
47598
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
47273
|
-
* @version
|
|
47599
|
+
* @version 127.0.0
|
|
47274
47600
|
*/
|
|
47275
47601
|
|
|
47276
47602
|
/**
|
|
@@ -47416,7 +47742,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47416
47742
|
/**
|
|
47417
47743
|
* WorkforceManagement service.
|
|
47418
47744
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
47419
|
-
* @version
|
|
47745
|
+
* @version 127.0.0
|
|
47420
47746
|
*/
|
|
47421
47747
|
|
|
47422
47748
|
/**
|
|
@@ -47691,6 +48017,66 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47691
48017
|
);
|
|
47692
48018
|
}
|
|
47693
48019
|
|
|
48020
|
+
/**
|
|
48021
|
+
* Deletes a time off limit object
|
|
48022
|
+
*
|
|
48023
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
48024
|
+
* @param {String} timeOffLimitId The ID of the time off limit object to delete
|
|
48025
|
+
*/
|
|
48026
|
+
deleteWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
48027
|
+
// verify the required parameter 'managementUnitId' is set
|
|
48028
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
48029
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitTimeofflimit';
|
|
48030
|
+
}
|
|
48031
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
48032
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
48033
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling deleteWorkforcemanagementManagementunitTimeofflimit';
|
|
48034
|
+
}
|
|
48035
|
+
|
|
48036
|
+
return this.apiClient.callApi(
|
|
48037
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
48038
|
+
'DELETE',
|
|
48039
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
48040
|
+
{ },
|
|
48041
|
+
{ },
|
|
48042
|
+
{ },
|
|
48043
|
+
null,
|
|
48044
|
+
['PureCloud OAuth'],
|
|
48045
|
+
['application/json'],
|
|
48046
|
+
['application/json']
|
|
48047
|
+
);
|
|
48048
|
+
}
|
|
48049
|
+
|
|
48050
|
+
/**
|
|
48051
|
+
* Deletes a time off plan
|
|
48052
|
+
*
|
|
48053
|
+
* @param {String} managementUnitId The management unit ID.
|
|
48054
|
+
* @param {String} timeOffPlanId The ID of the time off plan to delete
|
|
48055
|
+
*/
|
|
48056
|
+
deleteWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
48057
|
+
// verify the required parameter 'managementUnitId' is set
|
|
48058
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
48059
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitTimeoffplan';
|
|
48060
|
+
}
|
|
48061
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
48062
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
48063
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling deleteWorkforcemanagementManagementunitTimeoffplan';
|
|
48064
|
+
}
|
|
48065
|
+
|
|
48066
|
+
return this.apiClient.callApi(
|
|
48067
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
48068
|
+
'DELETE',
|
|
48069
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
48070
|
+
{ },
|
|
48071
|
+
{ },
|
|
48072
|
+
{ },
|
|
48073
|
+
null,
|
|
48074
|
+
['PureCloud OAuth'],
|
|
48075
|
+
['application/json'],
|
|
48076
|
+
['application/json']
|
|
48077
|
+
);
|
|
48078
|
+
}
|
|
48079
|
+
|
|
47694
48080
|
/**
|
|
47695
48081
|
* Delete a work plan
|
|
47696
48082
|
*
|
|
@@ -48932,6 +49318,116 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48932
49318
|
);
|
|
48933
49319
|
}
|
|
48934
49320
|
|
|
49321
|
+
/**
|
|
49322
|
+
* Gets a time off limit object
|
|
49323
|
+
* Returns properties of time off limit object, but not daily values.
|
|
49324
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
49325
|
+
* @param {String} timeOffLimitId The ID of the time off limit to fetch
|
|
49326
|
+
*/
|
|
49327
|
+
getWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
49328
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49329
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49330
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeofflimit';
|
|
49331
|
+
}
|
|
49332
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
49333
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
49334
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling getWorkforcemanagementManagementunitTimeofflimit';
|
|
49335
|
+
}
|
|
49336
|
+
|
|
49337
|
+
return this.apiClient.callApi(
|
|
49338
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
49339
|
+
'GET',
|
|
49340
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
49341
|
+
{ },
|
|
49342
|
+
{ },
|
|
49343
|
+
{ },
|
|
49344
|
+
null,
|
|
49345
|
+
['PureCloud OAuth'],
|
|
49346
|
+
['application/json'],
|
|
49347
|
+
['application/json']
|
|
49348
|
+
);
|
|
49349
|
+
}
|
|
49350
|
+
|
|
49351
|
+
/**
|
|
49352
|
+
* Gets a list of time off limit objects under management unit.
|
|
49353
|
+
* Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.
|
|
49354
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
49355
|
+
*/
|
|
49356
|
+
getWorkforcemanagementManagementunitTimeofflimits(managementUnitId) {
|
|
49357
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49358
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49359
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeofflimits';
|
|
49360
|
+
}
|
|
49361
|
+
|
|
49362
|
+
return this.apiClient.callApi(
|
|
49363
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits',
|
|
49364
|
+
'GET',
|
|
49365
|
+
{ 'managementUnitId': managementUnitId },
|
|
49366
|
+
{ },
|
|
49367
|
+
{ },
|
|
49368
|
+
{ },
|
|
49369
|
+
null,
|
|
49370
|
+
['PureCloud OAuth'],
|
|
49371
|
+
['application/json'],
|
|
49372
|
+
['application/json']
|
|
49373
|
+
);
|
|
49374
|
+
}
|
|
49375
|
+
|
|
49376
|
+
/**
|
|
49377
|
+
* Gets a time off plan
|
|
49378
|
+
*
|
|
49379
|
+
* @param {String} managementUnitId The management unit ID.
|
|
49380
|
+
* @param {String} timeOffPlanId The ID of the time off plan to fetch
|
|
49381
|
+
*/
|
|
49382
|
+
getWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
49383
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49384
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49385
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeoffplan';
|
|
49386
|
+
}
|
|
49387
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
49388
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
49389
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling getWorkforcemanagementManagementunitTimeoffplan';
|
|
49390
|
+
}
|
|
49391
|
+
|
|
49392
|
+
return this.apiClient.callApi(
|
|
49393
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
49394
|
+
'GET',
|
|
49395
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
49396
|
+
{ },
|
|
49397
|
+
{ },
|
|
49398
|
+
{ },
|
|
49399
|
+
null,
|
|
49400
|
+
['PureCloud OAuth'],
|
|
49401
|
+
['application/json'],
|
|
49402
|
+
['application/json']
|
|
49403
|
+
);
|
|
49404
|
+
}
|
|
49405
|
+
|
|
49406
|
+
/**
|
|
49407
|
+
* Gets a list of time off plans
|
|
49408
|
+
*
|
|
49409
|
+
* @param {String} managementUnitId The management unit ID.
|
|
49410
|
+
*/
|
|
49411
|
+
getWorkforcemanagementManagementunitTimeoffplans(managementUnitId) {
|
|
49412
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49413
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49414
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeoffplans';
|
|
49415
|
+
}
|
|
49416
|
+
|
|
49417
|
+
return this.apiClient.callApi(
|
|
49418
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans',
|
|
49419
|
+
'GET',
|
|
49420
|
+
{ 'managementUnitId': managementUnitId },
|
|
49421
|
+
{ },
|
|
49422
|
+
{ },
|
|
49423
|
+
{ },
|
|
49424
|
+
null,
|
|
49425
|
+
['PureCloud OAuth'],
|
|
49426
|
+
['application/json'],
|
|
49427
|
+
['application/json']
|
|
49428
|
+
);
|
|
49429
|
+
}
|
|
49430
|
+
|
|
48935
49431
|
/**
|
|
48936
49432
|
* Get a time off request
|
|
48937
49433
|
*
|
|
@@ -48967,6 +49463,41 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48967
49463
|
);
|
|
48968
49464
|
}
|
|
48969
49465
|
|
|
49466
|
+
/**
|
|
49467
|
+
* Retrieves time off limit, allocated and waitlisted values according to specific time off request
|
|
49468
|
+
*
|
|
49469
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
49470
|
+
* @param {String} userId The userId to whom the time off request applies.
|
|
49471
|
+
* @param {String} timeOffRequestId The ID of the time off request, which dates and activityCodeId determine limit values to retrieve
|
|
49472
|
+
*/
|
|
49473
|
+
getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits(managementUnitId, userId, timeOffRequestId) {
|
|
49474
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49475
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49476
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
49477
|
+
}
|
|
49478
|
+
// verify the required parameter 'userId' is set
|
|
49479
|
+
if (userId === undefined || userId === null) {
|
|
49480
|
+
throw 'Missing the required parameter "userId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
49481
|
+
}
|
|
49482
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
49483
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
49484
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
49485
|
+
}
|
|
49486
|
+
|
|
49487
|
+
return this.apiClient.callApi(
|
|
49488
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeofflimits',
|
|
49489
|
+
'GET',
|
|
49490
|
+
{ 'managementUnitId': managementUnitId,'userId': userId,'timeOffRequestId': timeOffRequestId },
|
|
49491
|
+
{ },
|
|
49492
|
+
{ },
|
|
49493
|
+
{ },
|
|
49494
|
+
null,
|
|
49495
|
+
['PureCloud OAuth'],
|
|
49496
|
+
['application/json'],
|
|
49497
|
+
['application/json']
|
|
49498
|
+
);
|
|
49499
|
+
}
|
|
49500
|
+
|
|
48970
49501
|
/**
|
|
48971
49502
|
* Get a list of time off requests for a given user
|
|
48972
49503
|
*
|
|
@@ -49400,6 +49931,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49400
49931
|
);
|
|
49401
49932
|
}
|
|
49402
49933
|
|
|
49934
|
+
/**
|
|
49935
|
+
* Get the daily waitlist positions of a time off request for the current user
|
|
49936
|
+
*
|
|
49937
|
+
* @param {String} timeOffRequestId Time Off Request Id
|
|
49938
|
+
*/
|
|
49939
|
+
getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId) {
|
|
49940
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
49941
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
49942
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementTimeoffrequestWaitlistpositions';
|
|
49943
|
+
}
|
|
49944
|
+
|
|
49945
|
+
return this.apiClient.callApi(
|
|
49946
|
+
'/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}/waitlistpositions',
|
|
49947
|
+
'GET',
|
|
49948
|
+
{ 'timeOffRequestId': timeOffRequestId },
|
|
49949
|
+
{ },
|
|
49950
|
+
{ },
|
|
49951
|
+
{ },
|
|
49952
|
+
null,
|
|
49953
|
+
['PureCloud OAuth'],
|
|
49954
|
+
['application/json'],
|
|
49955
|
+
['application/json']
|
|
49956
|
+
);
|
|
49957
|
+
}
|
|
49958
|
+
|
|
49403
49959
|
/**
|
|
49404
49960
|
* Get a list of time off requests for the current user
|
|
49405
49961
|
*
|
|
@@ -49618,6 +50174,74 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49618
50174
|
);
|
|
49619
50175
|
}
|
|
49620
50176
|
|
|
50177
|
+
/**
|
|
50178
|
+
* Updates a time off limit object.
|
|
50179
|
+
* Updates time off limit object properties, but not daily values.
|
|
50180
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
50181
|
+
* @param {String} timeOffLimitId The id of time off limit object to update
|
|
50182
|
+
* @param {Object} opts Optional parameters
|
|
50183
|
+
* @param {Object} opts.body body
|
|
50184
|
+
*/
|
|
50185
|
+
patchWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId, opts) {
|
|
50186
|
+
opts = opts || {};
|
|
50187
|
+
|
|
50188
|
+
// verify the required parameter 'managementUnitId' is set
|
|
50189
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
50190
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
50191
|
+
}
|
|
50192
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
50193
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
50194
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
50195
|
+
}
|
|
50196
|
+
|
|
50197
|
+
return this.apiClient.callApi(
|
|
50198
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
50199
|
+
'PATCH',
|
|
50200
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
50201
|
+
{ },
|
|
50202
|
+
{ },
|
|
50203
|
+
{ },
|
|
50204
|
+
opts['body'],
|
|
50205
|
+
['PureCloud OAuth'],
|
|
50206
|
+
['application/json'],
|
|
50207
|
+
['application/json']
|
|
50208
|
+
);
|
|
50209
|
+
}
|
|
50210
|
+
|
|
50211
|
+
/**
|
|
50212
|
+
* Updates a time off plan
|
|
50213
|
+
*
|
|
50214
|
+
* @param {String} managementUnitId The management unit ID.
|
|
50215
|
+
* @param {String} timeOffPlanId The ID of the time off plan to update
|
|
50216
|
+
* @param {Object} opts Optional parameters
|
|
50217
|
+
* @param {Object} opts.body body
|
|
50218
|
+
*/
|
|
50219
|
+
patchWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId, opts) {
|
|
50220
|
+
opts = opts || {};
|
|
50221
|
+
|
|
50222
|
+
// verify the required parameter 'managementUnitId' is set
|
|
50223
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
50224
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
50225
|
+
}
|
|
50226
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
50227
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
50228
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
50229
|
+
}
|
|
50230
|
+
|
|
50231
|
+
return this.apiClient.callApi(
|
|
50232
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
50233
|
+
'PATCH',
|
|
50234
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
50235
|
+
{ },
|
|
50236
|
+
{ },
|
|
50237
|
+
{ },
|
|
50238
|
+
opts['body'],
|
|
50239
|
+
['PureCloud OAuth'],
|
|
50240
|
+
['application/json'],
|
|
50241
|
+
['application/json']
|
|
50242
|
+
);
|
|
50243
|
+
}
|
|
50244
|
+
|
|
49621
50245
|
/**
|
|
49622
50246
|
* Update a time off request
|
|
49623
50247
|
*
|
|
@@ -50479,6 +51103,93 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50479
51103
|
);
|
|
50480
51104
|
}
|
|
50481
51105
|
|
|
51106
|
+
/**
|
|
51107
|
+
* Creates a new time off limit object under management unit.
|
|
51108
|
+
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
51109
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51110
|
+
* @param {Object} opts Optional parameters
|
|
51111
|
+
* @param {Object} opts.body body
|
|
51112
|
+
*/
|
|
51113
|
+
postWorkforcemanagementManagementunitTimeofflimits(managementUnitId, opts) {
|
|
51114
|
+
opts = opts || {};
|
|
51115
|
+
|
|
51116
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51117
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51118
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimits';
|
|
51119
|
+
}
|
|
51120
|
+
|
|
51121
|
+
return this.apiClient.callApi(
|
|
51122
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits',
|
|
51123
|
+
'POST',
|
|
51124
|
+
{ 'managementUnitId': managementUnitId },
|
|
51125
|
+
{ },
|
|
51126
|
+
{ },
|
|
51127
|
+
{ },
|
|
51128
|
+
opts['body'],
|
|
51129
|
+
['PureCloud OAuth'],
|
|
51130
|
+
['application/json'],
|
|
51131
|
+
['application/json']
|
|
51132
|
+
);
|
|
51133
|
+
}
|
|
51134
|
+
|
|
51135
|
+
/**
|
|
51136
|
+
* Retrieves time off limit related values based on a given set of filters.
|
|
51137
|
+
*
|
|
51138
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51139
|
+
* @param {Object} opts Optional parameters
|
|
51140
|
+
* @param {Object} opts.body body
|
|
51141
|
+
*/
|
|
51142
|
+
postWorkforcemanagementManagementunitTimeofflimitsValuesQuery(managementUnitId, opts) {
|
|
51143
|
+
opts = opts || {};
|
|
51144
|
+
|
|
51145
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51146
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51147
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimitsValuesQuery';
|
|
51148
|
+
}
|
|
51149
|
+
|
|
51150
|
+
return this.apiClient.callApi(
|
|
51151
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/values/query',
|
|
51152
|
+
'POST',
|
|
51153
|
+
{ 'managementUnitId': managementUnitId },
|
|
51154
|
+
{ },
|
|
51155
|
+
{ },
|
|
51156
|
+
{ },
|
|
51157
|
+
opts['body'],
|
|
51158
|
+
['PureCloud OAuth'],
|
|
51159
|
+
['application/json'],
|
|
51160
|
+
['application/json']
|
|
51161
|
+
);
|
|
51162
|
+
}
|
|
51163
|
+
|
|
51164
|
+
/**
|
|
51165
|
+
* Creates a new time off plan
|
|
51166
|
+
*
|
|
51167
|
+
* @param {String} managementUnitId The management unit ID.
|
|
51168
|
+
* @param {Object} opts Optional parameters
|
|
51169
|
+
* @param {Object} opts.body body
|
|
51170
|
+
*/
|
|
51171
|
+
postWorkforcemanagementManagementunitTimeoffplans(managementUnitId, opts) {
|
|
51172
|
+
opts = opts || {};
|
|
51173
|
+
|
|
51174
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51175
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51176
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffplans';
|
|
51177
|
+
}
|
|
51178
|
+
|
|
51179
|
+
return this.apiClient.callApi(
|
|
51180
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans',
|
|
51181
|
+
'POST',
|
|
51182
|
+
{ 'managementUnitId': managementUnitId },
|
|
51183
|
+
{ },
|
|
51184
|
+
{ },
|
|
51185
|
+
{ },
|
|
51186
|
+
opts['body'],
|
|
51187
|
+
['PureCloud OAuth'],
|
|
51188
|
+
['application/json'],
|
|
51189
|
+
['application/json']
|
|
51190
|
+
);
|
|
51191
|
+
}
|
|
51192
|
+
|
|
50482
51193
|
/**
|
|
50483
51194
|
* Create a new time off request
|
|
50484
51195
|
*
|
|
@@ -50537,6 +51248,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50537
51248
|
);
|
|
50538
51249
|
}
|
|
50539
51250
|
|
|
51251
|
+
/**
|
|
51252
|
+
* Retrieves daily waitlist position for a list of time off requests
|
|
51253
|
+
*
|
|
51254
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51255
|
+
* @param {Object} opts Optional parameters
|
|
51256
|
+
* @param {Object} opts.body body
|
|
51257
|
+
*/
|
|
51258
|
+
postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery(managementUnitId, opts) {
|
|
51259
|
+
opts = opts || {};
|
|
51260
|
+
|
|
51261
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51262
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51263
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery';
|
|
51264
|
+
}
|
|
51265
|
+
|
|
51266
|
+
return this.apiClient.callApi(
|
|
51267
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/waitlistpositions/query',
|
|
51268
|
+
'POST',
|
|
51269
|
+
{ 'managementUnitId': managementUnitId },
|
|
51270
|
+
{ },
|
|
51271
|
+
{ },
|
|
51272
|
+
{ },
|
|
51273
|
+
opts['body'],
|
|
51274
|
+
['PureCloud OAuth'],
|
|
51275
|
+
['application/json'],
|
|
51276
|
+
['application/json']
|
|
51277
|
+
);
|
|
51278
|
+
}
|
|
51279
|
+
|
|
50540
51280
|
/**
|
|
50541
51281
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
50542
51282
|
*
|
|
@@ -50920,6 +51660,30 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50920
51660
|
);
|
|
50921
51661
|
}
|
|
50922
51662
|
|
|
51663
|
+
/**
|
|
51664
|
+
* Queries available time off for the current user
|
|
51665
|
+
*
|
|
51666
|
+
* @param {Object} opts Optional parameters
|
|
51667
|
+
* @param {Object} opts.body body
|
|
51668
|
+
*/
|
|
51669
|
+
postWorkforcemanagementTimeofflimitsAvailableQuery(opts) {
|
|
51670
|
+
opts = opts || {};
|
|
51671
|
+
|
|
51672
|
+
|
|
51673
|
+
return this.apiClient.callApi(
|
|
51674
|
+
'/api/v2/workforcemanagement/timeofflimits/available/query',
|
|
51675
|
+
'POST',
|
|
51676
|
+
{ },
|
|
51677
|
+
{ },
|
|
51678
|
+
{ },
|
|
51679
|
+
{ },
|
|
51680
|
+
opts['body'],
|
|
51681
|
+
['PureCloud OAuth'],
|
|
51682
|
+
['application/json'],
|
|
51683
|
+
['application/json']
|
|
51684
|
+
);
|
|
51685
|
+
}
|
|
51686
|
+
|
|
50923
51687
|
/**
|
|
50924
51688
|
* Create a time off request for the current user
|
|
50925
51689
|
*
|
|
@@ -50944,6 +51708,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50944
51708
|
);
|
|
50945
51709
|
}
|
|
50946
51710
|
|
|
51711
|
+
/**
|
|
51712
|
+
* Sets daily values for a date range of time off limit object
|
|
51713
|
+
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
51714
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51715
|
+
* @param {String} timeOffLimitId The ID of the time off limit object to set values for
|
|
51716
|
+
* @param {Object} opts Optional parameters
|
|
51717
|
+
* @param {Object} opts.body body
|
|
51718
|
+
*/
|
|
51719
|
+
putWorkforcemanagementManagementunitTimeofflimitValues(managementUnitId, timeOffLimitId, opts) {
|
|
51720
|
+
opts = opts || {};
|
|
51721
|
+
|
|
51722
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51723
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51724
|
+
throw 'Missing the required parameter "managementUnitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
51725
|
+
}
|
|
51726
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
51727
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
51728
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
51729
|
+
}
|
|
51730
|
+
|
|
51731
|
+
return this.apiClient.callApi(
|
|
51732
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}/values',
|
|
51733
|
+
'PUT',
|
|
51734
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
51735
|
+
{ },
|
|
51736
|
+
{ },
|
|
51737
|
+
{ },
|
|
51738
|
+
opts['body'],
|
|
51739
|
+
['PureCloud OAuth'],
|
|
51740
|
+
['application/json'],
|
|
51741
|
+
['application/json']
|
|
51742
|
+
);
|
|
51743
|
+
}
|
|
51744
|
+
|
|
50947
51745
|
}
|
|
50948
51746
|
|
|
50949
51747
|
/**
|
|
@@ -50975,7 +51773,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50975
51773
|
* </pre>
|
|
50976
51774
|
* </p>
|
|
50977
51775
|
* @module purecloud-platform-client-v2/index
|
|
50978
|
-
* @version
|
|
51776
|
+
* @version 127.0.0
|
|
50979
51777
|
*/
|
|
50980
51778
|
class platformClient {
|
|
50981
51779
|
constructor() {
|