purecloud-platform-client-v2 185.0.0 → 187.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/node/purecloud-platform-client-v2.js +1019 -245
- package/dist/web-amd/purecloud-platform-client-v2.js +1019 -245
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +357 -172
- package/dist/web-cjs/purecloud-platform-client-v2.js +362 -174
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +674 -222
- package/package.json +2 -2
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +25 -7
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +2 -3
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +61 -22
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -62
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +38 -3
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +7 -7
- 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 +106 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +161 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -34
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +63 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- 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/LogCaptureApi.js +131 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.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 +2 -3
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +186 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +11 -6
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.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 +80 -2
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +50 -0
- 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/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- 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/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -3
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +3 -29
- 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 +32 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/index.js +7 -1
|
@@ -5,7 +5,7 @@ class IdentityProviderApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* IdentityProvider service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 187.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -20,6 +20,31 @@ class IdentityProviderApi {
|
|
|
20
20
|
}
|
|
21
21
|
|
|
22
22
|
|
|
23
|
+
/**
|
|
24
|
+
* Delete Identity Provider
|
|
25
|
+
*
|
|
26
|
+
* @param {String} providerId Provider ID
|
|
27
|
+
*/
|
|
28
|
+
deleteIdentityprovider(providerId) {
|
|
29
|
+
// verify the required parameter 'providerId' is set
|
|
30
|
+
if (providerId === undefined || providerId === null) {
|
|
31
|
+
throw 'Missing the required parameter "providerId" when calling deleteIdentityprovider';
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
return this.apiClient.callApi(
|
|
35
|
+
'/api/v2/identityproviders/{providerId}',
|
|
36
|
+
'DELETE',
|
|
37
|
+
{ 'providerId': providerId },
|
|
38
|
+
{ },
|
|
39
|
+
{ },
|
|
40
|
+
{ },
|
|
41
|
+
null,
|
|
42
|
+
['PureCloud OAuth'],
|
|
43
|
+
['application/json'],
|
|
44
|
+
['application/json']
|
|
45
|
+
);
|
|
46
|
+
}
|
|
47
|
+
|
|
23
48
|
/**
|
|
24
49
|
* Delete ADFS Identity Provider
|
|
25
50
|
*
|
|
@@ -240,6 +265,31 @@ class IdentityProviderApi {
|
|
|
240
265
|
);
|
|
241
266
|
}
|
|
242
267
|
|
|
268
|
+
/**
|
|
269
|
+
* Get Identity Provider
|
|
270
|
+
*
|
|
271
|
+
* @param {String} providerId Provider ID
|
|
272
|
+
*/
|
|
273
|
+
getIdentityprovider(providerId) {
|
|
274
|
+
// verify the required parameter 'providerId' is set
|
|
275
|
+
if (providerId === undefined || providerId === null) {
|
|
276
|
+
throw 'Missing the required parameter "providerId" when calling getIdentityprovider';
|
|
277
|
+
}
|
|
278
|
+
|
|
279
|
+
return this.apiClient.callApi(
|
|
280
|
+
'/api/v2/identityproviders/{providerId}',
|
|
281
|
+
'GET',
|
|
282
|
+
{ 'providerId': providerId },
|
|
283
|
+
{ },
|
|
284
|
+
{ },
|
|
285
|
+
{ },
|
|
286
|
+
null,
|
|
287
|
+
['PureCloud OAuth'],
|
|
288
|
+
['application/json'],
|
|
289
|
+
['application/json']
|
|
290
|
+
);
|
|
291
|
+
}
|
|
292
|
+
|
|
243
293
|
/**
|
|
244
294
|
* The list of identity providers
|
|
245
295
|
*
|
|
@@ -480,6 +530,61 @@ class IdentityProviderApi {
|
|
|
480
530
|
);
|
|
481
531
|
}
|
|
482
532
|
|
|
533
|
+
/**
|
|
534
|
+
* Create Identity Provider
|
|
535
|
+
*
|
|
536
|
+
* @param {Object} body Provider
|
|
537
|
+
*/
|
|
538
|
+
postIdentityproviders(body) {
|
|
539
|
+
// verify the required parameter 'body' is set
|
|
540
|
+
if (body === undefined || body === null) {
|
|
541
|
+
throw 'Missing the required parameter "body" when calling postIdentityproviders';
|
|
542
|
+
}
|
|
543
|
+
|
|
544
|
+
return this.apiClient.callApi(
|
|
545
|
+
'/api/v2/identityproviders',
|
|
546
|
+
'POST',
|
|
547
|
+
{ },
|
|
548
|
+
{ },
|
|
549
|
+
{ },
|
|
550
|
+
{ },
|
|
551
|
+
body,
|
|
552
|
+
['PureCloud OAuth'],
|
|
553
|
+
['application/json'],
|
|
554
|
+
['application/json']
|
|
555
|
+
);
|
|
556
|
+
}
|
|
557
|
+
|
|
558
|
+
/**
|
|
559
|
+
* Update Identity Provider
|
|
560
|
+
*
|
|
561
|
+
* @param {String} providerId Provider ID
|
|
562
|
+
* @param {Object} body Provider
|
|
563
|
+
*/
|
|
564
|
+
putIdentityprovider(providerId, body) {
|
|
565
|
+
// verify the required parameter 'providerId' is set
|
|
566
|
+
if (providerId === undefined || providerId === null) {
|
|
567
|
+
throw 'Missing the required parameter "providerId" when calling putIdentityprovider';
|
|
568
|
+
}
|
|
569
|
+
// verify the required parameter 'body' is set
|
|
570
|
+
if (body === undefined || body === null) {
|
|
571
|
+
throw 'Missing the required parameter "body" when calling putIdentityprovider';
|
|
572
|
+
}
|
|
573
|
+
|
|
574
|
+
return this.apiClient.callApi(
|
|
575
|
+
'/api/v2/identityproviders/{providerId}',
|
|
576
|
+
'PUT',
|
|
577
|
+
{ 'providerId': providerId },
|
|
578
|
+
{ },
|
|
579
|
+
{ },
|
|
580
|
+
{ },
|
|
581
|
+
body,
|
|
582
|
+
['PureCloud OAuth'],
|
|
583
|
+
['application/json'],
|
|
584
|
+
['application/json']
|
|
585
|
+
);
|
|
586
|
+
}
|
|
587
|
+
|
|
483
588
|
/**
|
|
484
589
|
* Update/Create ADFS Identity Provider
|
|
485
590
|
*
|
|
@@ -5,7 +5,7 @@ class IntegrationsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Integrations service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 187.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -268,6 +268,32 @@ class IntegrationsApi {
|
|
|
268
268
|
);
|
|
269
269
|
}
|
|
270
270
|
|
|
271
|
+
/**
|
|
272
|
+
* Get draft function settings for Action
|
|
273
|
+
*
|
|
274
|
+
* @param {String} actionId actionId
|
|
275
|
+
* getIntegrationsActionDraftFunction is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
276
|
+
*/
|
|
277
|
+
getIntegrationsActionDraftFunction(actionId) {
|
|
278
|
+
// verify the required parameter 'actionId' is set
|
|
279
|
+
if (actionId === undefined || actionId === null) {
|
|
280
|
+
throw 'Missing the required parameter "actionId" when calling getIntegrationsActionDraftFunction';
|
|
281
|
+
}
|
|
282
|
+
|
|
283
|
+
return this.apiClient.callApi(
|
|
284
|
+
'/api/v2/integrations/actions/{actionId}/draft/function',
|
|
285
|
+
'GET',
|
|
286
|
+
{ 'actionId': actionId },
|
|
287
|
+
{ },
|
|
288
|
+
{ },
|
|
289
|
+
{ },
|
|
290
|
+
null,
|
|
291
|
+
['PureCloud OAuth'],
|
|
292
|
+
['application/json'],
|
|
293
|
+
['application/json']
|
|
294
|
+
);
|
|
295
|
+
}
|
|
296
|
+
|
|
271
297
|
/**
|
|
272
298
|
* Retrieve schema for a Draft based on filename.
|
|
273
299
|
*
|
|
@@ -353,6 +379,32 @@ class IntegrationsApi {
|
|
|
353
379
|
);
|
|
354
380
|
}
|
|
355
381
|
|
|
382
|
+
/**
|
|
383
|
+
* Get published function settings for Action
|
|
384
|
+
*
|
|
385
|
+
* @param {String} actionId actionId
|
|
386
|
+
* getIntegrationsActionFunction is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
387
|
+
*/
|
|
388
|
+
getIntegrationsActionFunction(actionId) {
|
|
389
|
+
// verify the required parameter 'actionId' is set
|
|
390
|
+
if (actionId === undefined || actionId === null) {
|
|
391
|
+
throw 'Missing the required parameter "actionId" when calling getIntegrationsActionFunction';
|
|
392
|
+
}
|
|
393
|
+
|
|
394
|
+
return this.apiClient.callApi(
|
|
395
|
+
'/api/v2/integrations/actions/{actionId}/function',
|
|
396
|
+
'GET',
|
|
397
|
+
{ 'actionId': actionId },
|
|
398
|
+
{ },
|
|
399
|
+
{ },
|
|
400
|
+
{ },
|
|
401
|
+
null,
|
|
402
|
+
['PureCloud OAuth'],
|
|
403
|
+
['application/json'],
|
|
404
|
+
['application/json']
|
|
405
|
+
);
|
|
406
|
+
}
|
|
407
|
+
|
|
356
408
|
/**
|
|
357
409
|
* Retrieve schema for an action based on filename.
|
|
358
410
|
*
|
|
@@ -477,6 +529,31 @@ class IntegrationsApi {
|
|
|
477
529
|
);
|
|
478
530
|
}
|
|
479
531
|
|
|
532
|
+
/**
|
|
533
|
+
* Retrieves the available mTLS client certificates in use. This endpoint will return inconsistent results while a certificate rotation is in progress.
|
|
534
|
+
*
|
|
535
|
+
* @param {Object} opts Optional parameters
|
|
536
|
+
* @param {Object} opts.status Indicates the validity of the certificate in question.
|
|
537
|
+
* @param {Object} opts.type Indicates the type of the certificate.
|
|
538
|
+
*/
|
|
539
|
+
getIntegrationsActionsCertificates(opts) {
|
|
540
|
+
opts = opts || {};
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
return this.apiClient.callApi(
|
|
544
|
+
'/api/v2/integrations/actions/certificates',
|
|
545
|
+
'GET',
|
|
546
|
+
{ },
|
|
547
|
+
{ 'status': opts['status'],'type': opts['type'] },
|
|
548
|
+
{ },
|
|
549
|
+
{ },
|
|
550
|
+
null,
|
|
551
|
+
['PureCloud OAuth'],
|
|
552
|
+
['application/json'],
|
|
553
|
+
['application/json']
|
|
554
|
+
);
|
|
555
|
+
}
|
|
556
|
+
|
|
480
557
|
/**
|
|
481
558
|
* Retrieves all action drafts associated with the filters passed in via query param.
|
|
482
559
|
*
|
|
@@ -511,6 +588,27 @@ class IntegrationsApi {
|
|
|
511
588
|
);
|
|
512
589
|
}
|
|
513
590
|
|
|
591
|
+
/**
|
|
592
|
+
* Get action function settings for Action
|
|
593
|
+
*
|
|
594
|
+
* getIntegrationsActionsFunctionsRuntimes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
595
|
+
*/
|
|
596
|
+
getIntegrationsActionsFunctionsRuntimes() {
|
|
597
|
+
|
|
598
|
+
return this.apiClient.callApi(
|
|
599
|
+
'/api/v2/integrations/actions/functions/runtimes',
|
|
600
|
+
'GET',
|
|
601
|
+
{ },
|
|
602
|
+
{ },
|
|
603
|
+
{ },
|
|
604
|
+
{ },
|
|
605
|
+
null,
|
|
606
|
+
['PureCloud OAuth'],
|
|
607
|
+
['application/json'],
|
|
608
|
+
['application/json']
|
|
609
|
+
);
|
|
610
|
+
}
|
|
611
|
+
|
|
514
612
|
/**
|
|
515
613
|
* Get a specific botConnector bot, plus versions, for this integration
|
|
516
614
|
*
|
|
@@ -1494,6 +1592,37 @@ class IntegrationsApi {
|
|
|
1494
1592
|
);
|
|
1495
1593
|
}
|
|
1496
1594
|
|
|
1595
|
+
/**
|
|
1596
|
+
* Create upload presigned URL for draft function package file.
|
|
1597
|
+
*
|
|
1598
|
+
* @param {String} actionId actionId
|
|
1599
|
+
* @param {Object} body Input used to request URL upload.
|
|
1600
|
+
* postIntegrationsActionDraftFunctionUpload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1601
|
+
*/
|
|
1602
|
+
postIntegrationsActionDraftFunctionUpload(actionId, body) {
|
|
1603
|
+
// verify the required parameter 'actionId' is set
|
|
1604
|
+
if (actionId === undefined || actionId === null) {
|
|
1605
|
+
throw 'Missing the required parameter "actionId" when calling postIntegrationsActionDraftFunctionUpload';
|
|
1606
|
+
}
|
|
1607
|
+
// verify the required parameter 'body' is set
|
|
1608
|
+
if (body === undefined || body === null) {
|
|
1609
|
+
throw 'Missing the required parameter "body" when calling postIntegrationsActionDraftFunctionUpload';
|
|
1610
|
+
}
|
|
1611
|
+
|
|
1612
|
+
return this.apiClient.callApi(
|
|
1613
|
+
'/api/v2/integrations/actions/{actionId}/draft/function/upload',
|
|
1614
|
+
'POST',
|
|
1615
|
+
{ 'actionId': actionId },
|
|
1616
|
+
{ },
|
|
1617
|
+
{ },
|
|
1618
|
+
{ },
|
|
1619
|
+
body,
|
|
1620
|
+
['PureCloud OAuth'],
|
|
1621
|
+
['application/json'],
|
|
1622
|
+
['application/json']
|
|
1623
|
+
);
|
|
1624
|
+
}
|
|
1625
|
+
|
|
1497
1626
|
/**
|
|
1498
1627
|
* Publish a Draft and make it the active Action configuration
|
|
1499
1628
|
*
|
|
@@ -1816,6 +1945,37 @@ class IntegrationsApi {
|
|
|
1816
1945
|
);
|
|
1817
1946
|
}
|
|
1818
1947
|
|
|
1948
|
+
/**
|
|
1949
|
+
* Update draft function settings.
|
|
1950
|
+
*
|
|
1951
|
+
* @param {String} actionId actionId
|
|
1952
|
+
* @param {Object} body Input used to update function settings.
|
|
1953
|
+
* putIntegrationsActionDraftFunction is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1954
|
+
*/
|
|
1955
|
+
putIntegrationsActionDraftFunction(actionId, body) {
|
|
1956
|
+
// verify the required parameter 'actionId' is set
|
|
1957
|
+
if (actionId === undefined || actionId === null) {
|
|
1958
|
+
throw 'Missing the required parameter "actionId" when calling putIntegrationsActionDraftFunction';
|
|
1959
|
+
}
|
|
1960
|
+
// verify the required parameter 'body' is set
|
|
1961
|
+
if (body === undefined || body === null) {
|
|
1962
|
+
throw 'Missing the required parameter "body" when calling putIntegrationsActionDraftFunction';
|
|
1963
|
+
}
|
|
1964
|
+
|
|
1965
|
+
return this.apiClient.callApi(
|
|
1966
|
+
'/api/v2/integrations/actions/{actionId}/draft/function',
|
|
1967
|
+
'PUT',
|
|
1968
|
+
{ 'actionId': actionId },
|
|
1969
|
+
{ },
|
|
1970
|
+
{ },
|
|
1971
|
+
{ },
|
|
1972
|
+
body,
|
|
1973
|
+
['PureCloud OAuth'],
|
|
1974
|
+
['application/json'],
|
|
1975
|
+
['application/json']
|
|
1976
|
+
);
|
|
1977
|
+
}
|
|
1978
|
+
|
|
1819
1979
|
/**
|
|
1820
1980
|
* Set a list of botConnector bots plus versions for this integration
|
|
1821
1981
|
*
|
|
@@ -5,7 +5,7 @@ class JourneyApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Journey service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 187.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -772,39 +772,6 @@ class JourneyApi {
|
|
|
772
772
|
);
|
|
773
773
|
}
|
|
774
774
|
|
|
775
|
-
/**
|
|
776
|
-
* Retrieve segment assignments by session ID.
|
|
777
|
-
*
|
|
778
|
-
* @param {String} sessionId ID of the session to query for segment assignments.
|
|
779
|
-
* @param {Object} opts Optional parameters
|
|
780
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
781
|
-
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
782
|
-
* @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
|
|
783
|
-
* @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
|
|
784
|
-
* getJourneySessionSegments is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
785
|
-
*/
|
|
786
|
-
getJourneySessionSegments(sessionId, opts) {
|
|
787
|
-
opts = opts || {};
|
|
788
|
-
|
|
789
|
-
// verify the required parameter 'sessionId' is set
|
|
790
|
-
if (sessionId === undefined || sessionId === null) {
|
|
791
|
-
throw 'Missing the required parameter "sessionId" when calling getJourneySessionSegments';
|
|
792
|
-
}
|
|
793
|
-
|
|
794
|
-
return this.apiClient.callApi(
|
|
795
|
-
'/api/v2/journey/sessions/{sessionId}/segments',
|
|
796
|
-
'GET',
|
|
797
|
-
{ 'sessionId': sessionId },
|
|
798
|
-
{ 'pageSize': opts['pageSize'],'after': opts['after'],'segmentScope': opts['segmentScope'],'assignmentState': opts['assignmentState'] },
|
|
799
|
-
{ },
|
|
800
|
-
{ },
|
|
801
|
-
null,
|
|
802
|
-
['PureCloud OAuth'],
|
|
803
|
-
['application/json'],
|
|
804
|
-
['application/json']
|
|
805
|
-
);
|
|
806
|
-
}
|
|
807
|
-
|
|
808
775
|
/**
|
|
809
776
|
* Update single action map.
|
|
810
777
|
*
|
|
@@ -5,7 +5,7 @@ class KnowledgeApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Knowledge service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 187.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1347,6 +1347,68 @@ class KnowledgeApi {
|
|
|
1347
1347
|
);
|
|
1348
1348
|
}
|
|
1349
1349
|
|
|
1350
|
+
/**
|
|
1351
|
+
* Get operations
|
|
1352
|
+
*
|
|
1353
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
1354
|
+
* @param {Object} opts Optional parameters
|
|
1355
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
1356
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
1357
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
1358
|
+
* @param {Array.<String>} opts.userId If specified, retrieves operations associated with user ids, comma separated values expected.
|
|
1359
|
+
* @param {Array.<String>} opts.type If specified, retrieves operations with specified operation type, comma separated values expected.
|
|
1360
|
+
* @param {Array.<String>} opts.status If specified, retrieves operations with specified operation status, comma separated values expected.
|
|
1361
|
+
* @param {String} opts.interval Retrieves the operations modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ
|
|
1362
|
+
* getKnowledgeKnowledgebaseOperations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1363
|
+
*/
|
|
1364
|
+
getKnowledgeKnowledgebaseOperations(knowledgeBaseId, opts) {
|
|
1365
|
+
opts = opts || {};
|
|
1366
|
+
|
|
1367
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
1368
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
1369
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseOperations';
|
|
1370
|
+
}
|
|
1371
|
+
|
|
1372
|
+
return this.apiClient.callApi(
|
|
1373
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations',
|
|
1374
|
+
'GET',
|
|
1375
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
1376
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'userId': this.apiClient.buildCollectionParam(opts['userId'], 'multi'),'type': this.apiClient.buildCollectionParam(opts['type'], 'multi'),'status': this.apiClient.buildCollectionParam(opts['status'], 'multi'),'interval': opts['interval'] },
|
|
1377
|
+
{ },
|
|
1378
|
+
{ },
|
|
1379
|
+
null,
|
|
1380
|
+
['PureCloud OAuth'],
|
|
1381
|
+
['application/json'],
|
|
1382
|
+
['application/json']
|
|
1383
|
+
);
|
|
1384
|
+
}
|
|
1385
|
+
|
|
1386
|
+
/**
|
|
1387
|
+
* Get ids of operation creator users and oauth clients
|
|
1388
|
+
*
|
|
1389
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
1390
|
+
* getKnowledgeKnowledgebaseOperationsUsersQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1391
|
+
*/
|
|
1392
|
+
getKnowledgeKnowledgebaseOperationsUsersQuery(knowledgeBaseId) {
|
|
1393
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
1394
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
1395
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseOperationsUsersQuery';
|
|
1396
|
+
}
|
|
1397
|
+
|
|
1398
|
+
return this.apiClient.callApi(
|
|
1399
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/operations/users/query',
|
|
1400
|
+
'GET',
|
|
1401
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
1402
|
+
{ },
|
|
1403
|
+
{ },
|
|
1404
|
+
{ },
|
|
1405
|
+
null,
|
|
1406
|
+
['PureCloud OAuth'],
|
|
1407
|
+
['application/json'],
|
|
1408
|
+
['application/json']
|
|
1409
|
+
);
|
|
1410
|
+
}
|
|
1411
|
+
|
|
1350
1412
|
/**
|
|
1351
1413
|
* Get knowledge base unanswered group for a particular groupId
|
|
1352
1414
|
*
|
|
@@ -5,7 +5,7 @@ class LogCaptureApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* LogCapture service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 187.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -20,6 +20,31 @@ class LogCaptureApi {
|
|
|
20
20
|
}
|
|
21
21
|
|
|
22
22
|
|
|
23
|
+
/**
|
|
24
|
+
* Disable browser log capture for the user
|
|
25
|
+
*
|
|
26
|
+
* @param {String} userId The id of the user to disable browser log capture
|
|
27
|
+
*/
|
|
28
|
+
deleteDiagnosticsLogcaptureBrowserUser(userId) {
|
|
29
|
+
// verify the required parameter 'userId' is set
|
|
30
|
+
if (userId === undefined || userId === null) {
|
|
31
|
+
throw 'Missing the required parameter "userId" when calling deleteDiagnosticsLogcaptureBrowserUser';
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
return this.apiClient.callApi(
|
|
35
|
+
'/api/v2/diagnostics/logcapture/browser/users/{userId}',
|
|
36
|
+
'DELETE',
|
|
37
|
+
{ 'userId': userId },
|
|
38
|
+
{ },
|
|
39
|
+
{ },
|
|
40
|
+
{ },
|
|
41
|
+
null,
|
|
42
|
+
['PureCloud OAuth'],
|
|
43
|
+
['application/json'],
|
|
44
|
+
['application/json']
|
|
45
|
+
);
|
|
46
|
+
}
|
|
47
|
+
|
|
23
48
|
/**
|
|
24
49
|
* Gets status of async download execution
|
|
25
50
|
*
|
|
@@ -45,6 +70,55 @@ class LogCaptureApi {
|
|
|
45
70
|
);
|
|
46
71
|
}
|
|
47
72
|
|
|
73
|
+
/**
|
|
74
|
+
* Get log capture configuration for the user
|
|
75
|
+
*
|
|
76
|
+
* @param {String} userId The id of the user to get browser log capture configuration
|
|
77
|
+
*/
|
|
78
|
+
getDiagnosticsLogcaptureBrowserUser(userId) {
|
|
79
|
+
// verify the required parameter 'userId' is set
|
|
80
|
+
if (userId === undefined || userId === null) {
|
|
81
|
+
throw 'Missing the required parameter "userId" when calling getDiagnosticsLogcaptureBrowserUser';
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
return this.apiClient.callApi(
|
|
85
|
+
'/api/v2/diagnostics/logcapture/browser/users/{userId}',
|
|
86
|
+
'GET',
|
|
87
|
+
{ 'userId': userId },
|
|
88
|
+
{ },
|
|
89
|
+
{ },
|
|
90
|
+
{ },
|
|
91
|
+
null,
|
|
92
|
+
['PureCloud OAuth'],
|
|
93
|
+
['application/json'],
|
|
94
|
+
['application/json']
|
|
95
|
+
);
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
/**
|
|
99
|
+
* Get all log capture enabled users for an org
|
|
100
|
+
*
|
|
101
|
+
* @param {Object} opts Optional parameters
|
|
102
|
+
* @param {Boolean} opts.includeExpired Include expired users with log captures still available for search or download (default to false)
|
|
103
|
+
*/
|
|
104
|
+
getDiagnosticsLogcaptureBrowserUsers(opts) {
|
|
105
|
+
opts = opts || {};
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
return this.apiClient.callApi(
|
|
109
|
+
'/api/v2/diagnostics/logcapture/browser/users',
|
|
110
|
+
'GET',
|
|
111
|
+
{ },
|
|
112
|
+
{ 'includeExpired': opts['includeExpired'] },
|
|
113
|
+
{ },
|
|
114
|
+
{ },
|
|
115
|
+
null,
|
|
116
|
+
['PureCloud OAuth'],
|
|
117
|
+
['application/json'],
|
|
118
|
+
['application/json']
|
|
119
|
+
);
|
|
120
|
+
}
|
|
121
|
+
|
|
48
122
|
/**
|
|
49
123
|
* Creates an async download execution
|
|
50
124
|
*
|
|
@@ -69,6 +143,62 @@ class LogCaptureApi {
|
|
|
69
143
|
);
|
|
70
144
|
}
|
|
71
145
|
|
|
146
|
+
/**
|
|
147
|
+
* Query collected log entries. It returns a limited amount of records, to get all records use download endpoint.
|
|
148
|
+
*
|
|
149
|
+
* @param {Object} opts Optional parameters
|
|
150
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
151
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
152
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
153
|
+
* @param {Object} opts.body
|
|
154
|
+
*/
|
|
155
|
+
postDiagnosticsLogcaptureBrowserEntriesQuery(opts) {
|
|
156
|
+
opts = opts || {};
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
return this.apiClient.callApi(
|
|
160
|
+
'/api/v2/diagnostics/logcapture/browser/entries/query',
|
|
161
|
+
'POST',
|
|
162
|
+
{ },
|
|
163
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
164
|
+
{ },
|
|
165
|
+
{ },
|
|
166
|
+
opts['body'],
|
|
167
|
+
['PureCloud OAuth'],
|
|
168
|
+
['application/json'],
|
|
169
|
+
['application/json']
|
|
170
|
+
);
|
|
171
|
+
}
|
|
172
|
+
|
|
173
|
+
/**
|
|
174
|
+
* Enable log capture for a user or update expiration
|
|
175
|
+
*
|
|
176
|
+
* @param {String} userId The id of the user to enable browser log capture
|
|
177
|
+
* @param {Object} opts Optional parameters
|
|
178
|
+
* @param {Object} opts.body
|
|
179
|
+
*/
|
|
180
|
+
postDiagnosticsLogcaptureBrowserUser(userId, opts) {
|
|
181
|
+
opts = opts || {};
|
|
182
|
+
|
|
183
|
+
// verify the required parameter 'userId' is set
|
|
184
|
+
if (userId === undefined || userId === null) {
|
|
185
|
+
throw 'Missing the required parameter "userId" when calling postDiagnosticsLogcaptureBrowserUser';
|
|
186
|
+
}
|
|
187
|
+
|
|
188
|
+
return this.apiClient.callApi(
|
|
189
|
+
'/api/v2/diagnostics/logcapture/browser/users/{userId}',
|
|
190
|
+
'POST',
|
|
191
|
+
{ 'userId': userId },
|
|
192
|
+
{ },
|
|
193
|
+
{ },
|
|
194
|
+
{ },
|
|
195
|
+
opts['body'],
|
|
196
|
+
['PureCloud OAuth'],
|
|
197
|
+
['application/json'],
|
|
198
|
+
['application/json']
|
|
199
|
+
);
|
|
200
|
+
}
|
|
201
|
+
|
|
72
202
|
}
|
|
73
203
|
|
|
74
204
|
|