purecloud-platform-client-v2 122.0.0 → 126.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -2
- package/dist/node/purecloud-platform-client-v2.js +1005 -142
- package/dist/web-amd/purecloud-platform-client-v2.js +1005 -142
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +965 -146
- package/dist/web-cjs/purecloud-platform-client-v2.js +978 -1309
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1546 -243
- 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 +8 -4
- 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 +2 -2
- 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 +7 -3
- 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 +51 -0
- 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 +7 -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.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': '126.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 126.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 126.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 126.0.0
|
|
2911
2893
|
*/
|
|
2912
2894
|
|
|
2913
2895
|
/**
|
|
@@ -5775,17 +5757,21 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5775
5757
|
* Updates a specific datatable by id
|
|
5776
5758
|
* Updates a schema for a datatable with the given datatableId -updates allow only new fields to be added in the schema, no changes or removals of existing fields.
|
|
5777
5759
|
* @param {String} datatableId id of datatable
|
|
5760
|
+
* @param {Object} body datatable json-schema
|
|
5778
5761
|
* @param {Object} opts Optional parameters
|
|
5779
5762
|
* @param {Object} opts.expand Expand instructions for the result
|
|
5780
|
-
* @param {Object} opts.body datatable json-schema
|
|
5781
5763
|
*/
|
|
5782
|
-
putFlowsDatatable(datatableId, opts) {
|
|
5764
|
+
putFlowsDatatable(datatableId, body, opts) {
|
|
5783
5765
|
opts = opts || {};
|
|
5784
5766
|
|
|
5785
5767
|
// verify the required parameter 'datatableId' is set
|
|
5786
5768
|
if (datatableId === undefined || datatableId === null) {
|
|
5787
5769
|
throw 'Missing the required parameter "datatableId" when calling putFlowsDatatable';
|
|
5788
5770
|
}
|
|
5771
|
+
// verify the required parameter 'body' is set
|
|
5772
|
+
if (body === undefined || body === null) {
|
|
5773
|
+
throw 'Missing the required parameter "body" when calling putFlowsDatatable';
|
|
5774
|
+
}
|
|
5789
5775
|
|
|
5790
5776
|
return this.apiClient.callApi(
|
|
5791
5777
|
'/api/v2/flows/datatables/{datatableId}',
|
|
@@ -5794,7 +5780,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5794
5780
|
{ 'expand': opts['expand'] },
|
|
5795
5781
|
{ },
|
|
5796
5782
|
{ },
|
|
5797
|
-
|
|
5783
|
+
body,
|
|
5798
5784
|
['PureCloud OAuth'],
|
|
5799
5785
|
['application/json'],
|
|
5800
5786
|
['application/json']
|
|
@@ -5899,7 +5885,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5899
5885
|
/**
|
|
5900
5886
|
* Audit service.
|
|
5901
5887
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
5902
|
-
* @version
|
|
5888
|
+
* @version 126.0.0
|
|
5903
5889
|
*/
|
|
5904
5890
|
|
|
5905
5891
|
/**
|
|
@@ -6070,7 +6056,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6070
6056
|
/**
|
|
6071
6057
|
* Authorization service.
|
|
6072
6058
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6073
|
-
* @version
|
|
6059
|
+
* @version 126.0.0
|
|
6074
6060
|
*/
|
|
6075
6061
|
|
|
6076
6062
|
/**
|
|
@@ -7253,7 +7239,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7253
7239
|
/**
|
|
7254
7240
|
* Billing service.
|
|
7255
7241
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7256
|
-
* @version
|
|
7242
|
+
* @version 126.0.0
|
|
7257
7243
|
*/
|
|
7258
7244
|
|
|
7259
7245
|
/**
|
|
@@ -7333,7 +7319,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7333
7319
|
/**
|
|
7334
7320
|
* Chat service.
|
|
7335
7321
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7336
|
-
* @version
|
|
7322
|
+
* @version 126.0.0
|
|
7337
7323
|
*/
|
|
7338
7324
|
|
|
7339
7325
|
/**
|
|
@@ -7424,7 +7410,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7424
7410
|
/**
|
|
7425
7411
|
* Coaching service.
|
|
7426
7412
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7427
|
-
* @version
|
|
7413
|
+
* @version 126.0.0
|
|
7428
7414
|
*/
|
|
7429
7415
|
|
|
7430
7416
|
/**
|
|
@@ -7999,7 +7985,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7999
7985
|
/**
|
|
8000
7986
|
* ContentManagement service.
|
|
8001
7987
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8002
|
-
* @version
|
|
7988
|
+
* @version 126.0.0
|
|
8003
7989
|
*/
|
|
8004
7990
|
|
|
8005
7991
|
/**
|
|
@@ -9139,7 +9125,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9139
9125
|
/**
|
|
9140
9126
|
* Conversations service.
|
|
9141
9127
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9142
|
-
* @version
|
|
9128
|
+
* @version 126.0.0
|
|
9143
9129
|
*/
|
|
9144
9130
|
|
|
9145
9131
|
/**
|
|
@@ -12208,7 +12194,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12208
12194
|
}
|
|
12209
12195
|
|
|
12210
12196
|
/**
|
|
12211
|
-
* Attempts to manually assign a specified conversation to a specified
|
|
12197
|
+
* Attempts to manually assign a specified conversation to a specified user. Ignores bullseye ring, PAR score, skills, and languages.
|
|
12212
12198
|
*
|
|
12213
12199
|
* @param {String} conversationId conversation ID
|
|
12214
12200
|
* @param {Object} body Targeted user
|
|
@@ -13528,7 +13514,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13528
13514
|
/**
|
|
13529
13515
|
* DataExtensions service.
|
|
13530
13516
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
13531
|
-
* @version
|
|
13517
|
+
* @version 126.0.0
|
|
13532
13518
|
*/
|
|
13533
13519
|
|
|
13534
13520
|
/**
|
|
@@ -13614,7 +13600,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13614
13600
|
/**
|
|
13615
13601
|
* ExternalContacts service.
|
|
13616
13602
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
13617
|
-
* @version
|
|
13603
|
+
* @version 126.0.0
|
|
13618
13604
|
*/
|
|
13619
13605
|
|
|
13620
13606
|
/**
|
|
@@ -15357,7 +15343,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15357
15343
|
/**
|
|
15358
15344
|
* Fax service.
|
|
15359
15345
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
15360
|
-
* @version
|
|
15346
|
+
* @version 126.0.0
|
|
15361
15347
|
*/
|
|
15362
15348
|
|
|
15363
15349
|
/**
|
|
@@ -15528,7 +15514,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15528
15514
|
/**
|
|
15529
15515
|
* Flows service.
|
|
15530
15516
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
15531
|
-
* @version
|
|
15517
|
+
* @version 126.0.0
|
|
15532
15518
|
*/
|
|
15533
15519
|
|
|
15534
15520
|
/**
|
|
@@ -15599,7 +15585,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15599
15585
|
/**
|
|
15600
15586
|
* Gamification service.
|
|
15601
15587
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
15602
|
-
* @version
|
|
15588
|
+
* @version 126.0.0
|
|
15603
15589
|
*/
|
|
15604
15590
|
|
|
15605
15591
|
/**
|
|
@@ -16905,7 +16891,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16905
16891
|
/**
|
|
16906
16892
|
* GeneralDataProtectionRegulation service.
|
|
16907
16893
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
16908
|
-
* @version
|
|
16894
|
+
* @version 126.0.0
|
|
16909
16895
|
*/
|
|
16910
16896
|
|
|
16911
16897
|
/**
|
|
@@ -17035,7 +17021,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17035
17021
|
/**
|
|
17036
17022
|
* Geolocation service.
|
|
17037
17023
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
17038
|
-
* @version
|
|
17024
|
+
* @version 126.0.0
|
|
17039
17025
|
*/
|
|
17040
17026
|
|
|
17041
17027
|
/**
|
|
@@ -17166,7 +17152,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17166
17152
|
/**
|
|
17167
17153
|
* Greetings service.
|
|
17168
17154
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
17169
|
-
* @version
|
|
17155
|
+
* @version 126.0.0
|
|
17170
17156
|
*/
|
|
17171
17157
|
|
|
17172
17158
|
/**
|
|
@@ -17621,7 +17607,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17621
17607
|
/**
|
|
17622
17608
|
* Groups service.
|
|
17623
17609
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
17624
|
-
* @version
|
|
17610
|
+
* @version 126.0.0
|
|
17625
17611
|
*/
|
|
17626
17612
|
|
|
17627
17613
|
/**
|
|
@@ -18026,7 +18012,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18026
18012
|
/**
|
|
18027
18013
|
* IdentityProvider service.
|
|
18028
18014
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
18029
|
-
* @version
|
|
18015
|
+
* @version 126.0.0
|
|
18030
18016
|
*/
|
|
18031
18017
|
|
|
18032
18018
|
/**
|
|
@@ -18782,7 +18768,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18782
18768
|
/**
|
|
18783
18769
|
* Integrations service.
|
|
18784
18770
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
18785
|
-
* @version
|
|
18771
|
+
* @version 126.0.0
|
|
18786
18772
|
*/
|
|
18787
18773
|
|
|
18788
18774
|
/**
|
|
@@ -20428,7 +20414,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20428
20414
|
/**
|
|
20429
20415
|
* Journey service.
|
|
20430
20416
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
20431
|
-
* @version
|
|
20417
|
+
* @version 126.0.0
|
|
20432
20418
|
*/
|
|
20433
20419
|
|
|
20434
20420
|
/**
|
|
@@ -21139,7 +21125,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21139
21125
|
/**
|
|
21140
21126
|
* Knowledge service.
|
|
21141
21127
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
21142
|
-
* @version
|
|
21128
|
+
* @version 126.0.0
|
|
21143
21129
|
*/
|
|
21144
21130
|
|
|
21145
21131
|
/**
|
|
@@ -21429,6 +21415,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21429
21415
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
21430
21416
|
* @param {String} opts.categories Filter by categories ids, comma separated values expected.
|
|
21431
21417
|
* @param {String} opts.title Filter by document title.
|
|
21418
|
+
* @param {Object} opts.sortBy Sort by.
|
|
21419
|
+
* @param {Object} opts.sortOrder Sort Order.
|
|
21432
21420
|
* @param {Array.<String>} opts.documentIds Comma-separated list of document identifiers to fetch by.
|
|
21433
21421
|
*/
|
|
21434
21422
|
getKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, opts) {
|
|
@@ -21447,7 +21435,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21447
21435
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents',
|
|
21448
21436
|
'GET',
|
|
21449
21437
|
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
21450
|
-
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'categories': opts['categories'],'title': opts['title'],'documentIds': this.apiClient.buildCollectionParam(opts['documentIds'], 'multi') },
|
|
21438
|
+
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'categories': opts['categories'],'title': opts['title'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'documentIds': this.apiClient.buildCollectionParam(opts['documentIds'], 'multi') },
|
|
21451
21439
|
{ },
|
|
21452
21440
|
{ },
|
|
21453
21441
|
null,
|
|
@@ -21576,6 +21564,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21576
21564
|
* @param {String} opts.name Filter by Name.
|
|
21577
21565
|
* @param {Object} opts.coreLanguage Filter by core language.
|
|
21578
21566
|
* @param {Boolean} opts.published Filter by published status.
|
|
21567
|
+
* @param {Object} opts.sortBy Sort by.
|
|
21568
|
+
* @param {Object} opts.sortOrder Sort Order.
|
|
21579
21569
|
*/
|
|
21580
21570
|
getKnowledgeKnowledgebases(opts) {
|
|
21581
21571
|
opts = opts || {};
|
|
@@ -21585,7 +21575,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21585
21575
|
'/api/v2/knowledge/knowledgebases',
|
|
21586
21576
|
'GET',
|
|
21587
21577
|
{ },
|
|
21588
|
-
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'name': opts['name'],'coreLanguage': opts['coreLanguage'],'published': opts['published'] },
|
|
21578
|
+
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'name': opts['name'],'coreLanguage': opts['coreLanguage'],'published': opts['published'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
|
|
21589
21579
|
{ },
|
|
21590
21580
|
{ },
|
|
21591
21581
|
null,
|
|
@@ -22035,7 +22025,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22035
22025
|
/**
|
|
22036
22026
|
* LanguageUnderstanding service.
|
|
22037
22027
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
22038
|
-
* @version
|
|
22028
|
+
* @version 126.0.0
|
|
22039
22029
|
*/
|
|
22040
22030
|
|
|
22041
22031
|
/**
|
|
@@ -22601,7 +22591,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22601
22591
|
}
|
|
22602
22592
|
|
|
22603
22593
|
/**
|
|
22604
|
-
* Save information for the draft
|
|
22594
|
+
* Save information for the draft. Either topic draft or intent draft should be sent.
|
|
22605
22595
|
*
|
|
22606
22596
|
* @param {String} minerId Miner ID
|
|
22607
22597
|
* @param {String} draftId Draft ID
|
|
@@ -22845,7 +22835,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22845
22835
|
}
|
|
22846
22836
|
|
|
22847
22837
|
/**
|
|
22848
|
-
* 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.
|
|
22849
22839
|
*
|
|
22850
22840
|
* @param {String} minerId Miner ID
|
|
22851
22841
|
* @param {Object} opts Optional parameters
|
|
@@ -22939,7 +22929,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22939
22929
|
/**
|
|
22940
22930
|
* Languages service.
|
|
22941
22931
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
22942
|
-
* @version
|
|
22932
|
+
* @version 126.0.0
|
|
22943
22933
|
*/
|
|
22944
22934
|
|
|
22945
22935
|
/**
|
|
@@ -23207,7 +23197,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23207
23197
|
/**
|
|
23208
23198
|
* Learning service.
|
|
23209
23199
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
23210
|
-
* @version
|
|
23200
|
+
* @version 126.0.0
|
|
23211
23201
|
*/
|
|
23212
23202
|
|
|
23213
23203
|
/**
|
|
@@ -23798,7 +23788,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23798
23788
|
/**
|
|
23799
23789
|
* License service.
|
|
23800
23790
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
23801
|
-
* @version
|
|
23791
|
+
* @version 126.0.0
|
|
23802
23792
|
*/
|
|
23803
23793
|
|
|
23804
23794
|
/**
|
|
@@ -24036,7 +24026,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24036
24026
|
/**
|
|
24037
24027
|
* Locations service.
|
|
24038
24028
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
24039
|
-
* @version
|
|
24029
|
+
* @version 126.0.0
|
|
24040
24030
|
*/
|
|
24041
24031
|
|
|
24042
24032
|
/**
|
|
@@ -24272,7 +24262,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24272
24262
|
/**
|
|
24273
24263
|
* MobileDevices service.
|
|
24274
24264
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
24275
|
-
* @version
|
|
24265
|
+
* @version 126.0.0
|
|
24276
24266
|
*/
|
|
24277
24267
|
|
|
24278
24268
|
/**
|
|
@@ -24423,7 +24413,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24423
24413
|
/**
|
|
24424
24414
|
* Notifications service.
|
|
24425
24415
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
24426
|
-
* @version
|
|
24416
|
+
* @version 126.0.0
|
|
24427
24417
|
*/
|
|
24428
24418
|
|
|
24429
24419
|
/**
|
|
@@ -24648,7 +24638,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24648
24638
|
/**
|
|
24649
24639
|
* OAuth service.
|
|
24650
24640
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
24651
|
-
* @version
|
|
24641
|
+
* @version 126.0.0
|
|
24652
24642
|
*/
|
|
24653
24643
|
|
|
24654
24644
|
/**
|
|
@@ -25006,7 +24996,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25006
24996
|
/**
|
|
25007
24997
|
* Objects service.
|
|
25008
24998
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
25009
|
-
* @version
|
|
24999
|
+
* @version 126.0.0
|
|
25010
25000
|
*/
|
|
25011
25001
|
|
|
25012
25002
|
/**
|
|
@@ -25277,7 +25267,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25277
25267
|
/**
|
|
25278
25268
|
* Organization service.
|
|
25279
25269
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
25280
|
-
* @version
|
|
25270
|
+
* @version 126.0.0
|
|
25281
25271
|
*/
|
|
25282
25272
|
|
|
25283
25273
|
/**
|
|
@@ -25680,7 +25670,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25680
25670
|
/**
|
|
25681
25671
|
* OrganizationAuthorization service.
|
|
25682
25672
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
25683
|
-
* @version
|
|
25673
|
+
* @version 126.0.0
|
|
25684
25674
|
*/
|
|
25685
25675
|
|
|
25686
25676
|
/**
|
|
@@ -25720,6 +25710,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25720
25710
|
);
|
|
25721
25711
|
}
|
|
25722
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
|
+
|
|
25723
25743
|
/**
|
|
25724
25744
|
* Delete Trustee User
|
|
25725
25745
|
*
|
|
@@ -25805,6 +25825,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25805
25825
|
);
|
|
25806
25826
|
}
|
|
25807
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
|
+
|
|
25808
25858
|
/**
|
|
25809
25859
|
* Delete Trustee User
|
|
25810
25860
|
*
|
|
@@ -25885,6 +25935,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25885
25935
|
);
|
|
25886
25936
|
}
|
|
25887
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
|
+
|
|
25888
25963
|
/**
|
|
25889
25964
|
* Get Trustee User
|
|
25890
25965
|
*
|
|
@@ -26000,6 +26075,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26000
26075
|
);
|
|
26001
26076
|
}
|
|
26002
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
|
+
|
|
26003
26098
|
/**
|
|
26004
26099
|
* Get Org Trust
|
|
26005
26100
|
*
|
|
@@ -26025,6 +26120,61 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26025
26120
|
);
|
|
26026
26121
|
}
|
|
26027
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
|
+
|
|
26028
26178
|
/**
|
|
26029
26179
|
* Get Trustee User
|
|
26030
26180
|
*
|
|
@@ -26222,6 +26372,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26222
26372
|
);
|
|
26223
26373
|
}
|
|
26224
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
|
+
|
|
26225
26400
|
/**
|
|
26226
26401
|
* Get Org Trustor Audits
|
|
26227
26402
|
*
|
|
@@ -26354,6 +26529,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26354
26529
|
);
|
|
26355
26530
|
}
|
|
26356
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
|
+
|
|
26357
26562
|
/**
|
|
26358
26563
|
* Add a Trustee user to the trust.
|
|
26359
26564
|
*
|
|
@@ -26390,7 +26595,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26390
26595
|
/**
|
|
26391
26596
|
* Outbound service.
|
|
26392
26597
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
26393
|
-
* @version
|
|
26598
|
+
* @version 126.0.0
|
|
26394
26599
|
*/
|
|
26395
26600
|
|
|
26396
26601
|
/**
|
|
@@ -29416,7 +29621,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29416
29621
|
/**
|
|
29417
29622
|
* Presence service.
|
|
29418
29623
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
29419
|
-
* @version
|
|
29624
|
+
* @version 126.0.0
|
|
29420
29625
|
*/
|
|
29421
29626
|
|
|
29422
29627
|
/**
|
|
@@ -29788,7 +29993,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29788
29993
|
/**
|
|
29789
29994
|
* Quality service.
|
|
29790
29995
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
29791
|
-
* @version
|
|
29996
|
+
* @version 126.0.0
|
|
29792
29997
|
*/
|
|
29793
29998
|
|
|
29794
29999
|
/**
|
|
@@ -30161,7 +30366,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30161
30366
|
|
|
30162
30367
|
/**
|
|
30163
30368
|
* Queries Evaluations and returns a paged list
|
|
30164
|
-
* 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.
|
|
30165
30370
|
* @param {Object} opts Optional parameters
|
|
30166
30371
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
30167
30372
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -31316,7 +31521,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31316
31521
|
/**
|
|
31317
31522
|
* Recording service.
|
|
31318
31523
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
31319
|
-
* @version
|
|
31524
|
+
* @version 126.0.0
|
|
31320
31525
|
*/
|
|
31321
31526
|
|
|
31322
31527
|
/**
|
|
@@ -32835,7 +33040,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32835
33040
|
/**
|
|
32836
33041
|
* ResponseManagement service.
|
|
32837
33042
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
32838
|
-
* @version
|
|
33043
|
+
* @version 126.0.0
|
|
32839
33044
|
*/
|
|
32840
33045
|
|
|
32841
33046
|
/**
|
|
@@ -33160,7 +33365,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33160
33365
|
/**
|
|
33161
33366
|
* Routing service.
|
|
33162
33367
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
33163
|
-
* @version
|
|
33368
|
+
* @version 126.0.0
|
|
33164
33369
|
*/
|
|
33165
33370
|
|
|
33166
33371
|
/**
|
|
@@ -33473,8 +33678,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33473
33678
|
* Delete a phone number provisioned for SMS.
|
|
33474
33679
|
*
|
|
33475
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)
|
|
33476
33683
|
*/
|
|
33477
|
-
deleteRoutingSmsPhonenumber(addressId) {
|
|
33684
|
+
deleteRoutingSmsPhonenumber(addressId, opts) {
|
|
33685
|
+
opts = opts || {};
|
|
33686
|
+
|
|
33478
33687
|
// verify the required parameter 'addressId' is set
|
|
33479
33688
|
if (addressId === undefined || addressId === null) {
|
|
33480
33689
|
throw 'Missing the required parameter "addressId" when calling deleteRoutingSmsPhonenumber';
|
|
@@ -33484,7 +33693,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33484
33693
|
'/api/v2/routing/sms/phonenumbers/{addressId}',
|
|
33485
33694
|
'DELETE',
|
|
33486
33695
|
{ 'addressId': addressId },
|
|
33487
|
-
{
|
|
33696
|
+
{ 'async': opts['async'] },
|
|
33488
33697
|
{ },
|
|
33489
33698
|
{ },
|
|
33490
33699
|
null,
|
|
@@ -34312,12 +34521,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34312
34521
|
}
|
|
34313
34522
|
|
|
34314
34523
|
/**
|
|
34315
|
-
* 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.
|
|
34316
34525
|
*
|
|
34317
34526
|
* @param {Object} opts Optional parameters
|
|
34318
34527
|
* @param {Number} opts.pageSize Page size [max value is 500] (default to 25)
|
|
34319
34528
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
34320
|
-
* @param {Object} opts.sortBy Sort by (default to name)
|
|
34321
34529
|
* @param {Object} opts.sortOrder Sort order (default to asc)
|
|
34322
34530
|
*/
|
|
34323
34531
|
getRoutingQueuesDivisionviewsAll(opts) {
|
|
@@ -34328,7 +34536,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34328
34536
|
'/api/v2/routing/queues/divisionviews/all',
|
|
34329
34537
|
'GET',
|
|
34330
34538
|
{ },
|
|
34331
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'
|
|
34539
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'] },
|
|
34332
34540
|
{ },
|
|
34333
34541
|
{ },
|
|
34334
34542
|
null,
|
|
@@ -34812,7 +35020,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34812
35020
|
|
|
34813
35021
|
/**
|
|
34814
35022
|
* Update attributes of an in-queue conversation
|
|
34815
|
-
* 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.
|
|
34816
35024
|
* @param {String} conversationId Conversation ID
|
|
34817
35025
|
* @param {Object} body Conversation Attributes
|
|
34818
35026
|
*/
|
|
@@ -35631,8 +35839,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35631
35839
|
* Provision a phone number for SMS
|
|
35632
35840
|
*
|
|
35633
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)
|
|
35634
35844
|
*/
|
|
35635
|
-
postRoutingSmsPhonenumbers(body) {
|
|
35845
|
+
postRoutingSmsPhonenumbers(body, opts) {
|
|
35846
|
+
opts = opts || {};
|
|
35847
|
+
|
|
35636
35848
|
// verify the required parameter 'body' is set
|
|
35637
35849
|
if (body === undefined || body === null) {
|
|
35638
35850
|
throw 'Missing the required parameter "body" when calling postRoutingSmsPhonenumbers';
|
|
@@ -35642,7 +35854,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35642
35854
|
'/api/v2/routing/sms/phonenumbers',
|
|
35643
35855
|
'POST',
|
|
35644
35856
|
{ },
|
|
35645
|
-
{
|
|
35857
|
+
{ 'async': opts['async'] },
|
|
35646
35858
|
{ },
|
|
35647
35859
|
{ },
|
|
35648
35860
|
body,
|
|
@@ -35887,8 +36099,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35887
36099
|
*
|
|
35888
36100
|
* @param {String} addressId Address ID
|
|
35889
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)
|
|
35890
36104
|
*/
|
|
35891
|
-
putRoutingSmsPhonenumber(addressId, body) {
|
|
36105
|
+
putRoutingSmsPhonenumber(addressId, body, opts) {
|
|
36106
|
+
opts = opts || {};
|
|
36107
|
+
|
|
35892
36108
|
// verify the required parameter 'addressId' is set
|
|
35893
36109
|
if (addressId === undefined || addressId === null) {
|
|
35894
36110
|
throw 'Missing the required parameter "addressId" when calling putRoutingSmsPhonenumber';
|
|
@@ -35902,7 +36118,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35902
36118
|
'/api/v2/routing/sms/phonenumbers/{addressId}',
|
|
35903
36119
|
'PUT',
|
|
35904
36120
|
{ 'addressId': addressId },
|
|
35905
|
-
{
|
|
36121
|
+
{ 'async': opts['async'] },
|
|
35906
36122
|
{ },
|
|
35907
36123
|
{ },
|
|
35908
36124
|
body,
|
|
@@ -36068,7 +36284,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36068
36284
|
/**
|
|
36069
36285
|
* SCIM service.
|
|
36070
36286
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
36071
|
-
* @version
|
|
36287
|
+
* @version 126.0.0
|
|
36072
36288
|
*/
|
|
36073
36289
|
|
|
36074
36290
|
/**
|
|
@@ -36945,7 +37161,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36945
37161
|
/**
|
|
36946
37162
|
* Scripts service.
|
|
36947
37163
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
36948
|
-
* @version
|
|
37164
|
+
* @version 126.0.0
|
|
36949
37165
|
*/
|
|
36950
37166
|
|
|
36951
37167
|
/**
|
|
@@ -37298,7 +37514,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37298
37514
|
/**
|
|
37299
37515
|
* Search service.
|
|
37300
37516
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
37301
|
-
* @version
|
|
37517
|
+
* @version 126.0.0
|
|
37302
37518
|
*/
|
|
37303
37519
|
|
|
37304
37520
|
/**
|
|
@@ -37833,7 +38049,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37833
38049
|
/**
|
|
37834
38050
|
* SpeechTextAnalytics service.
|
|
37835
38051
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
37836
|
-
* @version
|
|
38052
|
+
* @version 126.0.0
|
|
37837
38053
|
*/
|
|
37838
38054
|
|
|
37839
38055
|
/**
|
|
@@ -37877,6 +38093,51 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37877
38093
|
);
|
|
37878
38094
|
}
|
|
37879
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
|
+
|
|
37880
38141
|
/**
|
|
37881
38142
|
* Delete a Speech & Text Analytics topic by id
|
|
37882
38143
|
*
|
|
@@ -37959,7 +38220,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37959
38220
|
|
|
37960
38221
|
/**
|
|
37961
38222
|
* Get list of supported Speech & Text Analytics dialects
|
|
37962
|
-
*
|
|
38223
|
+
* This api has been deprecated. Use api/v2/topics/dialects instead
|
|
37963
38224
|
*/
|
|
37964
38225
|
getSpeechandtextanalyticsDialects() {
|
|
37965
38226
|
|
|
@@ -38152,6 +38413,30 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38152
38413
|
);
|
|
38153
38414
|
}
|
|
38154
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
|
+
|
|
38155
38440
|
/**
|
|
38156
38441
|
* Get Speech And Text Analytics Settings
|
|
38157
38442
|
*
|
|
@@ -38396,6 +38681,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38396
38681
|
);
|
|
38397
38682
|
}
|
|
38398
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
|
+
|
|
38399
38709
|
/**
|
|
38400
38710
|
* Create new Speech & Text Analytics topic
|
|
38401
38711
|
*
|
|
@@ -38592,7 +38902,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38592
38902
|
/**
|
|
38593
38903
|
* Stations service.
|
|
38594
38904
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
38595
|
-
* @version
|
|
38905
|
+
* @version 126.0.0
|
|
38596
38906
|
*/
|
|
38597
38907
|
|
|
38598
38908
|
/**
|
|
@@ -38739,7 +39049,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38739
39049
|
/**
|
|
38740
39050
|
* Suggest service.
|
|
38741
39051
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
38742
|
-
* @version
|
|
39052
|
+
* @version 126.0.0
|
|
38743
39053
|
*/
|
|
38744
39054
|
|
|
38745
39055
|
/**
|
|
@@ -38878,7 +39188,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38878
39188
|
/**
|
|
38879
39189
|
* Telephony service.
|
|
38880
39190
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
38881
|
-
* @version
|
|
39191
|
+
* @version 126.0.0
|
|
38882
39192
|
*/
|
|
38883
39193
|
|
|
38884
39194
|
/**
|
|
@@ -38986,7 +39296,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38986
39296
|
/**
|
|
38987
39297
|
* TelephonyProvidersEdge service.
|
|
38988
39298
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
38989
|
-
* @version
|
|
39299
|
+
* @version 126.0.0
|
|
38990
39300
|
*/
|
|
38991
39301
|
|
|
38992
39302
|
/**
|
|
@@ -42599,7 +42909,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42599
42909
|
/**
|
|
42600
42910
|
* Textbots service.
|
|
42601
42911
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
42602
|
-
* @version
|
|
42912
|
+
* @version 126.0.0
|
|
42603
42913
|
*/
|
|
42604
42914
|
|
|
42605
42915
|
/**
|
|
@@ -42700,7 +43010,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42700
43010
|
/**
|
|
42701
43011
|
* Tokens service.
|
|
42702
43012
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
42703
|
-
* @version
|
|
43013
|
+
* @version 126.0.0
|
|
42704
43014
|
*/
|
|
42705
43015
|
|
|
42706
43016
|
/**
|
|
@@ -42806,7 +43116,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42806
43116
|
/**
|
|
42807
43117
|
* Uploads service.
|
|
42808
43118
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
42809
|
-
* @version
|
|
43119
|
+
* @version 126.0.0
|
|
42810
43120
|
*/
|
|
42811
43121
|
|
|
42812
43122
|
/**
|
|
@@ -42982,7 +43292,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42982
43292
|
/**
|
|
42983
43293
|
* Usage service.
|
|
42984
43294
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
42985
|
-
* @version
|
|
43295
|
+
* @version 126.0.0
|
|
42986
43296
|
*/
|
|
42987
43297
|
|
|
42988
43298
|
/**
|
|
@@ -43053,7 +43363,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43053
43363
|
/**
|
|
43054
43364
|
* UserRecordings service.
|
|
43055
43365
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
43056
|
-
* @version
|
|
43366
|
+
* @version 126.0.0
|
|
43057
43367
|
*/
|
|
43058
43368
|
|
|
43059
43369
|
/**
|
|
@@ -43237,7 +43547,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43237
43547
|
/**
|
|
43238
43548
|
* Users service.
|
|
43239
43549
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
43240
|
-
* @version
|
|
43550
|
+
* @version 126.0.0
|
|
43241
43551
|
*/
|
|
43242
43552
|
|
|
43243
43553
|
/**
|
|
@@ -45539,7 +45849,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45539
45849
|
/**
|
|
45540
45850
|
* Utilities service.
|
|
45541
45851
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
45542
|
-
* @version
|
|
45852
|
+
* @version 126.0.0
|
|
45543
45853
|
*/
|
|
45544
45854
|
|
|
45545
45855
|
/**
|
|
@@ -45650,7 +45960,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45650
45960
|
/**
|
|
45651
45961
|
* Voicemail service.
|
|
45652
45962
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
45653
|
-
* @version
|
|
45963
|
+
* @version 126.0.0
|
|
45654
45964
|
*/
|
|
45655
45965
|
|
|
45656
45966
|
/**
|
|
@@ -46281,13 +46591,43 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46281
46591
|
);
|
|
46282
46592
|
}
|
|
46283
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
|
+
|
|
46284
46624
|
}
|
|
46285
46625
|
|
|
46286
46626
|
class WebChatApi {
|
|
46287
46627
|
/**
|
|
46288
46628
|
* WebChat service.
|
|
46289
46629
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
46290
|
-
* @version
|
|
46630
|
+
* @version 126.0.0
|
|
46291
46631
|
*/
|
|
46292
46632
|
|
|
46293
46633
|
/**
|
|
@@ -46831,7 +47171,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46831
47171
|
/**
|
|
46832
47172
|
* WebDeployments service.
|
|
46833
47173
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
46834
|
-
* @version
|
|
47174
|
+
* @version 126.0.0
|
|
46835
47175
|
*/
|
|
46836
47176
|
|
|
46837
47177
|
/**
|
|
@@ -47182,11 +47522,57 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47182
47522
|
|
|
47183
47523
|
}
|
|
47184
47524
|
|
|
47525
|
+
class WebMessagingApi {
|
|
47526
|
+
/**
|
|
47527
|
+
* WebMessaging service.
|
|
47528
|
+
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
47529
|
+
* @version 126.0.0
|
|
47530
|
+
*/
|
|
47531
|
+
|
|
47532
|
+
/**
|
|
47533
|
+
* Constructs a new WebMessagingApi.
|
|
47534
|
+
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
47535
|
+
* @class
|
|
47536
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
47537
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
47538
|
+
*/
|
|
47539
|
+
constructor(apiClient) {
|
|
47540
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
47541
|
+
}
|
|
47542
|
+
|
|
47543
|
+
|
|
47544
|
+
/**
|
|
47545
|
+
* Get the messages for a web messaging session.
|
|
47546
|
+
*
|
|
47547
|
+
* @param {Object} opts Optional parameters
|
|
47548
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
47549
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
47550
|
+
*/
|
|
47551
|
+
getWebmessagingMessages(opts) {
|
|
47552
|
+
opts = opts || {};
|
|
47553
|
+
|
|
47554
|
+
|
|
47555
|
+
return this.apiClient.callApi(
|
|
47556
|
+
'/api/v2/webmessaging/messages',
|
|
47557
|
+
'GET',
|
|
47558
|
+
{ },
|
|
47559
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
47560
|
+
{ },
|
|
47561
|
+
{ },
|
|
47562
|
+
null,
|
|
47563
|
+
['PureCloud OAuth'],
|
|
47564
|
+
['application/json'],
|
|
47565
|
+
['application/json']
|
|
47566
|
+
);
|
|
47567
|
+
}
|
|
47568
|
+
|
|
47569
|
+
}
|
|
47570
|
+
|
|
47185
47571
|
class WidgetsApi {
|
|
47186
47572
|
/**
|
|
47187
47573
|
* Widgets service.
|
|
47188
47574
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
47189
|
-
* @version
|
|
47575
|
+
* @version 126.0.0
|
|
47190
47576
|
*/
|
|
47191
47577
|
|
|
47192
47578
|
/**
|
|
@@ -47332,7 +47718,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47332
47718
|
/**
|
|
47333
47719
|
* WorkforceManagement service.
|
|
47334
47720
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
47335
|
-
* @version
|
|
47721
|
+
* @version 126.0.0
|
|
47336
47722
|
*/
|
|
47337
47723
|
|
|
47338
47724
|
/**
|
|
@@ -47607,6 +47993,66 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47607
47993
|
);
|
|
47608
47994
|
}
|
|
47609
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
|
+
|
|
47610
48056
|
/**
|
|
47611
48057
|
* Delete a work plan
|
|
47612
48058
|
*
|
|
@@ -48848,6 +49294,116 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48848
49294
|
);
|
|
48849
49295
|
}
|
|
48850
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
|
+
|
|
48851
49407
|
/**
|
|
48852
49408
|
* Get a time off request
|
|
48853
49409
|
*
|
|
@@ -48883,6 +49439,41 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48883
49439
|
);
|
|
48884
49440
|
}
|
|
48885
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
|
+
|
|
48886
49477
|
/**
|
|
48887
49478
|
* Get a list of time off requests for a given user
|
|
48888
49479
|
*
|
|
@@ -49316,6 +49907,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49316
49907
|
);
|
|
49317
49908
|
}
|
|
49318
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
|
+
|
|
49319
49935
|
/**
|
|
49320
49936
|
* Get a list of time off requests for the current user
|
|
49321
49937
|
*
|
|
@@ -49534,6 +50150,74 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49534
50150
|
);
|
|
49535
50151
|
}
|
|
49536
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
|
+
|
|
49537
50221
|
/**
|
|
49538
50222
|
* Update a time off request
|
|
49539
50223
|
*
|
|
@@ -50395,6 +51079,93 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50395
51079
|
);
|
|
50396
51080
|
}
|
|
50397
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
|
+
|
|
50398
51169
|
/**
|
|
50399
51170
|
* Create a new time off request
|
|
50400
51171
|
*
|
|
@@ -50453,6 +51224,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50453
51224
|
);
|
|
50454
51225
|
}
|
|
50455
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
|
+
|
|
50456
51256
|
/**
|
|
50457
51257
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
50458
51258
|
*
|
|
@@ -50836,6 +51636,30 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50836
51636
|
);
|
|
50837
51637
|
}
|
|
50838
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
|
+
|
|
50839
51663
|
/**
|
|
50840
51664
|
* Create a time off request for the current user
|
|
50841
51665
|
*
|
|
@@ -50860,6 +51684,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50860
51684
|
);
|
|
50861
51685
|
}
|
|
50862
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
|
+
|
|
50863
51721
|
}
|
|
50864
51722
|
|
|
50865
51723
|
/**
|
|
@@ -50891,7 +51749,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50891
51749
|
* </pre>
|
|
50892
51750
|
* </p>
|
|
50893
51751
|
* @module purecloud-platform-client-v2/index
|
|
50894
|
-
* @version
|
|
51752
|
+
* @version 126.0.0
|
|
50895
51753
|
*/
|
|
50896
51754
|
class platformClient {
|
|
50897
51755
|
constructor() {
|
|
@@ -51195,6 +52053,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51195
52053
|
* @property {module:purecloud-platform-client-v2/api/WebDeploymentsApi}
|
|
51196
52054
|
*/
|
|
51197
52055
|
this.WebDeploymentsApi = WebDeploymentsApi;
|
|
52056
|
+
/**
|
|
52057
|
+
* The WebMessagingApi service constructor.
|
|
52058
|
+
* @property {module:purecloud-platform-client-v2/api/WebMessagingApi}
|
|
52059
|
+
*/
|
|
52060
|
+
this.WebMessagingApi = WebMessagingApi;
|
|
51198
52061
|
/**
|
|
51199
52062
|
* The WidgetsApi service constructor.
|
|
51200
52063
|
* @property {module:purecloud-platform-client-v2/api/WidgetsApi}
|