purecloud-platform-client-v2 123.0.0 → 126.1.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 +6 -2
- package/dist/node/purecloud-platform-client-v2.js +941 -137
- package/dist/web-amd/purecloud-platform-client-v2.js +941 -137
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +901 -141
- package/dist/web-cjs/purecloud-platform-client-v2.js +914 -1304
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1177 -50
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +22 -11
- 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 +96 -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 +31 -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
|
-
|
|
289
|
-
|
|
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');
|
|
290
295
|
|
|
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 126.1.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': '126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.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 126.1.0
|
|
31328
31525
|
*/
|
|
31329
31526
|
|
|
31330
31527
|
/**
|
|
@@ -32843,7 +33040,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32843
33040
|
/**
|
|
32844
33041
|
* ResponseManagement service.
|
|
32845
33042
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
32846
|
-
* @version
|
|
33043
|
+
* @version 126.1.0
|
|
32847
33044
|
*/
|
|
32848
33045
|
|
|
32849
33046
|
/**
|
|
@@ -33168,7 +33365,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33168
33365
|
/**
|
|
33169
33366
|
* Routing service.
|
|
33170
33367
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
33171
|
-
* @version
|
|
33368
|
+
* @version 126.1.0
|
|
33172
33369
|
*/
|
|
33173
33370
|
|
|
33174
33371
|
/**
|
|
@@ -33481,8 +33678,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33481
33678
|
* Delete a phone number provisioned for SMS.
|
|
33482
33679
|
*
|
|
33483
33680
|
* @param {String} addressId Address ID
|
|
33681
|
+
* @param {Object} opts Optional parameters
|
|
33682
|
+
* @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
33683
|
*/
|
|
33485
|
-
deleteRoutingSmsPhonenumber(addressId) {
|
|
33684
|
+
deleteRoutingSmsPhonenumber(addressId, opts) {
|
|
33685
|
+
opts = opts || {};
|
|
33686
|
+
|
|
33486
33687
|
// verify the required parameter 'addressId' is set
|
|
33487
33688
|
if (addressId === undefined || addressId === null) {
|
|
33488
33689
|
throw 'Missing the required parameter "addressId" when calling deleteRoutingSmsPhonenumber';
|
|
@@ -33492,7 +33693,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33492
33693
|
'/api/v2/routing/sms/phonenumbers/{addressId}',
|
|
33493
33694
|
'DELETE',
|
|
33494
33695
|
{ 'addressId': addressId },
|
|
33495
|
-
{
|
|
33696
|
+
{ 'async': opts['async'] },
|
|
33496
33697
|
{ },
|
|
33497
33698
|
{ },
|
|
33498
33699
|
null,
|
|
@@ -34320,12 +34521,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34320
34521
|
}
|
|
34321
34522
|
|
|
34322
34523
|
/**
|
|
34323
|
-
* Get a paged listing of simplified queue objects. Can be used to get a digest of all queues in an organization.
|
|
34524
|
+
* Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization.
|
|
34324
34525
|
*
|
|
34325
34526
|
* @param {Object} opts Optional parameters
|
|
34326
34527
|
* @param {Number} opts.pageSize Page size [max value is 500] (default to 25)
|
|
34327
34528
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
34328
|
-
* @param {Object} opts.sortBy Sort by (default to name)
|
|
34329
34529
|
* @param {Object} opts.sortOrder Sort order (default to asc)
|
|
34330
34530
|
*/
|
|
34331
34531
|
getRoutingQueuesDivisionviewsAll(opts) {
|
|
@@ -34336,7 +34536,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34336
34536
|
'/api/v2/routing/queues/divisionviews/all',
|
|
34337
34537
|
'GET',
|
|
34338
34538
|
{ },
|
|
34339
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'
|
|
34539
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'] },
|
|
34340
34540
|
{ },
|
|
34341
34541
|
{ },
|
|
34342
34542
|
null,
|
|
@@ -34820,7 +35020,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34820
35020
|
|
|
34821
35021
|
/**
|
|
34822
35022
|
* Update attributes of an in-queue conversation
|
|
34823
|
-
* Returns an object indicating the updated values of all settable attributes. Supported attributes:
|
|
35023
|
+
* Returns an object indicating the updated values of all settable attributes. Supported attributes: skillIds, languageId, and priority.
|
|
34824
35024
|
* @param {String} conversationId Conversation ID
|
|
34825
35025
|
* @param {Object} body Conversation Attributes
|
|
34826
35026
|
*/
|
|
@@ -35639,8 +35839,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35639
35839
|
* Provision a phone number for SMS
|
|
35640
35840
|
*
|
|
35641
35841
|
* @param {Object} body SmsPhoneNumber
|
|
35842
|
+
* @param {Object} opts Optional parameters
|
|
35843
|
+
* @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
35844
|
*/
|
|
35643
|
-
postRoutingSmsPhonenumbers(body) {
|
|
35845
|
+
postRoutingSmsPhonenumbers(body, opts) {
|
|
35846
|
+
opts = opts || {};
|
|
35847
|
+
|
|
35644
35848
|
// verify the required parameter 'body' is set
|
|
35645
35849
|
if (body === undefined || body === null) {
|
|
35646
35850
|
throw 'Missing the required parameter "body" when calling postRoutingSmsPhonenumbers';
|
|
@@ -35650,7 +35854,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35650
35854
|
'/api/v2/routing/sms/phonenumbers',
|
|
35651
35855
|
'POST',
|
|
35652
35856
|
{ },
|
|
35653
|
-
{
|
|
35857
|
+
{ 'async': opts['async'] },
|
|
35654
35858
|
{ },
|
|
35655
35859
|
{ },
|
|
35656
35860
|
body,
|
|
@@ -35895,8 +36099,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35895
36099
|
*
|
|
35896
36100
|
* @param {String} addressId Address ID
|
|
35897
36101
|
* @param {Object} body SmsPhoneNumber
|
|
36102
|
+
* @param {Object} opts Optional parameters
|
|
36103
|
+
* @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
36104
|
*/
|
|
35899
|
-
putRoutingSmsPhonenumber(addressId, body) {
|
|
36105
|
+
putRoutingSmsPhonenumber(addressId, body, opts) {
|
|
36106
|
+
opts = opts || {};
|
|
36107
|
+
|
|
35900
36108
|
// verify the required parameter 'addressId' is set
|
|
35901
36109
|
if (addressId === undefined || addressId === null) {
|
|
35902
36110
|
throw 'Missing the required parameter "addressId" when calling putRoutingSmsPhonenumber';
|
|
@@ -35910,7 +36118,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35910
36118
|
'/api/v2/routing/sms/phonenumbers/{addressId}',
|
|
35911
36119
|
'PUT',
|
|
35912
36120
|
{ 'addressId': addressId },
|
|
35913
|
-
{
|
|
36121
|
+
{ 'async': opts['async'] },
|
|
35914
36122
|
{ },
|
|
35915
36123
|
{ },
|
|
35916
36124
|
body,
|
|
@@ -36076,7 +36284,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36076
36284
|
/**
|
|
36077
36285
|
* SCIM service.
|
|
36078
36286
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
36079
|
-
* @version
|
|
36287
|
+
* @version 126.1.0
|
|
36080
36288
|
*/
|
|
36081
36289
|
|
|
36082
36290
|
/**
|
|
@@ -36953,7 +37161,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36953
37161
|
/**
|
|
36954
37162
|
* Scripts service.
|
|
36955
37163
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
36956
|
-
* @version
|
|
37164
|
+
* @version 126.1.0
|
|
36957
37165
|
*/
|
|
36958
37166
|
|
|
36959
37167
|
/**
|
|
@@ -37306,7 +37514,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37306
37514
|
/**
|
|
37307
37515
|
* Search service.
|
|
37308
37516
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
37309
|
-
* @version
|
|
37517
|
+
* @version 126.1.0
|
|
37310
37518
|
*/
|
|
37311
37519
|
|
|
37312
37520
|
/**
|
|
@@ -37841,7 +38049,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37841
38049
|
/**
|
|
37842
38050
|
* SpeechTextAnalytics service.
|
|
37843
38051
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
37844
|
-
* @version
|
|
38052
|
+
* @version 126.1.0
|
|
37845
38053
|
*/
|
|
37846
38054
|
|
|
37847
38055
|
/**
|
|
@@ -37885,6 +38093,51 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37885
38093
|
);
|
|
37886
38094
|
}
|
|
37887
38095
|
|
|
38096
|
+
/**
|
|
38097
|
+
* Delete All Speech & Text Analytics SentimentFeedback
|
|
38098
|
+
*
|
|
38099
|
+
*/
|
|
38100
|
+
deleteSpeechandtextanalyticsSentimentfeedback() {
|
|
38101
|
+
|
|
38102
|
+
return this.apiClient.callApi(
|
|
38103
|
+
'/api/v2/speechandtextanalytics/sentimentfeedback',
|
|
38104
|
+
'DELETE',
|
|
38105
|
+
{ },
|
|
38106
|
+
{ },
|
|
38107
|
+
{ },
|
|
38108
|
+
{ },
|
|
38109
|
+
null,
|
|
38110
|
+
['PureCloud OAuth'],
|
|
38111
|
+
['application/json'],
|
|
38112
|
+
['application/json']
|
|
38113
|
+
);
|
|
38114
|
+
}
|
|
38115
|
+
|
|
38116
|
+
/**
|
|
38117
|
+
* Delete a Speech & Text Analytics SentimentFeedback by Id
|
|
38118
|
+
*
|
|
38119
|
+
* @param {String} sentimentFeedbackId The Id of the SentimentFeedback
|
|
38120
|
+
*/
|
|
38121
|
+
deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId(sentimentFeedbackId) {
|
|
38122
|
+
// verify the required parameter 'sentimentFeedbackId' is set
|
|
38123
|
+
if (sentimentFeedbackId === undefined || sentimentFeedbackId === null) {
|
|
38124
|
+
throw 'Missing the required parameter "sentimentFeedbackId" when calling deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId';
|
|
38125
|
+
}
|
|
38126
|
+
|
|
38127
|
+
return this.apiClient.callApi(
|
|
38128
|
+
'/api/v2/speechandtextanalytics/sentimentfeedback/{sentimentFeedbackId}',
|
|
38129
|
+
'DELETE',
|
|
38130
|
+
{ 'sentimentFeedbackId': sentimentFeedbackId },
|
|
38131
|
+
{ },
|
|
38132
|
+
{ },
|
|
38133
|
+
{ },
|
|
38134
|
+
null,
|
|
38135
|
+
['PureCloud OAuth'],
|
|
38136
|
+
['application/json'],
|
|
38137
|
+
['application/json']
|
|
38138
|
+
);
|
|
38139
|
+
}
|
|
38140
|
+
|
|
37888
38141
|
/**
|
|
37889
38142
|
* Delete a Speech & Text Analytics topic by id
|
|
37890
38143
|
*
|
|
@@ -37967,7 +38220,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37967
38220
|
|
|
37968
38221
|
/**
|
|
37969
38222
|
* Get list of supported Speech & Text Analytics dialects
|
|
37970
|
-
*
|
|
38223
|
+
* This api has been deprecated. Use api/v2/topics/dialects instead
|
|
37971
38224
|
*/
|
|
37972
38225
|
getSpeechandtextanalyticsDialects() {
|
|
37973
38226
|
|
|
@@ -38160,6 +38413,30 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38160
38413
|
);
|
|
38161
38414
|
}
|
|
38162
38415
|
|
|
38416
|
+
/**
|
|
38417
|
+
* Get the list of Speech & Text Analytics SentimentFeedback
|
|
38418
|
+
*
|
|
38419
|
+
* @param {Object} opts Optional parameters
|
|
38420
|
+
* @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
|
|
38421
|
+
*/
|
|
38422
|
+
getSpeechandtextanalyticsSentimentfeedback(opts) {
|
|
38423
|
+
opts = opts || {};
|
|
38424
|
+
|
|
38425
|
+
|
|
38426
|
+
return this.apiClient.callApi(
|
|
38427
|
+
'/api/v2/speechandtextanalytics/sentimentfeedback',
|
|
38428
|
+
'GET',
|
|
38429
|
+
{ },
|
|
38430
|
+
{ 'dialect': opts['dialect'] },
|
|
38431
|
+
{ },
|
|
38432
|
+
{ },
|
|
38433
|
+
null,
|
|
38434
|
+
['PureCloud OAuth'],
|
|
38435
|
+
['application/json'],
|
|
38436
|
+
['application/json']
|
|
38437
|
+
);
|
|
38438
|
+
}
|
|
38439
|
+
|
|
38163
38440
|
/**
|
|
38164
38441
|
* Get Speech And Text Analytics Settings
|
|
38165
38442
|
*
|
|
@@ -38404,6 +38681,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38404
38681
|
);
|
|
38405
38682
|
}
|
|
38406
38683
|
|
|
38684
|
+
/**
|
|
38685
|
+
* Create a Speech & Text Analytics SentimentFeedback
|
|
38686
|
+
*
|
|
38687
|
+
* @param {Object} body The SentimentFeedback to create
|
|
38688
|
+
*/
|
|
38689
|
+
postSpeechandtextanalyticsSentimentfeedback(body) {
|
|
38690
|
+
// verify the required parameter 'body' is set
|
|
38691
|
+
if (body === undefined || body === null) {
|
|
38692
|
+
throw 'Missing the required parameter "body" when calling postSpeechandtextanalyticsSentimentfeedback';
|
|
38693
|
+
}
|
|
38694
|
+
|
|
38695
|
+
return this.apiClient.callApi(
|
|
38696
|
+
'/api/v2/speechandtextanalytics/sentimentfeedback',
|
|
38697
|
+
'POST',
|
|
38698
|
+
{ },
|
|
38699
|
+
{ },
|
|
38700
|
+
{ },
|
|
38701
|
+
{ },
|
|
38702
|
+
body,
|
|
38703
|
+
['PureCloud OAuth'],
|
|
38704
|
+
['application/json'],
|
|
38705
|
+
['application/json']
|
|
38706
|
+
);
|
|
38707
|
+
}
|
|
38708
|
+
|
|
38407
38709
|
/**
|
|
38408
38710
|
* Create new Speech & Text Analytics topic
|
|
38409
38711
|
*
|
|
@@ -38600,7 +38902,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38600
38902
|
/**
|
|
38601
38903
|
* Stations service.
|
|
38602
38904
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
38603
|
-
* @version
|
|
38905
|
+
* @version 126.1.0
|
|
38604
38906
|
*/
|
|
38605
38907
|
|
|
38606
38908
|
/**
|
|
@@ -38747,7 +39049,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38747
39049
|
/**
|
|
38748
39050
|
* Suggest service.
|
|
38749
39051
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
38750
|
-
* @version
|
|
39052
|
+
* @version 126.1.0
|
|
38751
39053
|
*/
|
|
38752
39054
|
|
|
38753
39055
|
/**
|
|
@@ -38886,7 +39188,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38886
39188
|
/**
|
|
38887
39189
|
* Telephony service.
|
|
38888
39190
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
38889
|
-
* @version
|
|
39191
|
+
* @version 126.1.0
|
|
38890
39192
|
*/
|
|
38891
39193
|
|
|
38892
39194
|
/**
|
|
@@ -38994,7 +39296,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38994
39296
|
/**
|
|
38995
39297
|
* TelephonyProvidersEdge service.
|
|
38996
39298
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
38997
|
-
* @version
|
|
39299
|
+
* @version 126.1.0
|
|
38998
39300
|
*/
|
|
38999
39301
|
|
|
39000
39302
|
/**
|
|
@@ -42607,7 +42909,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42607
42909
|
/**
|
|
42608
42910
|
* Textbots service.
|
|
42609
42911
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
42610
|
-
* @version
|
|
42912
|
+
* @version 126.1.0
|
|
42611
42913
|
*/
|
|
42612
42914
|
|
|
42613
42915
|
/**
|
|
@@ -42708,7 +43010,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42708
43010
|
/**
|
|
42709
43011
|
* Tokens service.
|
|
42710
43012
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
42711
|
-
* @version
|
|
43013
|
+
* @version 126.1.0
|
|
42712
43014
|
*/
|
|
42713
43015
|
|
|
42714
43016
|
/**
|
|
@@ -42814,7 +43116,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42814
43116
|
/**
|
|
42815
43117
|
* Uploads service.
|
|
42816
43118
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
42817
|
-
* @version
|
|
43119
|
+
* @version 126.1.0
|
|
42818
43120
|
*/
|
|
42819
43121
|
|
|
42820
43122
|
/**
|
|
@@ -42990,7 +43292,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42990
43292
|
/**
|
|
42991
43293
|
* Usage service.
|
|
42992
43294
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
42993
|
-
* @version
|
|
43295
|
+
* @version 126.1.0
|
|
42994
43296
|
*/
|
|
42995
43297
|
|
|
42996
43298
|
/**
|
|
@@ -43061,7 +43363,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43061
43363
|
/**
|
|
43062
43364
|
* UserRecordings service.
|
|
43063
43365
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
43064
|
-
* @version
|
|
43366
|
+
* @version 126.1.0
|
|
43065
43367
|
*/
|
|
43066
43368
|
|
|
43067
43369
|
/**
|
|
@@ -43245,7 +43547,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43245
43547
|
/**
|
|
43246
43548
|
* Users service.
|
|
43247
43549
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
43248
|
-
* @version
|
|
43550
|
+
* @version 126.1.0
|
|
43249
43551
|
*/
|
|
43250
43552
|
|
|
43251
43553
|
/**
|
|
@@ -45547,7 +45849,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45547
45849
|
/**
|
|
45548
45850
|
* Utilities service.
|
|
45549
45851
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
45550
|
-
* @version
|
|
45852
|
+
* @version 126.1.0
|
|
45551
45853
|
*/
|
|
45552
45854
|
|
|
45553
45855
|
/**
|
|
@@ -45658,7 +45960,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45658
45960
|
/**
|
|
45659
45961
|
* Voicemail service.
|
|
45660
45962
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
45661
|
-
* @version
|
|
45963
|
+
* @version 126.1.0
|
|
45662
45964
|
*/
|
|
45663
45965
|
|
|
45664
45966
|
/**
|
|
@@ -46289,13 +46591,43 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46289
46591
|
);
|
|
46290
46592
|
}
|
|
46291
46593
|
|
|
46594
|
+
/**
|
|
46595
|
+
* Update a user's voicemail policy
|
|
46596
|
+
*
|
|
46597
|
+
* @param {String} userId User ID
|
|
46598
|
+
* @param {Object} body The user's voicemail policy
|
|
46599
|
+
*/
|
|
46600
|
+
putVoicemailUserpolicy(userId, body) {
|
|
46601
|
+
// verify the required parameter 'userId' is set
|
|
46602
|
+
if (userId === undefined || userId === null) {
|
|
46603
|
+
throw 'Missing the required parameter "userId" when calling putVoicemailUserpolicy';
|
|
46604
|
+
}
|
|
46605
|
+
// verify the required parameter 'body' is set
|
|
46606
|
+
if (body === undefined || body === null) {
|
|
46607
|
+
throw 'Missing the required parameter "body" when calling putVoicemailUserpolicy';
|
|
46608
|
+
}
|
|
46609
|
+
|
|
46610
|
+
return this.apiClient.callApi(
|
|
46611
|
+
'/api/v2/voicemail/userpolicies/{userId}',
|
|
46612
|
+
'PUT',
|
|
46613
|
+
{ 'userId': userId },
|
|
46614
|
+
{ },
|
|
46615
|
+
{ },
|
|
46616
|
+
{ },
|
|
46617
|
+
body,
|
|
46618
|
+
['PureCloud OAuth'],
|
|
46619
|
+
['application/json'],
|
|
46620
|
+
['application/json']
|
|
46621
|
+
);
|
|
46622
|
+
}
|
|
46623
|
+
|
|
46292
46624
|
}
|
|
46293
46625
|
|
|
46294
46626
|
class WebChatApi {
|
|
46295
46627
|
/**
|
|
46296
46628
|
* WebChat service.
|
|
46297
46629
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
46298
|
-
* @version
|
|
46630
|
+
* @version 126.1.0
|
|
46299
46631
|
*/
|
|
46300
46632
|
|
|
46301
46633
|
/**
|
|
@@ -46839,7 +47171,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46839
47171
|
/**
|
|
46840
47172
|
* WebDeployments service.
|
|
46841
47173
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
46842
|
-
* @version
|
|
47174
|
+
* @version 126.1.0
|
|
46843
47175
|
*/
|
|
46844
47176
|
|
|
46845
47177
|
/**
|
|
@@ -47194,7 +47526,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47194
47526
|
/**
|
|
47195
47527
|
* WebMessaging service.
|
|
47196
47528
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
47197
|
-
* @version
|
|
47529
|
+
* @version 126.1.0
|
|
47198
47530
|
*/
|
|
47199
47531
|
|
|
47200
47532
|
/**
|
|
@@ -47240,7 +47572,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47240
47572
|
/**
|
|
47241
47573
|
* Widgets service.
|
|
47242
47574
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
47243
|
-
* @version
|
|
47575
|
+
* @version 126.1.0
|
|
47244
47576
|
*/
|
|
47245
47577
|
|
|
47246
47578
|
/**
|
|
@@ -47386,7 +47718,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47386
47718
|
/**
|
|
47387
47719
|
* WorkforceManagement service.
|
|
47388
47720
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
47389
|
-
* @version
|
|
47721
|
+
* @version 126.1.0
|
|
47390
47722
|
*/
|
|
47391
47723
|
|
|
47392
47724
|
/**
|
|
@@ -47661,6 +47993,66 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47661
47993
|
);
|
|
47662
47994
|
}
|
|
47663
47995
|
|
|
47996
|
+
/**
|
|
47997
|
+
* Deletes a time off limit object
|
|
47998
|
+
*
|
|
47999
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
48000
|
+
* @param {String} timeOffLimitId The ID of the time off limit object to delete
|
|
48001
|
+
*/
|
|
48002
|
+
deleteWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
48003
|
+
// verify the required parameter 'managementUnitId' is set
|
|
48004
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
48005
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitTimeofflimit';
|
|
48006
|
+
}
|
|
48007
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
48008
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
48009
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling deleteWorkforcemanagementManagementunitTimeofflimit';
|
|
48010
|
+
}
|
|
48011
|
+
|
|
48012
|
+
return this.apiClient.callApi(
|
|
48013
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
48014
|
+
'DELETE',
|
|
48015
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
48016
|
+
{ },
|
|
48017
|
+
{ },
|
|
48018
|
+
{ },
|
|
48019
|
+
null,
|
|
48020
|
+
['PureCloud OAuth'],
|
|
48021
|
+
['application/json'],
|
|
48022
|
+
['application/json']
|
|
48023
|
+
);
|
|
48024
|
+
}
|
|
48025
|
+
|
|
48026
|
+
/**
|
|
48027
|
+
* Deletes a time off plan
|
|
48028
|
+
*
|
|
48029
|
+
* @param {String} managementUnitId The management unit ID.
|
|
48030
|
+
* @param {String} timeOffPlanId The ID of the time off plan to delete
|
|
48031
|
+
*/
|
|
48032
|
+
deleteWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
48033
|
+
// verify the required parameter 'managementUnitId' is set
|
|
48034
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
48035
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitTimeoffplan';
|
|
48036
|
+
}
|
|
48037
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
48038
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
48039
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling deleteWorkforcemanagementManagementunitTimeoffplan';
|
|
48040
|
+
}
|
|
48041
|
+
|
|
48042
|
+
return this.apiClient.callApi(
|
|
48043
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
48044
|
+
'DELETE',
|
|
48045
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
48046
|
+
{ },
|
|
48047
|
+
{ },
|
|
48048
|
+
{ },
|
|
48049
|
+
null,
|
|
48050
|
+
['PureCloud OAuth'],
|
|
48051
|
+
['application/json'],
|
|
48052
|
+
['application/json']
|
|
48053
|
+
);
|
|
48054
|
+
}
|
|
48055
|
+
|
|
47664
48056
|
/**
|
|
47665
48057
|
* Delete a work plan
|
|
47666
48058
|
*
|
|
@@ -48902,6 +49294,116 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48902
49294
|
);
|
|
48903
49295
|
}
|
|
48904
49296
|
|
|
49297
|
+
/**
|
|
49298
|
+
* Gets a time off limit object
|
|
49299
|
+
* Returns properties of time off limit object, but not daily values.
|
|
49300
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
49301
|
+
* @param {String} timeOffLimitId The ID of the time off limit to fetch
|
|
49302
|
+
*/
|
|
49303
|
+
getWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
49304
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49305
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49306
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeofflimit';
|
|
49307
|
+
}
|
|
49308
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
49309
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
49310
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling getWorkforcemanagementManagementunitTimeofflimit';
|
|
49311
|
+
}
|
|
49312
|
+
|
|
49313
|
+
return this.apiClient.callApi(
|
|
49314
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
49315
|
+
'GET',
|
|
49316
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
49317
|
+
{ },
|
|
49318
|
+
{ },
|
|
49319
|
+
{ },
|
|
49320
|
+
null,
|
|
49321
|
+
['PureCloud OAuth'],
|
|
49322
|
+
['application/json'],
|
|
49323
|
+
['application/json']
|
|
49324
|
+
);
|
|
49325
|
+
}
|
|
49326
|
+
|
|
49327
|
+
/**
|
|
49328
|
+
* Gets a list of time off limit objects under management unit.
|
|
49329
|
+
* Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.
|
|
49330
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
49331
|
+
*/
|
|
49332
|
+
getWorkforcemanagementManagementunitTimeofflimits(managementUnitId) {
|
|
49333
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49334
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49335
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeofflimits';
|
|
49336
|
+
}
|
|
49337
|
+
|
|
49338
|
+
return this.apiClient.callApi(
|
|
49339
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits',
|
|
49340
|
+
'GET',
|
|
49341
|
+
{ 'managementUnitId': managementUnitId },
|
|
49342
|
+
{ },
|
|
49343
|
+
{ },
|
|
49344
|
+
{ },
|
|
49345
|
+
null,
|
|
49346
|
+
['PureCloud OAuth'],
|
|
49347
|
+
['application/json'],
|
|
49348
|
+
['application/json']
|
|
49349
|
+
);
|
|
49350
|
+
}
|
|
49351
|
+
|
|
49352
|
+
/**
|
|
49353
|
+
* Gets a time off plan
|
|
49354
|
+
*
|
|
49355
|
+
* @param {String} managementUnitId The management unit ID.
|
|
49356
|
+
* @param {String} timeOffPlanId The ID of the time off plan to fetch
|
|
49357
|
+
*/
|
|
49358
|
+
getWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
49359
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49360
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49361
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeoffplan';
|
|
49362
|
+
}
|
|
49363
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
49364
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
49365
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling getWorkforcemanagementManagementunitTimeoffplan';
|
|
49366
|
+
}
|
|
49367
|
+
|
|
49368
|
+
return this.apiClient.callApi(
|
|
49369
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
49370
|
+
'GET',
|
|
49371
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
49372
|
+
{ },
|
|
49373
|
+
{ },
|
|
49374
|
+
{ },
|
|
49375
|
+
null,
|
|
49376
|
+
['PureCloud OAuth'],
|
|
49377
|
+
['application/json'],
|
|
49378
|
+
['application/json']
|
|
49379
|
+
);
|
|
49380
|
+
}
|
|
49381
|
+
|
|
49382
|
+
/**
|
|
49383
|
+
* Gets a list of time off plans
|
|
49384
|
+
*
|
|
49385
|
+
* @param {String} managementUnitId The management unit ID.
|
|
49386
|
+
*/
|
|
49387
|
+
getWorkforcemanagementManagementunitTimeoffplans(managementUnitId) {
|
|
49388
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49389
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49390
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeoffplans';
|
|
49391
|
+
}
|
|
49392
|
+
|
|
49393
|
+
return this.apiClient.callApi(
|
|
49394
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans',
|
|
49395
|
+
'GET',
|
|
49396
|
+
{ 'managementUnitId': managementUnitId },
|
|
49397
|
+
{ },
|
|
49398
|
+
{ },
|
|
49399
|
+
{ },
|
|
49400
|
+
null,
|
|
49401
|
+
['PureCloud OAuth'],
|
|
49402
|
+
['application/json'],
|
|
49403
|
+
['application/json']
|
|
49404
|
+
);
|
|
49405
|
+
}
|
|
49406
|
+
|
|
48905
49407
|
/**
|
|
48906
49408
|
* Get a time off request
|
|
48907
49409
|
*
|
|
@@ -48937,6 +49439,41 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48937
49439
|
);
|
|
48938
49440
|
}
|
|
48939
49441
|
|
|
49442
|
+
/**
|
|
49443
|
+
* Retrieves time off limit, allocated and waitlisted values according to specific time off request
|
|
49444
|
+
*
|
|
49445
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
49446
|
+
* @param {String} userId The userId to whom the time off request applies.
|
|
49447
|
+
* @param {String} timeOffRequestId The ID of the time off request, which dates and activityCodeId determine limit values to retrieve
|
|
49448
|
+
*/
|
|
49449
|
+
getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits(managementUnitId, userId, timeOffRequestId) {
|
|
49450
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49451
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49452
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
49453
|
+
}
|
|
49454
|
+
// verify the required parameter 'userId' is set
|
|
49455
|
+
if (userId === undefined || userId === null) {
|
|
49456
|
+
throw 'Missing the required parameter "userId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
49457
|
+
}
|
|
49458
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
49459
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
49460
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
49461
|
+
}
|
|
49462
|
+
|
|
49463
|
+
return this.apiClient.callApi(
|
|
49464
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeofflimits',
|
|
49465
|
+
'GET',
|
|
49466
|
+
{ 'managementUnitId': managementUnitId,'userId': userId,'timeOffRequestId': timeOffRequestId },
|
|
49467
|
+
{ },
|
|
49468
|
+
{ },
|
|
49469
|
+
{ },
|
|
49470
|
+
null,
|
|
49471
|
+
['PureCloud OAuth'],
|
|
49472
|
+
['application/json'],
|
|
49473
|
+
['application/json']
|
|
49474
|
+
);
|
|
49475
|
+
}
|
|
49476
|
+
|
|
48940
49477
|
/**
|
|
48941
49478
|
* Get a list of time off requests for a given user
|
|
48942
49479
|
*
|
|
@@ -49370,6 +49907,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49370
49907
|
);
|
|
49371
49908
|
}
|
|
49372
49909
|
|
|
49910
|
+
/**
|
|
49911
|
+
* Get the daily waitlist positions of a time off request for the current user
|
|
49912
|
+
*
|
|
49913
|
+
* @param {String} timeOffRequestId Time Off Request Id
|
|
49914
|
+
*/
|
|
49915
|
+
getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId) {
|
|
49916
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
49917
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
49918
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementTimeoffrequestWaitlistpositions';
|
|
49919
|
+
}
|
|
49920
|
+
|
|
49921
|
+
return this.apiClient.callApi(
|
|
49922
|
+
'/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}/waitlistpositions',
|
|
49923
|
+
'GET',
|
|
49924
|
+
{ 'timeOffRequestId': timeOffRequestId },
|
|
49925
|
+
{ },
|
|
49926
|
+
{ },
|
|
49927
|
+
{ },
|
|
49928
|
+
null,
|
|
49929
|
+
['PureCloud OAuth'],
|
|
49930
|
+
['application/json'],
|
|
49931
|
+
['application/json']
|
|
49932
|
+
);
|
|
49933
|
+
}
|
|
49934
|
+
|
|
49373
49935
|
/**
|
|
49374
49936
|
* Get a list of time off requests for the current user
|
|
49375
49937
|
*
|
|
@@ -49588,6 +50150,74 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49588
50150
|
);
|
|
49589
50151
|
}
|
|
49590
50152
|
|
|
50153
|
+
/**
|
|
50154
|
+
* Updates a time off limit object.
|
|
50155
|
+
* Updates time off limit object properties, but not daily values.
|
|
50156
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
50157
|
+
* @param {String} timeOffLimitId The id of time off limit object to update
|
|
50158
|
+
* @param {Object} opts Optional parameters
|
|
50159
|
+
* @param {Object} opts.body body
|
|
50160
|
+
*/
|
|
50161
|
+
patchWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId, opts) {
|
|
50162
|
+
opts = opts || {};
|
|
50163
|
+
|
|
50164
|
+
// verify the required parameter 'managementUnitId' is set
|
|
50165
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
50166
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
50167
|
+
}
|
|
50168
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
50169
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
50170
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
50171
|
+
}
|
|
50172
|
+
|
|
50173
|
+
return this.apiClient.callApi(
|
|
50174
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
50175
|
+
'PATCH',
|
|
50176
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
50177
|
+
{ },
|
|
50178
|
+
{ },
|
|
50179
|
+
{ },
|
|
50180
|
+
opts['body'],
|
|
50181
|
+
['PureCloud OAuth'],
|
|
50182
|
+
['application/json'],
|
|
50183
|
+
['application/json']
|
|
50184
|
+
);
|
|
50185
|
+
}
|
|
50186
|
+
|
|
50187
|
+
/**
|
|
50188
|
+
* Updates a time off plan
|
|
50189
|
+
*
|
|
50190
|
+
* @param {String} managementUnitId The management unit ID.
|
|
50191
|
+
* @param {String} timeOffPlanId The ID of the time off plan to update
|
|
50192
|
+
* @param {Object} opts Optional parameters
|
|
50193
|
+
* @param {Object} opts.body body
|
|
50194
|
+
*/
|
|
50195
|
+
patchWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId, opts) {
|
|
50196
|
+
opts = opts || {};
|
|
50197
|
+
|
|
50198
|
+
// verify the required parameter 'managementUnitId' is set
|
|
50199
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
50200
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
50201
|
+
}
|
|
50202
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
50203
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
50204
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
50205
|
+
}
|
|
50206
|
+
|
|
50207
|
+
return this.apiClient.callApi(
|
|
50208
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
50209
|
+
'PATCH',
|
|
50210
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
50211
|
+
{ },
|
|
50212
|
+
{ },
|
|
50213
|
+
{ },
|
|
50214
|
+
opts['body'],
|
|
50215
|
+
['PureCloud OAuth'],
|
|
50216
|
+
['application/json'],
|
|
50217
|
+
['application/json']
|
|
50218
|
+
);
|
|
50219
|
+
}
|
|
50220
|
+
|
|
49591
50221
|
/**
|
|
49592
50222
|
* Update a time off request
|
|
49593
50223
|
*
|
|
@@ -50449,6 +51079,93 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50449
51079
|
);
|
|
50450
51080
|
}
|
|
50451
51081
|
|
|
51082
|
+
/**
|
|
51083
|
+
* Creates a new time off limit object under management unit.
|
|
51084
|
+
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
51085
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51086
|
+
* @param {Object} opts Optional parameters
|
|
51087
|
+
* @param {Object} opts.body body
|
|
51088
|
+
*/
|
|
51089
|
+
postWorkforcemanagementManagementunitTimeofflimits(managementUnitId, opts) {
|
|
51090
|
+
opts = opts || {};
|
|
51091
|
+
|
|
51092
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51093
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51094
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimits';
|
|
51095
|
+
}
|
|
51096
|
+
|
|
51097
|
+
return this.apiClient.callApi(
|
|
51098
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits',
|
|
51099
|
+
'POST',
|
|
51100
|
+
{ 'managementUnitId': managementUnitId },
|
|
51101
|
+
{ },
|
|
51102
|
+
{ },
|
|
51103
|
+
{ },
|
|
51104
|
+
opts['body'],
|
|
51105
|
+
['PureCloud OAuth'],
|
|
51106
|
+
['application/json'],
|
|
51107
|
+
['application/json']
|
|
51108
|
+
);
|
|
51109
|
+
}
|
|
51110
|
+
|
|
51111
|
+
/**
|
|
51112
|
+
* Retrieves time off limit related values based on a given set of filters.
|
|
51113
|
+
*
|
|
51114
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51115
|
+
* @param {Object} opts Optional parameters
|
|
51116
|
+
* @param {Object} opts.body body
|
|
51117
|
+
*/
|
|
51118
|
+
postWorkforcemanagementManagementunitTimeofflimitsValuesQuery(managementUnitId, opts) {
|
|
51119
|
+
opts = opts || {};
|
|
51120
|
+
|
|
51121
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51122
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51123
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimitsValuesQuery';
|
|
51124
|
+
}
|
|
51125
|
+
|
|
51126
|
+
return this.apiClient.callApi(
|
|
51127
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/values/query',
|
|
51128
|
+
'POST',
|
|
51129
|
+
{ 'managementUnitId': managementUnitId },
|
|
51130
|
+
{ },
|
|
51131
|
+
{ },
|
|
51132
|
+
{ },
|
|
51133
|
+
opts['body'],
|
|
51134
|
+
['PureCloud OAuth'],
|
|
51135
|
+
['application/json'],
|
|
51136
|
+
['application/json']
|
|
51137
|
+
);
|
|
51138
|
+
}
|
|
51139
|
+
|
|
51140
|
+
/**
|
|
51141
|
+
* Creates a new time off plan
|
|
51142
|
+
*
|
|
51143
|
+
* @param {String} managementUnitId The management unit ID.
|
|
51144
|
+
* @param {Object} opts Optional parameters
|
|
51145
|
+
* @param {Object} opts.body body
|
|
51146
|
+
*/
|
|
51147
|
+
postWorkforcemanagementManagementunitTimeoffplans(managementUnitId, opts) {
|
|
51148
|
+
opts = opts || {};
|
|
51149
|
+
|
|
51150
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51151
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51152
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffplans';
|
|
51153
|
+
}
|
|
51154
|
+
|
|
51155
|
+
return this.apiClient.callApi(
|
|
51156
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans',
|
|
51157
|
+
'POST',
|
|
51158
|
+
{ 'managementUnitId': managementUnitId },
|
|
51159
|
+
{ },
|
|
51160
|
+
{ },
|
|
51161
|
+
{ },
|
|
51162
|
+
opts['body'],
|
|
51163
|
+
['PureCloud OAuth'],
|
|
51164
|
+
['application/json'],
|
|
51165
|
+
['application/json']
|
|
51166
|
+
);
|
|
51167
|
+
}
|
|
51168
|
+
|
|
50452
51169
|
/**
|
|
50453
51170
|
* Create a new time off request
|
|
50454
51171
|
*
|
|
@@ -50507,6 +51224,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50507
51224
|
);
|
|
50508
51225
|
}
|
|
50509
51226
|
|
|
51227
|
+
/**
|
|
51228
|
+
* Retrieves daily waitlist position for a list of time off requests
|
|
51229
|
+
*
|
|
51230
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51231
|
+
* @param {Object} opts Optional parameters
|
|
51232
|
+
* @param {Object} opts.body body
|
|
51233
|
+
*/
|
|
51234
|
+
postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery(managementUnitId, opts) {
|
|
51235
|
+
opts = opts || {};
|
|
51236
|
+
|
|
51237
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51238
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51239
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery';
|
|
51240
|
+
}
|
|
51241
|
+
|
|
51242
|
+
return this.apiClient.callApi(
|
|
51243
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/waitlistpositions/query',
|
|
51244
|
+
'POST',
|
|
51245
|
+
{ 'managementUnitId': managementUnitId },
|
|
51246
|
+
{ },
|
|
51247
|
+
{ },
|
|
51248
|
+
{ },
|
|
51249
|
+
opts['body'],
|
|
51250
|
+
['PureCloud OAuth'],
|
|
51251
|
+
['application/json'],
|
|
51252
|
+
['application/json']
|
|
51253
|
+
);
|
|
51254
|
+
}
|
|
51255
|
+
|
|
50510
51256
|
/**
|
|
50511
51257
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
50512
51258
|
*
|
|
@@ -50890,6 +51636,30 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50890
51636
|
);
|
|
50891
51637
|
}
|
|
50892
51638
|
|
|
51639
|
+
/**
|
|
51640
|
+
* Queries available time off for the current user
|
|
51641
|
+
*
|
|
51642
|
+
* @param {Object} opts Optional parameters
|
|
51643
|
+
* @param {Object} opts.body body
|
|
51644
|
+
*/
|
|
51645
|
+
postWorkforcemanagementTimeofflimitsAvailableQuery(opts) {
|
|
51646
|
+
opts = opts || {};
|
|
51647
|
+
|
|
51648
|
+
|
|
51649
|
+
return this.apiClient.callApi(
|
|
51650
|
+
'/api/v2/workforcemanagement/timeofflimits/available/query',
|
|
51651
|
+
'POST',
|
|
51652
|
+
{ },
|
|
51653
|
+
{ },
|
|
51654
|
+
{ },
|
|
51655
|
+
{ },
|
|
51656
|
+
opts['body'],
|
|
51657
|
+
['PureCloud OAuth'],
|
|
51658
|
+
['application/json'],
|
|
51659
|
+
['application/json']
|
|
51660
|
+
);
|
|
51661
|
+
}
|
|
51662
|
+
|
|
50893
51663
|
/**
|
|
50894
51664
|
* Create a time off request for the current user
|
|
50895
51665
|
*
|
|
@@ -50914,6 +51684,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50914
51684
|
);
|
|
50915
51685
|
}
|
|
50916
51686
|
|
|
51687
|
+
/**
|
|
51688
|
+
* Sets daily values for a date range of time off limit object
|
|
51689
|
+
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
51690
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51691
|
+
* @param {String} timeOffLimitId The ID of the time off limit object to set values for
|
|
51692
|
+
* @param {Object} opts Optional parameters
|
|
51693
|
+
* @param {Object} opts.body body
|
|
51694
|
+
*/
|
|
51695
|
+
putWorkforcemanagementManagementunitTimeofflimitValues(managementUnitId, timeOffLimitId, opts) {
|
|
51696
|
+
opts = opts || {};
|
|
51697
|
+
|
|
51698
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51699
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51700
|
+
throw 'Missing the required parameter "managementUnitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
51701
|
+
}
|
|
51702
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
51703
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
51704
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
51705
|
+
}
|
|
51706
|
+
|
|
51707
|
+
return this.apiClient.callApi(
|
|
51708
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}/values',
|
|
51709
|
+
'PUT',
|
|
51710
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
51711
|
+
{ },
|
|
51712
|
+
{ },
|
|
51713
|
+
{ },
|
|
51714
|
+
opts['body'],
|
|
51715
|
+
['PureCloud OAuth'],
|
|
51716
|
+
['application/json'],
|
|
51717
|
+
['application/json']
|
|
51718
|
+
);
|
|
51719
|
+
}
|
|
51720
|
+
|
|
50917
51721
|
}
|
|
50918
51722
|
|
|
50919
51723
|
/**
|
|
@@ -50945,7 +51749,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50945
51749
|
* </pre>
|
|
50946
51750
|
* </p>
|
|
50947
51751
|
* @module purecloud-platform-client-v2/index
|
|
50948
|
-
* @version
|
|
51752
|
+
* @version 126.1.0
|
|
50949
51753
|
*/
|
|
50950
51754
|
class platformClient {
|
|
50951
51755
|
constructor() {
|