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
|
@@ -256,27 +256,29 @@ class Configuration {
|
|
|
256
256
|
}
|
|
257
257
|
|
|
258
258
|
liveLoadConfig() {
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
// do nothing
|
|
259
|
+
if (typeof window === 'undefined') {
|
|
260
|
+
// Please don't remove the typeof window === 'undefined' check here!
|
|
261
|
+
// This safeguards the browser environment from using `fs`, which is only
|
|
262
|
+
// available in node environment.
|
|
263
|
+
this.updateConfigFromFile();
|
|
264
|
+
|
|
265
|
+
if (this.live_reload_config && this.live_reload_config === true) {
|
|
266
|
+
try {
|
|
267
|
+
const fs = require('fs');
|
|
268
|
+
fs.watchFile(this.configPath, { persistent: false }, (eventType, filename) => {
|
|
269
|
+
this.updateConfigFromFile();
|
|
270
|
+
if (!this.live_reload_config) {
|
|
271
|
+
fs.unwatchFile(this.configPath);
|
|
272
|
+
}
|
|
273
|
+
});
|
|
274
|
+
} catch (err) {
|
|
275
|
+
// do nothing
|
|
276
|
+
}
|
|
278
277
|
}
|
|
278
|
+
return;
|
|
279
279
|
}
|
|
280
|
+
// If in browser, don't read config file, use default values
|
|
281
|
+
this.configPath = '';
|
|
280
282
|
}
|
|
281
283
|
|
|
282
284
|
setConfigPath(path) {
|
|
@@ -287,24 +289,29 @@ class Configuration {
|
|
|
287
289
|
}
|
|
288
290
|
|
|
289
291
|
updateConfigFromFile() {
|
|
290
|
-
|
|
291
|
-
|
|
292
|
+
if (typeof window === 'undefined') {
|
|
293
|
+
// Please don't remove the typeof window === 'undefined' check here!
|
|
294
|
+
// This safeguards the browser environment from using `fs`, which is only
|
|
295
|
+
// available in node environment.
|
|
296
|
+
const ConfigParser = require('configparser');
|
|
292
297
|
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
298
|
+
try {
|
|
299
|
+
var configparser = new ConfigParser();
|
|
300
|
+
configparser.read(this.configPath); // If no error catched, indicates it's INI format
|
|
301
|
+
this.config = configparser;
|
|
302
|
+
} catch (error) {
|
|
303
|
+
if (error.name && error.name === 'MissingSectionHeaderError') {
|
|
304
|
+
// Not INI format, see if it's JSON format
|
|
305
|
+
const fs = require('fs');
|
|
306
|
+
var configData = fs.readFileSync(this.configPath, 'utf8');
|
|
307
|
+
this.config = {
|
|
308
|
+
_sections: JSON.parse(configData), // To match INI data format
|
|
309
|
+
};
|
|
310
|
+
}
|
|
304
311
|
}
|
|
305
|
-
}
|
|
306
312
|
|
|
307
|
-
|
|
313
|
+
if (this.config) this.updateConfigValues();
|
|
314
|
+
}
|
|
308
315
|
}
|
|
309
316
|
|
|
310
317
|
updateConfigValues() {
|
|
@@ -386,7 +393,7 @@ class Configuration {
|
|
|
386
393
|
|
|
387
394
|
/**
|
|
388
395
|
* @module purecloud-platform-client-v2/ApiClient
|
|
389
|
-
* @version
|
|
396
|
+
* @version 126.0.0
|
|
390
397
|
*/
|
|
391
398
|
class ApiClient {
|
|
392
399
|
/**
|
|
@@ -1333,7 +1340,7 @@ class ApiClient {
|
|
|
1333
1340
|
|
|
1334
1341
|
// set header parameters
|
|
1335
1342
|
request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
|
|
1336
|
-
//request.set({ 'purecloud-sdk': '
|
|
1343
|
+
//request.set({ 'purecloud-sdk': '126.0.0' });
|
|
1337
1344
|
|
|
1338
1345
|
// set request timeout
|
|
1339
1346
|
request.timeout(that.timeout);
|
|
@@ -1433,7 +1440,7 @@ class AlertingApi {
|
|
|
1433
1440
|
/**
|
|
1434
1441
|
* Alerting service.
|
|
1435
1442
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1436
|
-
* @version
|
|
1443
|
+
* @version 126.0.0
|
|
1437
1444
|
*/
|
|
1438
1445
|
|
|
1439
1446
|
/**
|
|
@@ -1747,7 +1754,7 @@ class AnalyticsApi {
|
|
|
1747
1754
|
/**
|
|
1748
1755
|
* Analytics service.
|
|
1749
1756
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1750
|
-
* @version
|
|
1757
|
+
* @version 126.0.0
|
|
1751
1758
|
*/
|
|
1752
1759
|
|
|
1753
1760
|
/**
|
|
@@ -2343,31 +2350,6 @@ class AnalyticsApi {
|
|
|
2343
2350
|
);
|
|
2344
2351
|
}
|
|
2345
2352
|
|
|
2346
|
-
/**
|
|
2347
|
-
* Patch AnalyticsReportingSettings values for an organization
|
|
2348
|
-
*
|
|
2349
|
-
* @param {Object} body AnalyticsReportingSettingsRequest
|
|
2350
|
-
*/
|
|
2351
|
-
patchAnalyticsReportingSettings(body) {
|
|
2352
|
-
// verify the required parameter 'body' is set
|
|
2353
|
-
if (body === undefined || body === null) {
|
|
2354
|
-
throw 'Missing the required parameter "body" when calling patchAnalyticsReportingSettings';
|
|
2355
|
-
}
|
|
2356
|
-
|
|
2357
|
-
return this.apiClient.callApi(
|
|
2358
|
-
'/api/v2/analytics/reporting/settings',
|
|
2359
|
-
'PATCH',
|
|
2360
|
-
{ },
|
|
2361
|
-
{ },
|
|
2362
|
-
{ },
|
|
2363
|
-
{ },
|
|
2364
|
-
body,
|
|
2365
|
-
['PureCloud OAuth'],
|
|
2366
|
-
['application/json'],
|
|
2367
|
-
['application/json']
|
|
2368
|
-
);
|
|
2369
|
-
}
|
|
2370
|
-
|
|
2371
2353
|
/**
|
|
2372
2354
|
* Query for bot aggregates
|
|
2373
2355
|
*
|
|
@@ -2909,7 +2891,7 @@ class ArchitectApi {
|
|
|
2909
2891
|
/**
|
|
2910
2892
|
* Architect service.
|
|
2911
2893
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2912
|
-
* @version
|
|
2894
|
+
* @version 126.0.0
|
|
2913
2895
|
*/
|
|
2914
2896
|
|
|
2915
2897
|
/**
|
|
@@ -5777,17 +5759,21 @@ class ArchitectApi {
|
|
|
5777
5759
|
* Updates a specific datatable by id
|
|
5778
5760
|
* 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.
|
|
5779
5761
|
* @param {String} datatableId id of datatable
|
|
5762
|
+
* @param {Object} body datatable json-schema
|
|
5780
5763
|
* @param {Object} opts Optional parameters
|
|
5781
5764
|
* @param {Object} opts.expand Expand instructions for the result
|
|
5782
|
-
* @param {Object} opts.body datatable json-schema
|
|
5783
5765
|
*/
|
|
5784
|
-
putFlowsDatatable(datatableId, opts) {
|
|
5766
|
+
putFlowsDatatable(datatableId, body, opts) {
|
|
5785
5767
|
opts = opts || {};
|
|
5786
5768
|
|
|
5787
5769
|
// verify the required parameter 'datatableId' is set
|
|
5788
5770
|
if (datatableId === undefined || datatableId === null) {
|
|
5789
5771
|
throw 'Missing the required parameter "datatableId" when calling putFlowsDatatable';
|
|
5790
5772
|
}
|
|
5773
|
+
// verify the required parameter 'body' is set
|
|
5774
|
+
if (body === undefined || body === null) {
|
|
5775
|
+
throw 'Missing the required parameter "body" when calling putFlowsDatatable';
|
|
5776
|
+
}
|
|
5791
5777
|
|
|
5792
5778
|
return this.apiClient.callApi(
|
|
5793
5779
|
'/api/v2/flows/datatables/{datatableId}',
|
|
@@ -5796,7 +5782,7 @@ class ArchitectApi {
|
|
|
5796
5782
|
{ 'expand': opts['expand'] },
|
|
5797
5783
|
{ },
|
|
5798
5784
|
{ },
|
|
5799
|
-
|
|
5785
|
+
body,
|
|
5800
5786
|
['PureCloud OAuth'],
|
|
5801
5787
|
['application/json'],
|
|
5802
5788
|
['application/json']
|
|
@@ -5901,7 +5887,7 @@ class AuditApi {
|
|
|
5901
5887
|
/**
|
|
5902
5888
|
* Audit service.
|
|
5903
5889
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
5904
|
-
* @version
|
|
5890
|
+
* @version 126.0.0
|
|
5905
5891
|
*/
|
|
5906
5892
|
|
|
5907
5893
|
/**
|
|
@@ -6072,7 +6058,7 @@ class AuthorizationApi {
|
|
|
6072
6058
|
/**
|
|
6073
6059
|
* Authorization service.
|
|
6074
6060
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6075
|
-
* @version
|
|
6061
|
+
* @version 126.0.0
|
|
6076
6062
|
*/
|
|
6077
6063
|
|
|
6078
6064
|
/**
|
|
@@ -7255,7 +7241,7 @@ class BillingApi {
|
|
|
7255
7241
|
/**
|
|
7256
7242
|
* Billing service.
|
|
7257
7243
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7258
|
-
* @version
|
|
7244
|
+
* @version 126.0.0
|
|
7259
7245
|
*/
|
|
7260
7246
|
|
|
7261
7247
|
/**
|
|
@@ -7335,7 +7321,7 @@ class ChatApi {
|
|
|
7335
7321
|
/**
|
|
7336
7322
|
* Chat service.
|
|
7337
7323
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7338
|
-
* @version
|
|
7324
|
+
* @version 126.0.0
|
|
7339
7325
|
*/
|
|
7340
7326
|
|
|
7341
7327
|
/**
|
|
@@ -7426,7 +7412,7 @@ class CoachingApi {
|
|
|
7426
7412
|
/**
|
|
7427
7413
|
* Coaching service.
|
|
7428
7414
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7429
|
-
* @version
|
|
7415
|
+
* @version 126.0.0
|
|
7430
7416
|
*/
|
|
7431
7417
|
|
|
7432
7418
|
/**
|
|
@@ -8001,7 +7987,7 @@ class ContentManagementApi {
|
|
|
8001
7987
|
/**
|
|
8002
7988
|
* ContentManagement service.
|
|
8003
7989
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8004
|
-
* @version
|
|
7990
|
+
* @version 126.0.0
|
|
8005
7991
|
*/
|
|
8006
7992
|
|
|
8007
7993
|
/**
|
|
@@ -9141,7 +9127,7 @@ class ConversationsApi {
|
|
|
9141
9127
|
/**
|
|
9142
9128
|
* Conversations service.
|
|
9143
9129
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9144
|
-
* @version
|
|
9130
|
+
* @version 126.0.0
|
|
9145
9131
|
*/
|
|
9146
9132
|
|
|
9147
9133
|
/**
|
|
@@ -12210,7 +12196,7 @@ class ConversationsApi {
|
|
|
12210
12196
|
}
|
|
12211
12197
|
|
|
12212
12198
|
/**
|
|
12213
|
-
* Attempts to manually assign a specified conversation to a specified
|
|
12199
|
+
* Attempts to manually assign a specified conversation to a specified user. Ignores bullseye ring, PAR score, skills, and languages.
|
|
12214
12200
|
*
|
|
12215
12201
|
* @param {String} conversationId conversation ID
|
|
12216
12202
|
* @param {Object} body Targeted user
|
|
@@ -13530,7 +13516,7 @@ class DataExtensionsApi {
|
|
|
13530
13516
|
/**
|
|
13531
13517
|
* DataExtensions service.
|
|
13532
13518
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
13533
|
-
* @version
|
|
13519
|
+
* @version 126.0.0
|
|
13534
13520
|
*/
|
|
13535
13521
|
|
|
13536
13522
|
/**
|
|
@@ -13616,7 +13602,7 @@ class ExternalContactsApi {
|
|
|
13616
13602
|
/**
|
|
13617
13603
|
* ExternalContacts service.
|
|
13618
13604
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
13619
|
-
* @version
|
|
13605
|
+
* @version 126.0.0
|
|
13620
13606
|
*/
|
|
13621
13607
|
|
|
13622
13608
|
/**
|
|
@@ -15359,7 +15345,7 @@ class FaxApi {
|
|
|
15359
15345
|
/**
|
|
15360
15346
|
* Fax service.
|
|
15361
15347
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
15362
|
-
* @version
|
|
15348
|
+
* @version 126.0.0
|
|
15363
15349
|
*/
|
|
15364
15350
|
|
|
15365
15351
|
/**
|
|
@@ -15530,7 +15516,7 @@ class FlowsApi {
|
|
|
15530
15516
|
/**
|
|
15531
15517
|
* Flows service.
|
|
15532
15518
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
15533
|
-
* @version
|
|
15519
|
+
* @version 126.0.0
|
|
15534
15520
|
*/
|
|
15535
15521
|
|
|
15536
15522
|
/**
|
|
@@ -15601,7 +15587,7 @@ class GamificationApi {
|
|
|
15601
15587
|
/**
|
|
15602
15588
|
* Gamification service.
|
|
15603
15589
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
15604
|
-
* @version
|
|
15590
|
+
* @version 126.0.0
|
|
15605
15591
|
*/
|
|
15606
15592
|
|
|
15607
15593
|
/**
|
|
@@ -16907,7 +16893,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
16907
16893
|
/**
|
|
16908
16894
|
* GeneralDataProtectionRegulation service.
|
|
16909
16895
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
16910
|
-
* @version
|
|
16896
|
+
* @version 126.0.0
|
|
16911
16897
|
*/
|
|
16912
16898
|
|
|
16913
16899
|
/**
|
|
@@ -17037,7 +17023,7 @@ class GeolocationApi {
|
|
|
17037
17023
|
/**
|
|
17038
17024
|
* Geolocation service.
|
|
17039
17025
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
17040
|
-
* @version
|
|
17026
|
+
* @version 126.0.0
|
|
17041
17027
|
*/
|
|
17042
17028
|
|
|
17043
17029
|
/**
|
|
@@ -17168,7 +17154,7 @@ class GreetingsApi {
|
|
|
17168
17154
|
/**
|
|
17169
17155
|
* Greetings service.
|
|
17170
17156
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
17171
|
-
* @version
|
|
17157
|
+
* @version 126.0.0
|
|
17172
17158
|
*/
|
|
17173
17159
|
|
|
17174
17160
|
/**
|
|
@@ -17623,7 +17609,7 @@ class GroupsApi {
|
|
|
17623
17609
|
/**
|
|
17624
17610
|
* Groups service.
|
|
17625
17611
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
17626
|
-
* @version
|
|
17612
|
+
* @version 126.0.0
|
|
17627
17613
|
*/
|
|
17628
17614
|
|
|
17629
17615
|
/**
|
|
@@ -18028,7 +18014,7 @@ class IdentityProviderApi {
|
|
|
18028
18014
|
/**
|
|
18029
18015
|
* IdentityProvider service.
|
|
18030
18016
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
18031
|
-
* @version
|
|
18017
|
+
* @version 126.0.0
|
|
18032
18018
|
*/
|
|
18033
18019
|
|
|
18034
18020
|
/**
|
|
@@ -18784,7 +18770,7 @@ class IntegrationsApi {
|
|
|
18784
18770
|
/**
|
|
18785
18771
|
* Integrations service.
|
|
18786
18772
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
18787
|
-
* @version
|
|
18773
|
+
* @version 126.0.0
|
|
18788
18774
|
*/
|
|
18789
18775
|
|
|
18790
18776
|
/**
|
|
@@ -20430,7 +20416,7 @@ class JourneyApi {
|
|
|
20430
20416
|
/**
|
|
20431
20417
|
* Journey service.
|
|
20432
20418
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
20433
|
-
* @version
|
|
20419
|
+
* @version 126.0.0
|
|
20434
20420
|
*/
|
|
20435
20421
|
|
|
20436
20422
|
/**
|
|
@@ -21141,7 +21127,7 @@ class KnowledgeApi {
|
|
|
21141
21127
|
/**
|
|
21142
21128
|
* Knowledge service.
|
|
21143
21129
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
21144
|
-
* @version
|
|
21130
|
+
* @version 126.0.0
|
|
21145
21131
|
*/
|
|
21146
21132
|
|
|
21147
21133
|
/**
|
|
@@ -21431,6 +21417,8 @@ class KnowledgeApi {
|
|
|
21431
21417
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
21432
21418
|
* @param {String} opts.categories Filter by categories ids, comma separated values expected.
|
|
21433
21419
|
* @param {String} opts.title Filter by document title.
|
|
21420
|
+
* @param {Object} opts.sortBy Sort by.
|
|
21421
|
+
* @param {Object} opts.sortOrder Sort Order.
|
|
21434
21422
|
* @param {Array.<String>} opts.documentIds Comma-separated list of document identifiers to fetch by.
|
|
21435
21423
|
*/
|
|
21436
21424
|
getKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, opts) {
|
|
@@ -21449,7 +21437,7 @@ class KnowledgeApi {
|
|
|
21449
21437
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/languages/{languageCode}/documents',
|
|
21450
21438
|
'GET',
|
|
21451
21439
|
{ 'knowledgeBaseId': knowledgeBaseId,'languageCode': languageCode },
|
|
21452
|
-
{ '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') },
|
|
21440
|
+
{ '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') },
|
|
21453
21441
|
{ },
|
|
21454
21442
|
{ },
|
|
21455
21443
|
null,
|
|
@@ -21578,6 +21566,8 @@ class KnowledgeApi {
|
|
|
21578
21566
|
* @param {String} opts.name Filter by Name.
|
|
21579
21567
|
* @param {Object} opts.coreLanguage Filter by core language.
|
|
21580
21568
|
* @param {Boolean} opts.published Filter by published status.
|
|
21569
|
+
* @param {Object} opts.sortBy Sort by.
|
|
21570
|
+
* @param {Object} opts.sortOrder Sort Order.
|
|
21581
21571
|
*/
|
|
21582
21572
|
getKnowledgeKnowledgebases(opts) {
|
|
21583
21573
|
opts = opts || {};
|
|
@@ -21587,7 +21577,7 @@ class KnowledgeApi {
|
|
|
21587
21577
|
'/api/v2/knowledge/knowledgebases',
|
|
21588
21578
|
'GET',
|
|
21589
21579
|
{ },
|
|
21590
|
-
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'name': opts['name'],'coreLanguage': opts['coreLanguage'],'published': opts['published'] },
|
|
21580
|
+
{ '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'] },
|
|
21591
21581
|
{ },
|
|
21592
21582
|
{ },
|
|
21593
21583
|
null,
|
|
@@ -22037,7 +22027,7 @@ class LanguageUnderstandingApi {
|
|
|
22037
22027
|
/**
|
|
22038
22028
|
* LanguageUnderstanding service.
|
|
22039
22029
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
22040
|
-
* @version
|
|
22030
|
+
* @version 126.0.0
|
|
22041
22031
|
*/
|
|
22042
22032
|
|
|
22043
22033
|
/**
|
|
@@ -22603,7 +22593,7 @@ class LanguageUnderstandingApi {
|
|
|
22603
22593
|
}
|
|
22604
22594
|
|
|
22605
22595
|
/**
|
|
22606
|
-
* Save information for the draft
|
|
22596
|
+
* Save information for the draft. Either topic draft or intent draft should be sent.
|
|
22607
22597
|
*
|
|
22608
22598
|
* @param {String} minerId Miner ID
|
|
22609
22599
|
* @param {String} draftId Draft ID
|
|
@@ -22847,7 +22837,7 @@ class LanguageUnderstandingApi {
|
|
|
22847
22837
|
}
|
|
22848
22838
|
|
|
22849
22839
|
/**
|
|
22850
|
-
* Start the mining process. Specify date range pair with mediaType
|
|
22840
|
+
* Start the mining process. Specify date range pair with mediaType, queueIds, participantType for mining data from Genesys Cloud. Specify only uploadKey for mining through an external file.
|
|
22851
22841
|
*
|
|
22852
22842
|
* @param {String} minerId Miner ID
|
|
22853
22843
|
* @param {Object} opts Optional parameters
|
|
@@ -22941,7 +22931,7 @@ class LanguagesApi {
|
|
|
22941
22931
|
/**
|
|
22942
22932
|
* Languages service.
|
|
22943
22933
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
22944
|
-
* @version
|
|
22934
|
+
* @version 126.0.0
|
|
22945
22935
|
*/
|
|
22946
22936
|
|
|
22947
22937
|
/**
|
|
@@ -23209,7 +23199,7 @@ class LearningApi {
|
|
|
23209
23199
|
/**
|
|
23210
23200
|
* Learning service.
|
|
23211
23201
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
23212
|
-
* @version
|
|
23202
|
+
* @version 126.0.0
|
|
23213
23203
|
*/
|
|
23214
23204
|
|
|
23215
23205
|
/**
|
|
@@ -23800,7 +23790,7 @@ class LicenseApi {
|
|
|
23800
23790
|
/**
|
|
23801
23791
|
* License service.
|
|
23802
23792
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
23803
|
-
* @version
|
|
23793
|
+
* @version 126.0.0
|
|
23804
23794
|
*/
|
|
23805
23795
|
|
|
23806
23796
|
/**
|
|
@@ -24038,7 +24028,7 @@ class LocationsApi {
|
|
|
24038
24028
|
/**
|
|
24039
24029
|
* Locations service.
|
|
24040
24030
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
24041
|
-
* @version
|
|
24031
|
+
* @version 126.0.0
|
|
24042
24032
|
*/
|
|
24043
24033
|
|
|
24044
24034
|
/**
|
|
@@ -24274,7 +24264,7 @@ class MobileDevicesApi {
|
|
|
24274
24264
|
/**
|
|
24275
24265
|
* MobileDevices service.
|
|
24276
24266
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
24277
|
-
* @version
|
|
24267
|
+
* @version 126.0.0
|
|
24278
24268
|
*/
|
|
24279
24269
|
|
|
24280
24270
|
/**
|
|
@@ -24425,7 +24415,7 @@ class NotificationsApi {
|
|
|
24425
24415
|
/**
|
|
24426
24416
|
* Notifications service.
|
|
24427
24417
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
24428
|
-
* @version
|
|
24418
|
+
* @version 126.0.0
|
|
24429
24419
|
*/
|
|
24430
24420
|
|
|
24431
24421
|
/**
|
|
@@ -24650,7 +24640,7 @@ class OAuthApi {
|
|
|
24650
24640
|
/**
|
|
24651
24641
|
* OAuth service.
|
|
24652
24642
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
24653
|
-
* @version
|
|
24643
|
+
* @version 126.0.0
|
|
24654
24644
|
*/
|
|
24655
24645
|
|
|
24656
24646
|
/**
|
|
@@ -25008,7 +24998,7 @@ class ObjectsApi {
|
|
|
25008
24998
|
/**
|
|
25009
24999
|
* Objects service.
|
|
25010
25000
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
25011
|
-
* @version
|
|
25001
|
+
* @version 126.0.0
|
|
25012
25002
|
*/
|
|
25013
25003
|
|
|
25014
25004
|
/**
|
|
@@ -25279,7 +25269,7 @@ class OrganizationApi {
|
|
|
25279
25269
|
/**
|
|
25280
25270
|
* Organization service.
|
|
25281
25271
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
25282
|
-
* @version
|
|
25272
|
+
* @version 126.0.0
|
|
25283
25273
|
*/
|
|
25284
25274
|
|
|
25285
25275
|
/**
|
|
@@ -25682,7 +25672,7 @@ class OrganizationAuthorizationApi {
|
|
|
25682
25672
|
/**
|
|
25683
25673
|
* OrganizationAuthorization service.
|
|
25684
25674
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
25685
|
-
* @version
|
|
25675
|
+
* @version 126.0.0
|
|
25686
25676
|
*/
|
|
25687
25677
|
|
|
25688
25678
|
/**
|
|
@@ -25722,6 +25712,36 @@ class OrganizationAuthorizationApi {
|
|
|
25722
25712
|
);
|
|
25723
25713
|
}
|
|
25724
25714
|
|
|
25715
|
+
/**
|
|
25716
|
+
* Deletes cloned user
|
|
25717
|
+
*
|
|
25718
|
+
* @param {String} trusteeOrgId Trustee Organization Id
|
|
25719
|
+
* @param {String} trusteeUserId Id of the cloned user to delete
|
|
25720
|
+
*/
|
|
25721
|
+
deleteOrgauthorizationTrusteeCloneduser(trusteeOrgId, trusteeUserId) {
|
|
25722
|
+
// verify the required parameter 'trusteeOrgId' is set
|
|
25723
|
+
if (trusteeOrgId === undefined || trusteeOrgId === null) {
|
|
25724
|
+
throw 'Missing the required parameter "trusteeOrgId" when calling deleteOrgauthorizationTrusteeCloneduser';
|
|
25725
|
+
}
|
|
25726
|
+
// verify the required parameter 'trusteeUserId' is set
|
|
25727
|
+
if (trusteeUserId === undefined || trusteeUserId === null) {
|
|
25728
|
+
throw 'Missing the required parameter "trusteeUserId" when calling deleteOrgauthorizationTrusteeCloneduser';
|
|
25729
|
+
}
|
|
25730
|
+
|
|
25731
|
+
return this.apiClient.callApi(
|
|
25732
|
+
'/api/v2/orgauthorization/trustees/{trusteeOrgId}/clonedusers/{trusteeUserId}',
|
|
25733
|
+
'DELETE',
|
|
25734
|
+
{ 'trusteeOrgId': trusteeOrgId,'trusteeUserId': trusteeUserId },
|
|
25735
|
+
{ },
|
|
25736
|
+
{ },
|
|
25737
|
+
{ },
|
|
25738
|
+
null,
|
|
25739
|
+
['PureCloud OAuth'],
|
|
25740
|
+
['application/json'],
|
|
25741
|
+
['application/json']
|
|
25742
|
+
);
|
|
25743
|
+
}
|
|
25744
|
+
|
|
25725
25745
|
/**
|
|
25726
25746
|
* Delete Trustee User
|
|
25727
25747
|
*
|
|
@@ -25807,6 +25827,36 @@ class OrganizationAuthorizationApi {
|
|
|
25807
25827
|
);
|
|
25808
25828
|
}
|
|
25809
25829
|
|
|
25830
|
+
/**
|
|
25831
|
+
* Delete Cloned User
|
|
25832
|
+
*
|
|
25833
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
25834
|
+
* @param {String} trusteeUserId Trustee User Id
|
|
25835
|
+
*/
|
|
25836
|
+
deleteOrgauthorizationTrustorCloneduser(trustorOrgId, trusteeUserId) {
|
|
25837
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
25838
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
25839
|
+
throw 'Missing the required parameter "trustorOrgId" when calling deleteOrgauthorizationTrustorCloneduser';
|
|
25840
|
+
}
|
|
25841
|
+
// verify the required parameter 'trusteeUserId' is set
|
|
25842
|
+
if (trusteeUserId === undefined || trusteeUserId === null) {
|
|
25843
|
+
throw 'Missing the required parameter "trusteeUserId" when calling deleteOrgauthorizationTrustorCloneduser';
|
|
25844
|
+
}
|
|
25845
|
+
|
|
25846
|
+
return this.apiClient.callApi(
|
|
25847
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}',
|
|
25848
|
+
'DELETE',
|
|
25849
|
+
{ 'trustorOrgId': trustorOrgId,'trusteeUserId': trusteeUserId },
|
|
25850
|
+
{ },
|
|
25851
|
+
{ },
|
|
25852
|
+
{ },
|
|
25853
|
+
null,
|
|
25854
|
+
['PureCloud OAuth'],
|
|
25855
|
+
['application/json'],
|
|
25856
|
+
['application/json']
|
|
25857
|
+
);
|
|
25858
|
+
}
|
|
25859
|
+
|
|
25810
25860
|
/**
|
|
25811
25861
|
* Delete Trustee User
|
|
25812
25862
|
*
|
|
@@ -25887,6 +25937,31 @@ class OrganizationAuthorizationApi {
|
|
|
25887
25937
|
);
|
|
25888
25938
|
}
|
|
25889
25939
|
|
|
25940
|
+
/**
|
|
25941
|
+
* The list of cloned users from the trustee organization (i.e. users with a native user record).
|
|
25942
|
+
* There can be no more than 5 cloned users per organization, so results are represented as simple list and not paged
|
|
25943
|
+
* @param {String} trusteeOrgId Trustee Organization Id
|
|
25944
|
+
*/
|
|
25945
|
+
getOrgauthorizationTrusteeClonedusers(trusteeOrgId) {
|
|
25946
|
+
// verify the required parameter 'trusteeOrgId' is set
|
|
25947
|
+
if (trusteeOrgId === undefined || trusteeOrgId === null) {
|
|
25948
|
+
throw 'Missing the required parameter "trusteeOrgId" when calling getOrgauthorizationTrusteeClonedusers';
|
|
25949
|
+
}
|
|
25950
|
+
|
|
25951
|
+
return this.apiClient.callApi(
|
|
25952
|
+
'/api/v2/orgauthorization/trustees/{trusteeOrgId}/clonedusers',
|
|
25953
|
+
'GET',
|
|
25954
|
+
{ 'trusteeOrgId': trusteeOrgId },
|
|
25955
|
+
{ },
|
|
25956
|
+
{ },
|
|
25957
|
+
{ },
|
|
25958
|
+
null,
|
|
25959
|
+
['PureCloud OAuth'],
|
|
25960
|
+
['application/json'],
|
|
25961
|
+
['application/json']
|
|
25962
|
+
);
|
|
25963
|
+
}
|
|
25964
|
+
|
|
25890
25965
|
/**
|
|
25891
25966
|
* Get Trustee User
|
|
25892
25967
|
*
|
|
@@ -26002,6 +26077,26 @@ class OrganizationAuthorizationApi {
|
|
|
26002
26077
|
);
|
|
26003
26078
|
}
|
|
26004
26079
|
|
|
26080
|
+
/**
|
|
26081
|
+
* Get organization authorization trust with Customer Care, if one exists.
|
|
26082
|
+
*
|
|
26083
|
+
*/
|
|
26084
|
+
getOrgauthorizationTrusteesDefault() {
|
|
26085
|
+
|
|
26086
|
+
return this.apiClient.callApi(
|
|
26087
|
+
'/api/v2/orgauthorization/trustees/default',
|
|
26088
|
+
'GET',
|
|
26089
|
+
{ },
|
|
26090
|
+
{ },
|
|
26091
|
+
{ },
|
|
26092
|
+
{ },
|
|
26093
|
+
null,
|
|
26094
|
+
['PureCloud OAuth'],
|
|
26095
|
+
['application/json'],
|
|
26096
|
+
['application/json']
|
|
26097
|
+
);
|
|
26098
|
+
}
|
|
26099
|
+
|
|
26005
26100
|
/**
|
|
26006
26101
|
* Get Org Trust
|
|
26007
26102
|
*
|
|
@@ -26027,6 +26122,61 @@ class OrganizationAuthorizationApi {
|
|
|
26027
26122
|
);
|
|
26028
26123
|
}
|
|
26029
26124
|
|
|
26125
|
+
/**
|
|
26126
|
+
* Get Cloned User
|
|
26127
|
+
*
|
|
26128
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
26129
|
+
* @param {String} trusteeUserId Trustee User Id
|
|
26130
|
+
*/
|
|
26131
|
+
getOrgauthorizationTrustorCloneduser(trustorOrgId, trusteeUserId) {
|
|
26132
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
26133
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
26134
|
+
throw 'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustorCloneduser';
|
|
26135
|
+
}
|
|
26136
|
+
// verify the required parameter 'trusteeUserId' is set
|
|
26137
|
+
if (trusteeUserId === undefined || trusteeUserId === null) {
|
|
26138
|
+
throw 'Missing the required parameter "trusteeUserId" when calling getOrgauthorizationTrustorCloneduser';
|
|
26139
|
+
}
|
|
26140
|
+
|
|
26141
|
+
return this.apiClient.callApi(
|
|
26142
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}',
|
|
26143
|
+
'GET',
|
|
26144
|
+
{ 'trustorOrgId': trustorOrgId,'trusteeUserId': trusteeUserId },
|
|
26145
|
+
{ },
|
|
26146
|
+
{ },
|
|
26147
|
+
{ },
|
|
26148
|
+
null,
|
|
26149
|
+
['PureCloud OAuth'],
|
|
26150
|
+
['application/json'],
|
|
26151
|
+
['application/json']
|
|
26152
|
+
);
|
|
26153
|
+
}
|
|
26154
|
+
|
|
26155
|
+
/**
|
|
26156
|
+
* The list of cloned users in the trustor organization (i.e. users with a native user record).
|
|
26157
|
+
*
|
|
26158
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
26159
|
+
*/
|
|
26160
|
+
getOrgauthorizationTrustorClonedusers(trustorOrgId) {
|
|
26161
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
26162
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
26163
|
+
throw 'Missing the required parameter "trustorOrgId" when calling getOrgauthorizationTrustorClonedusers';
|
|
26164
|
+
}
|
|
26165
|
+
|
|
26166
|
+
return this.apiClient.callApi(
|
|
26167
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers',
|
|
26168
|
+
'GET',
|
|
26169
|
+
{ 'trustorOrgId': trustorOrgId },
|
|
26170
|
+
{ },
|
|
26171
|
+
{ },
|
|
26172
|
+
{ },
|
|
26173
|
+
null,
|
|
26174
|
+
['PureCloud OAuth'],
|
|
26175
|
+
['application/json'],
|
|
26176
|
+
['application/json']
|
|
26177
|
+
);
|
|
26178
|
+
}
|
|
26179
|
+
|
|
26030
26180
|
/**
|
|
26031
26181
|
* Get Trustee User
|
|
26032
26182
|
*
|
|
@@ -26224,6 +26374,31 @@ class OrganizationAuthorizationApi {
|
|
|
26224
26374
|
);
|
|
26225
26375
|
}
|
|
26226
26376
|
|
|
26377
|
+
/**
|
|
26378
|
+
* Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.
|
|
26379
|
+
*
|
|
26380
|
+
* @param {Object} opts Optional parameters
|
|
26381
|
+
* @param {Boolean} opts.assignDefaultRole Assign Admin role to default pairing with Customer Care
|
|
26382
|
+
* @param {Boolean} opts.autoExpire Automatically expire pairing after 30 days
|
|
26383
|
+
*/
|
|
26384
|
+
postOrgauthorizationTrusteesDefault(opts) {
|
|
26385
|
+
opts = opts || {};
|
|
26386
|
+
|
|
26387
|
+
|
|
26388
|
+
return this.apiClient.callApi(
|
|
26389
|
+
'/api/v2/orgauthorization/trustees/default',
|
|
26390
|
+
'POST',
|
|
26391
|
+
{ },
|
|
26392
|
+
{ 'assignDefaultRole': opts['assignDefaultRole'],'autoExpire': opts['autoExpire'] },
|
|
26393
|
+
{ },
|
|
26394
|
+
{ },
|
|
26395
|
+
null,
|
|
26396
|
+
['PureCloud OAuth'],
|
|
26397
|
+
['application/json'],
|
|
26398
|
+
['application/json']
|
|
26399
|
+
);
|
|
26400
|
+
}
|
|
26401
|
+
|
|
26227
26402
|
/**
|
|
26228
26403
|
* Get Org Trustor Audits
|
|
26229
26404
|
*
|
|
@@ -26356,6 +26531,36 @@ class OrganizationAuthorizationApi {
|
|
|
26356
26531
|
);
|
|
26357
26532
|
}
|
|
26358
26533
|
|
|
26534
|
+
/**
|
|
26535
|
+
* Creates a clone of the trustee user in the trustor org.
|
|
26536
|
+
*
|
|
26537
|
+
* @param {String} trustorOrgId Trustor Organization Id
|
|
26538
|
+
* @param {String} trusteeUserId Trustee User Id
|
|
26539
|
+
*/
|
|
26540
|
+
putOrgauthorizationTrustorCloneduser(trustorOrgId, trusteeUserId) {
|
|
26541
|
+
// verify the required parameter 'trustorOrgId' is set
|
|
26542
|
+
if (trustorOrgId === undefined || trustorOrgId === null) {
|
|
26543
|
+
throw 'Missing the required parameter "trustorOrgId" when calling putOrgauthorizationTrustorCloneduser';
|
|
26544
|
+
}
|
|
26545
|
+
// verify the required parameter 'trusteeUserId' is set
|
|
26546
|
+
if (trusteeUserId === undefined || trusteeUserId === null) {
|
|
26547
|
+
throw 'Missing the required parameter "trusteeUserId" when calling putOrgauthorizationTrustorCloneduser';
|
|
26548
|
+
}
|
|
26549
|
+
|
|
26550
|
+
return this.apiClient.callApi(
|
|
26551
|
+
'/api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId}',
|
|
26552
|
+
'PUT',
|
|
26553
|
+
{ 'trustorOrgId': trustorOrgId,'trusteeUserId': trusteeUserId },
|
|
26554
|
+
{ },
|
|
26555
|
+
{ },
|
|
26556
|
+
{ },
|
|
26557
|
+
null,
|
|
26558
|
+
['PureCloud OAuth'],
|
|
26559
|
+
['application/json'],
|
|
26560
|
+
['application/json']
|
|
26561
|
+
);
|
|
26562
|
+
}
|
|
26563
|
+
|
|
26359
26564
|
/**
|
|
26360
26565
|
* Add a Trustee user to the trust.
|
|
26361
26566
|
*
|
|
@@ -26392,7 +26597,7 @@ class OutboundApi {
|
|
|
26392
26597
|
/**
|
|
26393
26598
|
* Outbound service.
|
|
26394
26599
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
26395
|
-
* @version
|
|
26600
|
+
* @version 126.0.0
|
|
26396
26601
|
*/
|
|
26397
26602
|
|
|
26398
26603
|
/**
|
|
@@ -29418,7 +29623,7 @@ class PresenceApi {
|
|
|
29418
29623
|
/**
|
|
29419
29624
|
* Presence service.
|
|
29420
29625
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
29421
|
-
* @version
|
|
29626
|
+
* @version 126.0.0
|
|
29422
29627
|
*/
|
|
29423
29628
|
|
|
29424
29629
|
/**
|
|
@@ -29790,7 +29995,7 @@ class QualityApi {
|
|
|
29790
29995
|
/**
|
|
29791
29996
|
* Quality service.
|
|
29792
29997
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
29793
|
-
* @version
|
|
29998
|
+
* @version 126.0.0
|
|
29794
29999
|
*/
|
|
29795
30000
|
|
|
29796
30001
|
/**
|
|
@@ -30163,7 +30368,7 @@ class QualityApi {
|
|
|
30163
30368
|
|
|
30164
30369
|
/**
|
|
30165
30370
|
* Queries Evaluations and returns a paged list
|
|
30166
|
-
* Query params must include one of conversationId, evaluatorUserId, or agentUserId
|
|
30371
|
+
* Query params must include one of conversationId, evaluatorUserId, or agentUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to 'Never Release' are omitted in this case. When querying by evaluatorUserId or conversationId (including when combined with agentUserId), the results are sorted by assigned date.
|
|
30167
30372
|
* @param {Object} opts Optional parameters
|
|
30168
30373
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
30169
30374
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -31318,7 +31523,7 @@ class RecordingApi {
|
|
|
31318
31523
|
/**
|
|
31319
31524
|
* Recording service.
|
|
31320
31525
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
31321
|
-
* @version
|
|
31526
|
+
* @version 126.0.0
|
|
31322
31527
|
*/
|
|
31323
31528
|
|
|
31324
31529
|
/**
|
|
@@ -32837,7 +33042,7 @@ class ResponseManagementApi {
|
|
|
32837
33042
|
/**
|
|
32838
33043
|
* ResponseManagement service.
|
|
32839
33044
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
32840
|
-
* @version
|
|
33045
|
+
* @version 126.0.0
|
|
32841
33046
|
*/
|
|
32842
33047
|
|
|
32843
33048
|
/**
|
|
@@ -33162,7 +33367,7 @@ class RoutingApi {
|
|
|
33162
33367
|
/**
|
|
33163
33368
|
* Routing service.
|
|
33164
33369
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
33165
|
-
* @version
|
|
33370
|
+
* @version 126.0.0
|
|
33166
33371
|
*/
|
|
33167
33372
|
|
|
33168
33373
|
/**
|
|
@@ -33475,8 +33680,12 @@ class RoutingApi {
|
|
|
33475
33680
|
* Delete a phone number provisioned for SMS.
|
|
33476
33681
|
*
|
|
33477
33682
|
* @param {String} addressId Address ID
|
|
33683
|
+
* @param {Object} opts Optional parameters
|
|
33684
|
+
* @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)
|
|
33478
33685
|
*/
|
|
33479
|
-
deleteRoutingSmsPhonenumber(addressId) {
|
|
33686
|
+
deleteRoutingSmsPhonenumber(addressId, opts) {
|
|
33687
|
+
opts = opts || {};
|
|
33688
|
+
|
|
33480
33689
|
// verify the required parameter 'addressId' is set
|
|
33481
33690
|
if (addressId === undefined || addressId === null) {
|
|
33482
33691
|
throw 'Missing the required parameter "addressId" when calling deleteRoutingSmsPhonenumber';
|
|
@@ -33486,7 +33695,7 @@ class RoutingApi {
|
|
|
33486
33695
|
'/api/v2/routing/sms/phonenumbers/{addressId}',
|
|
33487
33696
|
'DELETE',
|
|
33488
33697
|
{ 'addressId': addressId },
|
|
33489
|
-
{
|
|
33698
|
+
{ 'async': opts['async'] },
|
|
33490
33699
|
{ },
|
|
33491
33700
|
{ },
|
|
33492
33701
|
null,
|
|
@@ -34314,12 +34523,11 @@ class RoutingApi {
|
|
|
34314
34523
|
}
|
|
34315
34524
|
|
|
34316
34525
|
/**
|
|
34317
|
-
* Get a paged listing of simplified queue objects. Can be used to get a digest of all queues in an organization.
|
|
34526
|
+
* Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization.
|
|
34318
34527
|
*
|
|
34319
34528
|
* @param {Object} opts Optional parameters
|
|
34320
34529
|
* @param {Number} opts.pageSize Page size [max value is 500] (default to 25)
|
|
34321
34530
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
34322
|
-
* @param {Object} opts.sortBy Sort by (default to name)
|
|
34323
34531
|
* @param {Object} opts.sortOrder Sort order (default to asc)
|
|
34324
34532
|
*/
|
|
34325
34533
|
getRoutingQueuesDivisionviewsAll(opts) {
|
|
@@ -34330,7 +34538,7 @@ class RoutingApi {
|
|
|
34330
34538
|
'/api/v2/routing/queues/divisionviews/all',
|
|
34331
34539
|
'GET',
|
|
34332
34540
|
{ },
|
|
34333
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'
|
|
34541
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'] },
|
|
34334
34542
|
{ },
|
|
34335
34543
|
{ },
|
|
34336
34544
|
null,
|
|
@@ -34814,7 +35022,7 @@ class RoutingApi {
|
|
|
34814
35022
|
|
|
34815
35023
|
/**
|
|
34816
35024
|
* Update attributes of an in-queue conversation
|
|
34817
|
-
* Returns an object indicating the updated values of all settable attributes. Supported attributes:
|
|
35025
|
+
* Returns an object indicating the updated values of all settable attributes. Supported attributes: skillIds, languageId, and priority.
|
|
34818
35026
|
* @param {String} conversationId Conversation ID
|
|
34819
35027
|
* @param {Object} body Conversation Attributes
|
|
34820
35028
|
*/
|
|
@@ -35633,8 +35841,12 @@ class RoutingApi {
|
|
|
35633
35841
|
* Provision a phone number for SMS
|
|
35634
35842
|
*
|
|
35635
35843
|
* @param {Object} body SmsPhoneNumber
|
|
35844
|
+
* @param {Object} opts Optional parameters
|
|
35845
|
+
* @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)
|
|
35636
35846
|
*/
|
|
35637
|
-
postRoutingSmsPhonenumbers(body) {
|
|
35847
|
+
postRoutingSmsPhonenumbers(body, opts) {
|
|
35848
|
+
opts = opts || {};
|
|
35849
|
+
|
|
35638
35850
|
// verify the required parameter 'body' is set
|
|
35639
35851
|
if (body === undefined || body === null) {
|
|
35640
35852
|
throw 'Missing the required parameter "body" when calling postRoutingSmsPhonenumbers';
|
|
@@ -35644,7 +35856,7 @@ class RoutingApi {
|
|
|
35644
35856
|
'/api/v2/routing/sms/phonenumbers',
|
|
35645
35857
|
'POST',
|
|
35646
35858
|
{ },
|
|
35647
|
-
{
|
|
35859
|
+
{ 'async': opts['async'] },
|
|
35648
35860
|
{ },
|
|
35649
35861
|
{ },
|
|
35650
35862
|
body,
|
|
@@ -35889,8 +36101,12 @@ class RoutingApi {
|
|
|
35889
36101
|
*
|
|
35890
36102
|
* @param {String} addressId Address ID
|
|
35891
36103
|
* @param {Object} body SmsPhoneNumber
|
|
36104
|
+
* @param {Object} opts Optional parameters
|
|
36105
|
+
* @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)
|
|
35892
36106
|
*/
|
|
35893
|
-
putRoutingSmsPhonenumber(addressId, body) {
|
|
36107
|
+
putRoutingSmsPhonenumber(addressId, body, opts) {
|
|
36108
|
+
opts = opts || {};
|
|
36109
|
+
|
|
35894
36110
|
// verify the required parameter 'addressId' is set
|
|
35895
36111
|
if (addressId === undefined || addressId === null) {
|
|
35896
36112
|
throw 'Missing the required parameter "addressId" when calling putRoutingSmsPhonenumber';
|
|
@@ -35904,7 +36120,7 @@ class RoutingApi {
|
|
|
35904
36120
|
'/api/v2/routing/sms/phonenumbers/{addressId}',
|
|
35905
36121
|
'PUT',
|
|
35906
36122
|
{ 'addressId': addressId },
|
|
35907
|
-
{
|
|
36123
|
+
{ 'async': opts['async'] },
|
|
35908
36124
|
{ },
|
|
35909
36125
|
{ },
|
|
35910
36126
|
body,
|
|
@@ -36070,7 +36286,7 @@ class SCIMApi {
|
|
|
36070
36286
|
/**
|
|
36071
36287
|
* SCIM service.
|
|
36072
36288
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
36073
|
-
* @version
|
|
36289
|
+
* @version 126.0.0
|
|
36074
36290
|
*/
|
|
36075
36291
|
|
|
36076
36292
|
/**
|
|
@@ -36947,7 +37163,7 @@ class ScriptsApi {
|
|
|
36947
37163
|
/**
|
|
36948
37164
|
* Scripts service.
|
|
36949
37165
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
36950
|
-
* @version
|
|
37166
|
+
* @version 126.0.0
|
|
36951
37167
|
*/
|
|
36952
37168
|
|
|
36953
37169
|
/**
|
|
@@ -37300,7 +37516,7 @@ class SearchApi {
|
|
|
37300
37516
|
/**
|
|
37301
37517
|
* Search service.
|
|
37302
37518
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
37303
|
-
* @version
|
|
37519
|
+
* @version 126.0.0
|
|
37304
37520
|
*/
|
|
37305
37521
|
|
|
37306
37522
|
/**
|
|
@@ -37835,7 +38051,7 @@ class SpeechTextAnalyticsApi {
|
|
|
37835
38051
|
/**
|
|
37836
38052
|
* SpeechTextAnalytics service.
|
|
37837
38053
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
37838
|
-
* @version
|
|
38054
|
+
* @version 126.0.0
|
|
37839
38055
|
*/
|
|
37840
38056
|
|
|
37841
38057
|
/**
|
|
@@ -37879,6 +38095,51 @@ class SpeechTextAnalyticsApi {
|
|
|
37879
38095
|
);
|
|
37880
38096
|
}
|
|
37881
38097
|
|
|
38098
|
+
/**
|
|
38099
|
+
* Delete All Speech & Text Analytics SentimentFeedback
|
|
38100
|
+
*
|
|
38101
|
+
*/
|
|
38102
|
+
deleteSpeechandtextanalyticsSentimentfeedback() {
|
|
38103
|
+
|
|
38104
|
+
return this.apiClient.callApi(
|
|
38105
|
+
'/api/v2/speechandtextanalytics/sentimentfeedback',
|
|
38106
|
+
'DELETE',
|
|
38107
|
+
{ },
|
|
38108
|
+
{ },
|
|
38109
|
+
{ },
|
|
38110
|
+
{ },
|
|
38111
|
+
null,
|
|
38112
|
+
['PureCloud OAuth'],
|
|
38113
|
+
['application/json'],
|
|
38114
|
+
['application/json']
|
|
38115
|
+
);
|
|
38116
|
+
}
|
|
38117
|
+
|
|
38118
|
+
/**
|
|
38119
|
+
* Delete a Speech & Text Analytics SentimentFeedback by Id
|
|
38120
|
+
*
|
|
38121
|
+
* @param {String} sentimentFeedbackId The Id of the SentimentFeedback
|
|
38122
|
+
*/
|
|
38123
|
+
deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId(sentimentFeedbackId) {
|
|
38124
|
+
// verify the required parameter 'sentimentFeedbackId' is set
|
|
38125
|
+
if (sentimentFeedbackId === undefined || sentimentFeedbackId === null) {
|
|
38126
|
+
throw 'Missing the required parameter "sentimentFeedbackId" when calling deleteSpeechandtextanalyticsSentimentfeedbackSentimentFeedbackId';
|
|
38127
|
+
}
|
|
38128
|
+
|
|
38129
|
+
return this.apiClient.callApi(
|
|
38130
|
+
'/api/v2/speechandtextanalytics/sentimentfeedback/{sentimentFeedbackId}',
|
|
38131
|
+
'DELETE',
|
|
38132
|
+
{ 'sentimentFeedbackId': sentimentFeedbackId },
|
|
38133
|
+
{ },
|
|
38134
|
+
{ },
|
|
38135
|
+
{ },
|
|
38136
|
+
null,
|
|
38137
|
+
['PureCloud OAuth'],
|
|
38138
|
+
['application/json'],
|
|
38139
|
+
['application/json']
|
|
38140
|
+
);
|
|
38141
|
+
}
|
|
38142
|
+
|
|
37882
38143
|
/**
|
|
37883
38144
|
* Delete a Speech & Text Analytics topic by id
|
|
37884
38145
|
*
|
|
@@ -37961,7 +38222,7 @@ class SpeechTextAnalyticsApi {
|
|
|
37961
38222
|
|
|
37962
38223
|
/**
|
|
37963
38224
|
* Get list of supported Speech & Text Analytics dialects
|
|
37964
|
-
*
|
|
38225
|
+
* This api has been deprecated. Use api/v2/topics/dialects instead
|
|
37965
38226
|
*/
|
|
37966
38227
|
getSpeechandtextanalyticsDialects() {
|
|
37967
38228
|
|
|
@@ -38154,6 +38415,30 @@ class SpeechTextAnalyticsApi {
|
|
|
38154
38415
|
);
|
|
38155
38416
|
}
|
|
38156
38417
|
|
|
38418
|
+
/**
|
|
38419
|
+
* Get the list of Speech & Text Analytics SentimentFeedback
|
|
38420
|
+
*
|
|
38421
|
+
* @param {Object} opts Optional parameters
|
|
38422
|
+
* @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
|
|
38423
|
+
*/
|
|
38424
|
+
getSpeechandtextanalyticsSentimentfeedback(opts) {
|
|
38425
|
+
opts = opts || {};
|
|
38426
|
+
|
|
38427
|
+
|
|
38428
|
+
return this.apiClient.callApi(
|
|
38429
|
+
'/api/v2/speechandtextanalytics/sentimentfeedback',
|
|
38430
|
+
'GET',
|
|
38431
|
+
{ },
|
|
38432
|
+
{ 'dialect': opts['dialect'] },
|
|
38433
|
+
{ },
|
|
38434
|
+
{ },
|
|
38435
|
+
null,
|
|
38436
|
+
['PureCloud OAuth'],
|
|
38437
|
+
['application/json'],
|
|
38438
|
+
['application/json']
|
|
38439
|
+
);
|
|
38440
|
+
}
|
|
38441
|
+
|
|
38157
38442
|
/**
|
|
38158
38443
|
* Get Speech And Text Analytics Settings
|
|
38159
38444
|
*
|
|
@@ -38398,6 +38683,31 @@ class SpeechTextAnalyticsApi {
|
|
|
38398
38683
|
);
|
|
38399
38684
|
}
|
|
38400
38685
|
|
|
38686
|
+
/**
|
|
38687
|
+
* Create a Speech & Text Analytics SentimentFeedback
|
|
38688
|
+
*
|
|
38689
|
+
* @param {Object} body The SentimentFeedback to create
|
|
38690
|
+
*/
|
|
38691
|
+
postSpeechandtextanalyticsSentimentfeedback(body) {
|
|
38692
|
+
// verify the required parameter 'body' is set
|
|
38693
|
+
if (body === undefined || body === null) {
|
|
38694
|
+
throw 'Missing the required parameter "body" when calling postSpeechandtextanalyticsSentimentfeedback';
|
|
38695
|
+
}
|
|
38696
|
+
|
|
38697
|
+
return this.apiClient.callApi(
|
|
38698
|
+
'/api/v2/speechandtextanalytics/sentimentfeedback',
|
|
38699
|
+
'POST',
|
|
38700
|
+
{ },
|
|
38701
|
+
{ },
|
|
38702
|
+
{ },
|
|
38703
|
+
{ },
|
|
38704
|
+
body,
|
|
38705
|
+
['PureCloud OAuth'],
|
|
38706
|
+
['application/json'],
|
|
38707
|
+
['application/json']
|
|
38708
|
+
);
|
|
38709
|
+
}
|
|
38710
|
+
|
|
38401
38711
|
/**
|
|
38402
38712
|
* Create new Speech & Text Analytics topic
|
|
38403
38713
|
*
|
|
@@ -38594,7 +38904,7 @@ class StationsApi {
|
|
|
38594
38904
|
/**
|
|
38595
38905
|
* Stations service.
|
|
38596
38906
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
38597
|
-
* @version
|
|
38907
|
+
* @version 126.0.0
|
|
38598
38908
|
*/
|
|
38599
38909
|
|
|
38600
38910
|
/**
|
|
@@ -38741,7 +39051,7 @@ class SuggestApi {
|
|
|
38741
39051
|
/**
|
|
38742
39052
|
* Suggest service.
|
|
38743
39053
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
38744
|
-
* @version
|
|
39054
|
+
* @version 126.0.0
|
|
38745
39055
|
*/
|
|
38746
39056
|
|
|
38747
39057
|
/**
|
|
@@ -38880,7 +39190,7 @@ class TelephonyApi {
|
|
|
38880
39190
|
/**
|
|
38881
39191
|
* Telephony service.
|
|
38882
39192
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
38883
|
-
* @version
|
|
39193
|
+
* @version 126.0.0
|
|
38884
39194
|
*/
|
|
38885
39195
|
|
|
38886
39196
|
/**
|
|
@@ -38988,7 +39298,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
38988
39298
|
/**
|
|
38989
39299
|
* TelephonyProvidersEdge service.
|
|
38990
39300
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
38991
|
-
* @version
|
|
39301
|
+
* @version 126.0.0
|
|
38992
39302
|
*/
|
|
38993
39303
|
|
|
38994
39304
|
/**
|
|
@@ -42601,7 +42911,7 @@ class TextbotsApi {
|
|
|
42601
42911
|
/**
|
|
42602
42912
|
* Textbots service.
|
|
42603
42913
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
42604
|
-
* @version
|
|
42914
|
+
* @version 126.0.0
|
|
42605
42915
|
*/
|
|
42606
42916
|
|
|
42607
42917
|
/**
|
|
@@ -42702,7 +43012,7 @@ class TokensApi {
|
|
|
42702
43012
|
/**
|
|
42703
43013
|
* Tokens service.
|
|
42704
43014
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
42705
|
-
* @version
|
|
43015
|
+
* @version 126.0.0
|
|
42706
43016
|
*/
|
|
42707
43017
|
|
|
42708
43018
|
/**
|
|
@@ -42808,7 +43118,7 @@ class UploadsApi {
|
|
|
42808
43118
|
/**
|
|
42809
43119
|
* Uploads service.
|
|
42810
43120
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
42811
|
-
* @version
|
|
43121
|
+
* @version 126.0.0
|
|
42812
43122
|
*/
|
|
42813
43123
|
|
|
42814
43124
|
/**
|
|
@@ -42984,7 +43294,7 @@ class UsageApi {
|
|
|
42984
43294
|
/**
|
|
42985
43295
|
* Usage service.
|
|
42986
43296
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
42987
|
-
* @version
|
|
43297
|
+
* @version 126.0.0
|
|
42988
43298
|
*/
|
|
42989
43299
|
|
|
42990
43300
|
/**
|
|
@@ -43055,7 +43365,7 @@ class UserRecordingsApi {
|
|
|
43055
43365
|
/**
|
|
43056
43366
|
* UserRecordings service.
|
|
43057
43367
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
43058
|
-
* @version
|
|
43368
|
+
* @version 126.0.0
|
|
43059
43369
|
*/
|
|
43060
43370
|
|
|
43061
43371
|
/**
|
|
@@ -43239,7 +43549,7 @@ class UsersApi {
|
|
|
43239
43549
|
/**
|
|
43240
43550
|
* Users service.
|
|
43241
43551
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
43242
|
-
* @version
|
|
43552
|
+
* @version 126.0.0
|
|
43243
43553
|
*/
|
|
43244
43554
|
|
|
43245
43555
|
/**
|
|
@@ -45541,7 +45851,7 @@ class UtilitiesApi {
|
|
|
45541
45851
|
/**
|
|
45542
45852
|
* Utilities service.
|
|
45543
45853
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
45544
|
-
* @version
|
|
45854
|
+
* @version 126.0.0
|
|
45545
45855
|
*/
|
|
45546
45856
|
|
|
45547
45857
|
/**
|
|
@@ -45652,7 +45962,7 @@ class VoicemailApi {
|
|
|
45652
45962
|
/**
|
|
45653
45963
|
* Voicemail service.
|
|
45654
45964
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
45655
|
-
* @version
|
|
45965
|
+
* @version 126.0.0
|
|
45656
45966
|
*/
|
|
45657
45967
|
|
|
45658
45968
|
/**
|
|
@@ -46283,13 +46593,43 @@ class VoicemailApi {
|
|
|
46283
46593
|
);
|
|
46284
46594
|
}
|
|
46285
46595
|
|
|
46596
|
+
/**
|
|
46597
|
+
* Update a user's voicemail policy
|
|
46598
|
+
*
|
|
46599
|
+
* @param {String} userId User ID
|
|
46600
|
+
* @param {Object} body The user's voicemail policy
|
|
46601
|
+
*/
|
|
46602
|
+
putVoicemailUserpolicy(userId, body) {
|
|
46603
|
+
// verify the required parameter 'userId' is set
|
|
46604
|
+
if (userId === undefined || userId === null) {
|
|
46605
|
+
throw 'Missing the required parameter "userId" when calling putVoicemailUserpolicy';
|
|
46606
|
+
}
|
|
46607
|
+
// verify the required parameter 'body' is set
|
|
46608
|
+
if (body === undefined || body === null) {
|
|
46609
|
+
throw 'Missing the required parameter "body" when calling putVoicemailUserpolicy';
|
|
46610
|
+
}
|
|
46611
|
+
|
|
46612
|
+
return this.apiClient.callApi(
|
|
46613
|
+
'/api/v2/voicemail/userpolicies/{userId}',
|
|
46614
|
+
'PUT',
|
|
46615
|
+
{ 'userId': userId },
|
|
46616
|
+
{ },
|
|
46617
|
+
{ },
|
|
46618
|
+
{ },
|
|
46619
|
+
body,
|
|
46620
|
+
['PureCloud OAuth'],
|
|
46621
|
+
['application/json'],
|
|
46622
|
+
['application/json']
|
|
46623
|
+
);
|
|
46624
|
+
}
|
|
46625
|
+
|
|
46286
46626
|
}
|
|
46287
46627
|
|
|
46288
46628
|
class WebChatApi {
|
|
46289
46629
|
/**
|
|
46290
46630
|
* WebChat service.
|
|
46291
46631
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
46292
|
-
* @version
|
|
46632
|
+
* @version 126.0.0
|
|
46293
46633
|
*/
|
|
46294
46634
|
|
|
46295
46635
|
/**
|
|
@@ -46833,7 +47173,7 @@ class WebDeploymentsApi {
|
|
|
46833
47173
|
/**
|
|
46834
47174
|
* WebDeployments service.
|
|
46835
47175
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
46836
|
-
* @version
|
|
47176
|
+
* @version 126.0.0
|
|
46837
47177
|
*/
|
|
46838
47178
|
|
|
46839
47179
|
/**
|
|
@@ -47184,11 +47524,57 @@ class WebDeploymentsApi {
|
|
|
47184
47524
|
|
|
47185
47525
|
}
|
|
47186
47526
|
|
|
47527
|
+
class WebMessagingApi {
|
|
47528
|
+
/**
|
|
47529
|
+
* WebMessaging service.
|
|
47530
|
+
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
47531
|
+
* @version 126.0.0
|
|
47532
|
+
*/
|
|
47533
|
+
|
|
47534
|
+
/**
|
|
47535
|
+
* Constructs a new WebMessagingApi.
|
|
47536
|
+
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
47537
|
+
* @class
|
|
47538
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
47539
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
47540
|
+
*/
|
|
47541
|
+
constructor(apiClient) {
|
|
47542
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
47543
|
+
}
|
|
47544
|
+
|
|
47545
|
+
|
|
47546
|
+
/**
|
|
47547
|
+
* Get the messages for a web messaging session.
|
|
47548
|
+
*
|
|
47549
|
+
* @param {Object} opts Optional parameters
|
|
47550
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
47551
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
47552
|
+
*/
|
|
47553
|
+
getWebmessagingMessages(opts) {
|
|
47554
|
+
opts = opts || {};
|
|
47555
|
+
|
|
47556
|
+
|
|
47557
|
+
return this.apiClient.callApi(
|
|
47558
|
+
'/api/v2/webmessaging/messages',
|
|
47559
|
+
'GET',
|
|
47560
|
+
{ },
|
|
47561
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
47562
|
+
{ },
|
|
47563
|
+
{ },
|
|
47564
|
+
null,
|
|
47565
|
+
['PureCloud OAuth'],
|
|
47566
|
+
['application/json'],
|
|
47567
|
+
['application/json']
|
|
47568
|
+
);
|
|
47569
|
+
}
|
|
47570
|
+
|
|
47571
|
+
}
|
|
47572
|
+
|
|
47187
47573
|
class WidgetsApi {
|
|
47188
47574
|
/**
|
|
47189
47575
|
* Widgets service.
|
|
47190
47576
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
47191
|
-
* @version
|
|
47577
|
+
* @version 126.0.0
|
|
47192
47578
|
*/
|
|
47193
47579
|
|
|
47194
47580
|
/**
|
|
@@ -47334,7 +47720,7 @@ class WorkforceManagementApi {
|
|
|
47334
47720
|
/**
|
|
47335
47721
|
* WorkforceManagement service.
|
|
47336
47722
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
47337
|
-
* @version
|
|
47723
|
+
* @version 126.0.0
|
|
47338
47724
|
*/
|
|
47339
47725
|
|
|
47340
47726
|
/**
|
|
@@ -47609,6 +47995,66 @@ class WorkforceManagementApi {
|
|
|
47609
47995
|
);
|
|
47610
47996
|
}
|
|
47611
47997
|
|
|
47998
|
+
/**
|
|
47999
|
+
* Deletes a time off limit object
|
|
48000
|
+
*
|
|
48001
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
48002
|
+
* @param {String} timeOffLimitId The ID of the time off limit object to delete
|
|
48003
|
+
*/
|
|
48004
|
+
deleteWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
48005
|
+
// verify the required parameter 'managementUnitId' is set
|
|
48006
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
48007
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitTimeofflimit';
|
|
48008
|
+
}
|
|
48009
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
48010
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
48011
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling deleteWorkforcemanagementManagementunitTimeofflimit';
|
|
48012
|
+
}
|
|
48013
|
+
|
|
48014
|
+
return this.apiClient.callApi(
|
|
48015
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
48016
|
+
'DELETE',
|
|
48017
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
48018
|
+
{ },
|
|
48019
|
+
{ },
|
|
48020
|
+
{ },
|
|
48021
|
+
null,
|
|
48022
|
+
['PureCloud OAuth'],
|
|
48023
|
+
['application/json'],
|
|
48024
|
+
['application/json']
|
|
48025
|
+
);
|
|
48026
|
+
}
|
|
48027
|
+
|
|
48028
|
+
/**
|
|
48029
|
+
* Deletes a time off plan
|
|
48030
|
+
*
|
|
48031
|
+
* @param {String} managementUnitId The management unit ID.
|
|
48032
|
+
* @param {String} timeOffPlanId The ID of the time off plan to delete
|
|
48033
|
+
*/
|
|
48034
|
+
deleteWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
48035
|
+
// verify the required parameter 'managementUnitId' is set
|
|
48036
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
48037
|
+
throw 'Missing the required parameter "managementUnitId" when calling deleteWorkforcemanagementManagementunitTimeoffplan';
|
|
48038
|
+
}
|
|
48039
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
48040
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
48041
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling deleteWorkforcemanagementManagementunitTimeoffplan';
|
|
48042
|
+
}
|
|
48043
|
+
|
|
48044
|
+
return this.apiClient.callApi(
|
|
48045
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
48046
|
+
'DELETE',
|
|
48047
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
48048
|
+
{ },
|
|
48049
|
+
{ },
|
|
48050
|
+
{ },
|
|
48051
|
+
null,
|
|
48052
|
+
['PureCloud OAuth'],
|
|
48053
|
+
['application/json'],
|
|
48054
|
+
['application/json']
|
|
48055
|
+
);
|
|
48056
|
+
}
|
|
48057
|
+
|
|
47612
48058
|
/**
|
|
47613
48059
|
* Delete a work plan
|
|
47614
48060
|
*
|
|
@@ -48850,6 +49296,116 @@ class WorkforceManagementApi {
|
|
|
48850
49296
|
);
|
|
48851
49297
|
}
|
|
48852
49298
|
|
|
49299
|
+
/**
|
|
49300
|
+
* Gets a time off limit object
|
|
49301
|
+
* Returns properties of time off limit object, but not daily values.
|
|
49302
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
49303
|
+
* @param {String} timeOffLimitId The ID of the time off limit to fetch
|
|
49304
|
+
*/
|
|
49305
|
+
getWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
|
|
49306
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49307
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49308
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeofflimit';
|
|
49309
|
+
}
|
|
49310
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
49311
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
49312
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling getWorkforcemanagementManagementunitTimeofflimit';
|
|
49313
|
+
}
|
|
49314
|
+
|
|
49315
|
+
return this.apiClient.callApi(
|
|
49316
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
49317
|
+
'GET',
|
|
49318
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
49319
|
+
{ },
|
|
49320
|
+
{ },
|
|
49321
|
+
{ },
|
|
49322
|
+
null,
|
|
49323
|
+
['PureCloud OAuth'],
|
|
49324
|
+
['application/json'],
|
|
49325
|
+
['application/json']
|
|
49326
|
+
);
|
|
49327
|
+
}
|
|
49328
|
+
|
|
49329
|
+
/**
|
|
49330
|
+
* Gets a list of time off limit objects under management unit.
|
|
49331
|
+
* Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.
|
|
49332
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
49333
|
+
*/
|
|
49334
|
+
getWorkforcemanagementManagementunitTimeofflimits(managementUnitId) {
|
|
49335
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49336
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49337
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeofflimits';
|
|
49338
|
+
}
|
|
49339
|
+
|
|
49340
|
+
return this.apiClient.callApi(
|
|
49341
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits',
|
|
49342
|
+
'GET',
|
|
49343
|
+
{ 'managementUnitId': managementUnitId },
|
|
49344
|
+
{ },
|
|
49345
|
+
{ },
|
|
49346
|
+
{ },
|
|
49347
|
+
null,
|
|
49348
|
+
['PureCloud OAuth'],
|
|
49349
|
+
['application/json'],
|
|
49350
|
+
['application/json']
|
|
49351
|
+
);
|
|
49352
|
+
}
|
|
49353
|
+
|
|
49354
|
+
/**
|
|
49355
|
+
* Gets a time off plan
|
|
49356
|
+
*
|
|
49357
|
+
* @param {String} managementUnitId The management unit ID.
|
|
49358
|
+
* @param {String} timeOffPlanId The ID of the time off plan to fetch
|
|
49359
|
+
*/
|
|
49360
|
+
getWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
|
|
49361
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49362
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49363
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeoffplan';
|
|
49364
|
+
}
|
|
49365
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
49366
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
49367
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling getWorkforcemanagementManagementunitTimeoffplan';
|
|
49368
|
+
}
|
|
49369
|
+
|
|
49370
|
+
return this.apiClient.callApi(
|
|
49371
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
49372
|
+
'GET',
|
|
49373
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
49374
|
+
{ },
|
|
49375
|
+
{ },
|
|
49376
|
+
{ },
|
|
49377
|
+
null,
|
|
49378
|
+
['PureCloud OAuth'],
|
|
49379
|
+
['application/json'],
|
|
49380
|
+
['application/json']
|
|
49381
|
+
);
|
|
49382
|
+
}
|
|
49383
|
+
|
|
49384
|
+
/**
|
|
49385
|
+
* Gets a list of time off plans
|
|
49386
|
+
*
|
|
49387
|
+
* @param {String} managementUnitId The management unit ID.
|
|
49388
|
+
*/
|
|
49389
|
+
getWorkforcemanagementManagementunitTimeoffplans(managementUnitId) {
|
|
49390
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49391
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49392
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitTimeoffplans';
|
|
49393
|
+
}
|
|
49394
|
+
|
|
49395
|
+
return this.apiClient.callApi(
|
|
49396
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans',
|
|
49397
|
+
'GET',
|
|
49398
|
+
{ 'managementUnitId': managementUnitId },
|
|
49399
|
+
{ },
|
|
49400
|
+
{ },
|
|
49401
|
+
{ },
|
|
49402
|
+
null,
|
|
49403
|
+
['PureCloud OAuth'],
|
|
49404
|
+
['application/json'],
|
|
49405
|
+
['application/json']
|
|
49406
|
+
);
|
|
49407
|
+
}
|
|
49408
|
+
|
|
48853
49409
|
/**
|
|
48854
49410
|
* Get a time off request
|
|
48855
49411
|
*
|
|
@@ -48885,6 +49441,41 @@ class WorkforceManagementApi {
|
|
|
48885
49441
|
);
|
|
48886
49442
|
}
|
|
48887
49443
|
|
|
49444
|
+
/**
|
|
49445
|
+
* Retrieves time off limit, allocated and waitlisted values according to specific time off request
|
|
49446
|
+
*
|
|
49447
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
49448
|
+
* @param {String} userId The userId to whom the time off request applies.
|
|
49449
|
+
* @param {String} timeOffRequestId The ID of the time off request, which dates and activityCodeId determine limit values to retrieve
|
|
49450
|
+
*/
|
|
49451
|
+
getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits(managementUnitId, userId, timeOffRequestId) {
|
|
49452
|
+
// verify the required parameter 'managementUnitId' is set
|
|
49453
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
49454
|
+
throw 'Missing the required parameter "managementUnitId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
49455
|
+
}
|
|
49456
|
+
// verify the required parameter 'userId' is set
|
|
49457
|
+
if (userId === undefined || userId === null) {
|
|
49458
|
+
throw 'Missing the required parameter "userId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
49459
|
+
}
|
|
49460
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
49461
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
49462
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementManagementunitUserTimeoffrequestTimeofflimits';
|
|
49463
|
+
}
|
|
49464
|
+
|
|
49465
|
+
return this.apiClient.callApi(
|
|
49466
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeofflimits',
|
|
49467
|
+
'GET',
|
|
49468
|
+
{ 'managementUnitId': managementUnitId,'userId': userId,'timeOffRequestId': timeOffRequestId },
|
|
49469
|
+
{ },
|
|
49470
|
+
{ },
|
|
49471
|
+
{ },
|
|
49472
|
+
null,
|
|
49473
|
+
['PureCloud OAuth'],
|
|
49474
|
+
['application/json'],
|
|
49475
|
+
['application/json']
|
|
49476
|
+
);
|
|
49477
|
+
}
|
|
49478
|
+
|
|
48888
49479
|
/**
|
|
48889
49480
|
* Get a list of time off requests for a given user
|
|
48890
49481
|
*
|
|
@@ -49318,6 +49909,31 @@ class WorkforceManagementApi {
|
|
|
49318
49909
|
);
|
|
49319
49910
|
}
|
|
49320
49911
|
|
|
49912
|
+
/**
|
|
49913
|
+
* Get the daily waitlist positions of a time off request for the current user
|
|
49914
|
+
*
|
|
49915
|
+
* @param {String} timeOffRequestId Time Off Request Id
|
|
49916
|
+
*/
|
|
49917
|
+
getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId) {
|
|
49918
|
+
// verify the required parameter 'timeOffRequestId' is set
|
|
49919
|
+
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
49920
|
+
throw 'Missing the required parameter "timeOffRequestId" when calling getWorkforcemanagementTimeoffrequestWaitlistpositions';
|
|
49921
|
+
}
|
|
49922
|
+
|
|
49923
|
+
return this.apiClient.callApi(
|
|
49924
|
+
'/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}/waitlistpositions',
|
|
49925
|
+
'GET',
|
|
49926
|
+
{ 'timeOffRequestId': timeOffRequestId },
|
|
49927
|
+
{ },
|
|
49928
|
+
{ },
|
|
49929
|
+
{ },
|
|
49930
|
+
null,
|
|
49931
|
+
['PureCloud OAuth'],
|
|
49932
|
+
['application/json'],
|
|
49933
|
+
['application/json']
|
|
49934
|
+
);
|
|
49935
|
+
}
|
|
49936
|
+
|
|
49321
49937
|
/**
|
|
49322
49938
|
* Get a list of time off requests for the current user
|
|
49323
49939
|
*
|
|
@@ -49536,6 +50152,74 @@ class WorkforceManagementApi {
|
|
|
49536
50152
|
);
|
|
49537
50153
|
}
|
|
49538
50154
|
|
|
50155
|
+
/**
|
|
50156
|
+
* Updates a time off limit object.
|
|
50157
|
+
* Updates time off limit object properties, but not daily values.
|
|
50158
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
50159
|
+
* @param {String} timeOffLimitId The id of time off limit object to update
|
|
50160
|
+
* @param {Object} opts Optional parameters
|
|
50161
|
+
* @param {Object} opts.body body
|
|
50162
|
+
*/
|
|
50163
|
+
patchWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId, opts) {
|
|
50164
|
+
opts = opts || {};
|
|
50165
|
+
|
|
50166
|
+
// verify the required parameter 'managementUnitId' is set
|
|
50167
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
50168
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
50169
|
+
}
|
|
50170
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
50171
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
50172
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
50173
|
+
}
|
|
50174
|
+
|
|
50175
|
+
return this.apiClient.callApi(
|
|
50176
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
50177
|
+
'PATCH',
|
|
50178
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
50179
|
+
{ },
|
|
50180
|
+
{ },
|
|
50181
|
+
{ },
|
|
50182
|
+
opts['body'],
|
|
50183
|
+
['PureCloud OAuth'],
|
|
50184
|
+
['application/json'],
|
|
50185
|
+
['application/json']
|
|
50186
|
+
);
|
|
50187
|
+
}
|
|
50188
|
+
|
|
50189
|
+
/**
|
|
50190
|
+
* Updates a time off plan
|
|
50191
|
+
*
|
|
50192
|
+
* @param {String} managementUnitId The management unit ID.
|
|
50193
|
+
* @param {String} timeOffPlanId The ID of the time off plan to update
|
|
50194
|
+
* @param {Object} opts Optional parameters
|
|
50195
|
+
* @param {Object} opts.body body
|
|
50196
|
+
*/
|
|
50197
|
+
patchWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId, opts) {
|
|
50198
|
+
opts = opts || {};
|
|
50199
|
+
|
|
50200
|
+
// verify the required parameter 'managementUnitId' is set
|
|
50201
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
50202
|
+
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
50203
|
+
}
|
|
50204
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
50205
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
50206
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
50207
|
+
}
|
|
50208
|
+
|
|
50209
|
+
return this.apiClient.callApi(
|
|
50210
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
50211
|
+
'PATCH',
|
|
50212
|
+
{ 'managementUnitId': managementUnitId,'timeOffPlanId': timeOffPlanId },
|
|
50213
|
+
{ },
|
|
50214
|
+
{ },
|
|
50215
|
+
{ },
|
|
50216
|
+
opts['body'],
|
|
50217
|
+
['PureCloud OAuth'],
|
|
50218
|
+
['application/json'],
|
|
50219
|
+
['application/json']
|
|
50220
|
+
);
|
|
50221
|
+
}
|
|
50222
|
+
|
|
49539
50223
|
/**
|
|
49540
50224
|
* Update a time off request
|
|
49541
50225
|
*
|
|
@@ -50397,6 +51081,93 @@ class WorkforceManagementApi {
|
|
|
50397
51081
|
);
|
|
50398
51082
|
}
|
|
50399
51083
|
|
|
51084
|
+
/**
|
|
51085
|
+
* Creates a new time off limit object under management unit.
|
|
51086
|
+
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
51087
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51088
|
+
* @param {Object} opts Optional parameters
|
|
51089
|
+
* @param {Object} opts.body body
|
|
51090
|
+
*/
|
|
51091
|
+
postWorkforcemanagementManagementunitTimeofflimits(managementUnitId, opts) {
|
|
51092
|
+
opts = opts || {};
|
|
51093
|
+
|
|
51094
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51095
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51096
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimits';
|
|
51097
|
+
}
|
|
51098
|
+
|
|
51099
|
+
return this.apiClient.callApi(
|
|
51100
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits',
|
|
51101
|
+
'POST',
|
|
51102
|
+
{ 'managementUnitId': managementUnitId },
|
|
51103
|
+
{ },
|
|
51104
|
+
{ },
|
|
51105
|
+
{ },
|
|
51106
|
+
opts['body'],
|
|
51107
|
+
['PureCloud OAuth'],
|
|
51108
|
+
['application/json'],
|
|
51109
|
+
['application/json']
|
|
51110
|
+
);
|
|
51111
|
+
}
|
|
51112
|
+
|
|
51113
|
+
/**
|
|
51114
|
+
* Retrieves time off limit related values based on a given set of filters.
|
|
51115
|
+
*
|
|
51116
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51117
|
+
* @param {Object} opts Optional parameters
|
|
51118
|
+
* @param {Object} opts.body body
|
|
51119
|
+
*/
|
|
51120
|
+
postWorkforcemanagementManagementunitTimeofflimitsValuesQuery(managementUnitId, opts) {
|
|
51121
|
+
opts = opts || {};
|
|
51122
|
+
|
|
51123
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51124
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51125
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimitsValuesQuery';
|
|
51126
|
+
}
|
|
51127
|
+
|
|
51128
|
+
return this.apiClient.callApi(
|
|
51129
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/values/query',
|
|
51130
|
+
'POST',
|
|
51131
|
+
{ 'managementUnitId': managementUnitId },
|
|
51132
|
+
{ },
|
|
51133
|
+
{ },
|
|
51134
|
+
{ },
|
|
51135
|
+
opts['body'],
|
|
51136
|
+
['PureCloud OAuth'],
|
|
51137
|
+
['application/json'],
|
|
51138
|
+
['application/json']
|
|
51139
|
+
);
|
|
51140
|
+
}
|
|
51141
|
+
|
|
51142
|
+
/**
|
|
51143
|
+
* Creates a new time off plan
|
|
51144
|
+
*
|
|
51145
|
+
* @param {String} managementUnitId The management unit ID.
|
|
51146
|
+
* @param {Object} opts Optional parameters
|
|
51147
|
+
* @param {Object} opts.body body
|
|
51148
|
+
*/
|
|
51149
|
+
postWorkforcemanagementManagementunitTimeoffplans(managementUnitId, opts) {
|
|
51150
|
+
opts = opts || {};
|
|
51151
|
+
|
|
51152
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51153
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51154
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffplans';
|
|
51155
|
+
}
|
|
51156
|
+
|
|
51157
|
+
return this.apiClient.callApi(
|
|
51158
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans',
|
|
51159
|
+
'POST',
|
|
51160
|
+
{ 'managementUnitId': managementUnitId },
|
|
51161
|
+
{ },
|
|
51162
|
+
{ },
|
|
51163
|
+
{ },
|
|
51164
|
+
opts['body'],
|
|
51165
|
+
['PureCloud OAuth'],
|
|
51166
|
+
['application/json'],
|
|
51167
|
+
['application/json']
|
|
51168
|
+
);
|
|
51169
|
+
}
|
|
51170
|
+
|
|
50400
51171
|
/**
|
|
50401
51172
|
* Create a new time off request
|
|
50402
51173
|
*
|
|
@@ -50455,6 +51226,35 @@ class WorkforceManagementApi {
|
|
|
50455
51226
|
);
|
|
50456
51227
|
}
|
|
50457
51228
|
|
|
51229
|
+
/**
|
|
51230
|
+
* Retrieves daily waitlist position for a list of time off requests
|
|
51231
|
+
*
|
|
51232
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51233
|
+
* @param {Object} opts Optional parameters
|
|
51234
|
+
* @param {Object} opts.body body
|
|
51235
|
+
*/
|
|
51236
|
+
postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery(managementUnitId, opts) {
|
|
51237
|
+
opts = opts || {};
|
|
51238
|
+
|
|
51239
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51240
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51241
|
+
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery';
|
|
51242
|
+
}
|
|
51243
|
+
|
|
51244
|
+
return this.apiClient.callApi(
|
|
51245
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/waitlistpositions/query',
|
|
51246
|
+
'POST',
|
|
51247
|
+
{ 'managementUnitId': managementUnitId },
|
|
51248
|
+
{ },
|
|
51249
|
+
{ },
|
|
51250
|
+
{ },
|
|
51251
|
+
opts['body'],
|
|
51252
|
+
['PureCloud OAuth'],
|
|
51253
|
+
['application/json'],
|
|
51254
|
+
['application/json']
|
|
51255
|
+
);
|
|
51256
|
+
}
|
|
51257
|
+
|
|
50458
51258
|
/**
|
|
50459
51259
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
50460
51260
|
*
|
|
@@ -50838,6 +51638,30 @@ class WorkforceManagementApi {
|
|
|
50838
51638
|
);
|
|
50839
51639
|
}
|
|
50840
51640
|
|
|
51641
|
+
/**
|
|
51642
|
+
* Queries available time off for the current user
|
|
51643
|
+
*
|
|
51644
|
+
* @param {Object} opts Optional parameters
|
|
51645
|
+
* @param {Object} opts.body body
|
|
51646
|
+
*/
|
|
51647
|
+
postWorkforcemanagementTimeofflimitsAvailableQuery(opts) {
|
|
51648
|
+
opts = opts || {};
|
|
51649
|
+
|
|
51650
|
+
|
|
51651
|
+
return this.apiClient.callApi(
|
|
51652
|
+
'/api/v2/workforcemanagement/timeofflimits/available/query',
|
|
51653
|
+
'POST',
|
|
51654
|
+
{ },
|
|
51655
|
+
{ },
|
|
51656
|
+
{ },
|
|
51657
|
+
{ },
|
|
51658
|
+
opts['body'],
|
|
51659
|
+
['PureCloud OAuth'],
|
|
51660
|
+
['application/json'],
|
|
51661
|
+
['application/json']
|
|
51662
|
+
);
|
|
51663
|
+
}
|
|
51664
|
+
|
|
50841
51665
|
/**
|
|
50842
51666
|
* Create a time off request for the current user
|
|
50843
51667
|
*
|
|
@@ -50862,6 +51686,40 @@ class WorkforceManagementApi {
|
|
|
50862
51686
|
);
|
|
50863
51687
|
}
|
|
50864
51688
|
|
|
51689
|
+
/**
|
|
51690
|
+
* Sets daily values for a date range of time off limit object
|
|
51691
|
+
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
51692
|
+
* @param {String} managementUnitId The management unit ID of the management unit.
|
|
51693
|
+
* @param {String} timeOffLimitId The ID of the time off limit object to set values for
|
|
51694
|
+
* @param {Object} opts Optional parameters
|
|
51695
|
+
* @param {Object} opts.body body
|
|
51696
|
+
*/
|
|
51697
|
+
putWorkforcemanagementManagementunitTimeofflimitValues(managementUnitId, timeOffLimitId, opts) {
|
|
51698
|
+
opts = opts || {};
|
|
51699
|
+
|
|
51700
|
+
// verify the required parameter 'managementUnitId' is set
|
|
51701
|
+
if (managementUnitId === undefined || managementUnitId === null) {
|
|
51702
|
+
throw 'Missing the required parameter "managementUnitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
51703
|
+
}
|
|
51704
|
+
// verify the required parameter 'timeOffLimitId' is set
|
|
51705
|
+
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
51706
|
+
throw 'Missing the required parameter "timeOffLimitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
51707
|
+
}
|
|
51708
|
+
|
|
51709
|
+
return this.apiClient.callApi(
|
|
51710
|
+
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}/values',
|
|
51711
|
+
'PUT',
|
|
51712
|
+
{ 'managementUnitId': managementUnitId,'timeOffLimitId': timeOffLimitId },
|
|
51713
|
+
{ },
|
|
51714
|
+
{ },
|
|
51715
|
+
{ },
|
|
51716
|
+
opts['body'],
|
|
51717
|
+
['PureCloud OAuth'],
|
|
51718
|
+
['application/json'],
|
|
51719
|
+
['application/json']
|
|
51720
|
+
);
|
|
51721
|
+
}
|
|
51722
|
+
|
|
50865
51723
|
}
|
|
50866
51724
|
|
|
50867
51725
|
/**
|
|
@@ -50893,7 +51751,7 @@ class WorkforceManagementApi {
|
|
|
50893
51751
|
* </pre>
|
|
50894
51752
|
* </p>
|
|
50895
51753
|
* @module purecloud-platform-client-v2/index
|
|
50896
|
-
* @version
|
|
51754
|
+
* @version 126.0.0
|
|
50897
51755
|
*/
|
|
50898
51756
|
class platformClient {
|
|
50899
51757
|
constructor() {
|
|
@@ -51197,6 +52055,11 @@ class platformClient {
|
|
|
51197
52055
|
* @property {module:purecloud-platform-client-v2/api/WebDeploymentsApi}
|
|
51198
52056
|
*/
|
|
51199
52057
|
this.WebDeploymentsApi = WebDeploymentsApi;
|
|
52058
|
+
/**
|
|
52059
|
+
* The WebMessagingApi service constructor.
|
|
52060
|
+
* @property {module:purecloud-platform-client-v2/api/WebMessagingApi}
|
|
52061
|
+
*/
|
|
52062
|
+
this.WebMessagingApi = WebMessagingApi;
|
|
51200
52063
|
/**
|
|
51201
52064
|
* The WidgetsApi service constructor.
|
|
51202
52065
|
* @property {module:purecloud-platform-client-v2/api/WidgetsApi}
|