purecloud-platform-client-v2 152.0.0 → 154.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 +485 -81
- package/dist/web-amd/purecloud-platform-client-v2.js +485 -81
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +485 -81
- package/dist/web-cjs/purecloud-platform-client-v2.js +485 -81
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +784 -207
- package/package.json +1 -1
- 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 +5 -4
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +46 -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 +3 -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/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +3 -2
- 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/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 +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 +31 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +6 -6
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +4 -2
- 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 +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/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +325 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/package.json
CHANGED
|
@@ -5,7 +5,7 @@ class AnalyticsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Analytics service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 154.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -21,7 +21,7 @@ class AnalyticsApi {
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
/**
|
|
24
|
-
* Delete/cancel an async
|
|
24
|
+
* Delete/cancel an async details job
|
|
25
25
|
*
|
|
26
26
|
* @param {String} jobId jobId
|
|
27
27
|
*/
|
|
@@ -105,6 +105,7 @@ class AnalyticsApi {
|
|
|
105
105
|
* @param {String} opts.actionId Optional action ID to get the reporting turns associated to a particular flow action
|
|
106
106
|
* @param {String} opts.sessionId Optional session ID to get the reporting turns for a particular session
|
|
107
107
|
* @param {String} opts.language Optional language code to get the reporting turns for a particular language
|
|
108
|
+
* @param {Object} opts.askActionResults Optional case-insensitive comma separated list of ask action results to filter the reporting turns.
|
|
108
109
|
*/
|
|
109
110
|
getAnalyticsBotflowReportingturns(botFlowId, opts) {
|
|
110
111
|
opts = opts || {};
|
|
@@ -118,7 +119,7 @@ class AnalyticsApi {
|
|
|
118
119
|
'/api/v2/analytics/botflows/{botFlowId}/reportingturns',
|
|
119
120
|
'GET',
|
|
120
121
|
{ 'botFlowId': botFlowId },
|
|
121
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'] },
|
|
122
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'],'askActionResults': opts['askActionResults'] },
|
|
122
123
|
{ },
|
|
123
124
|
{ },
|
|
124
125
|
null,
|
|
@@ -203,7 +204,7 @@ class AnalyticsApi {
|
|
|
203
204
|
}
|
|
204
205
|
|
|
205
206
|
/**
|
|
206
|
-
* Fetch a page of results for an async
|
|
207
|
+
* Fetch a page of results for an async details job
|
|
207
208
|
*
|
|
208
209
|
* @param {String} jobId jobId
|
|
209
210
|
* @param {Object} opts Optional parameters
|
|
@@ -5,7 +5,7 @@ class ArchitectApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Architect service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 154.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -764,6 +764,7 @@ class ArchitectApi {
|
|
|
764
764
|
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
765
765
|
* @param {String} opts.name Name of the IVR to filter by.
|
|
766
766
|
* @param {String} opts.dnis The phone number of the IVR to filter by.
|
|
767
|
+
* @param {String} opts.scheduleGroup The Schedule Group of the IVR to filter by.
|
|
767
768
|
*/
|
|
768
769
|
getArchitectIvrs(opts) {
|
|
769
770
|
opts = opts || {};
|
|
@@ -773,7 +774,7 @@ class ArchitectApi {
|
|
|
773
774
|
'/api/v2/architect/ivrs',
|
|
774
775
|
'GET',
|
|
775
776
|
{ },
|
|
776
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'dnis': opts['dnis'] },
|
|
777
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'dnis': opts['dnis'],'scheduleGroup': opts['scheduleGroup'] },
|
|
777
778
|
{ },
|
|
778
779
|
{ },
|
|
779
780
|
null,
|
|
@@ -5,7 +5,7 @@ class AuthorizationApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Authorization service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 154.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -538,6 +538,26 @@ class AuthorizationApi {
|
|
|
538
538
|
);
|
|
539
539
|
}
|
|
540
540
|
|
|
541
|
+
/**
|
|
542
|
+
* Get authorization settings
|
|
543
|
+
*
|
|
544
|
+
*/
|
|
545
|
+
getAuthorizationSettings() {
|
|
546
|
+
|
|
547
|
+
return this.apiClient.callApi(
|
|
548
|
+
'/api/v2/authorization/settings',
|
|
549
|
+
'GET',
|
|
550
|
+
{ },
|
|
551
|
+
{ },
|
|
552
|
+
{ },
|
|
553
|
+
{ },
|
|
554
|
+
null,
|
|
555
|
+
['PureCloud OAuth'],
|
|
556
|
+
['application/json'],
|
|
557
|
+
['application/json']
|
|
558
|
+
);
|
|
559
|
+
}
|
|
560
|
+
|
|
541
561
|
/**
|
|
542
562
|
* Returns a listing of roles and permissions for a user.
|
|
543
563
|
*
|
|
@@ -662,6 +682,31 @@ class AuthorizationApi {
|
|
|
662
682
|
);
|
|
663
683
|
}
|
|
664
684
|
|
|
685
|
+
/**
|
|
686
|
+
* Change authorization settings
|
|
687
|
+
* Change authorization settings
|
|
688
|
+
* @param {Object} body Authorization Settings
|
|
689
|
+
*/
|
|
690
|
+
patchAuthorizationSettings(body) {
|
|
691
|
+
// verify the required parameter 'body' is set
|
|
692
|
+
if (body === undefined || body === null) {
|
|
693
|
+
throw 'Missing the required parameter "body" when calling patchAuthorizationSettings';
|
|
694
|
+
}
|
|
695
|
+
|
|
696
|
+
return this.apiClient.callApi(
|
|
697
|
+
'/api/v2/authorization/settings',
|
|
698
|
+
'PATCH',
|
|
699
|
+
{ },
|
|
700
|
+
{ },
|
|
701
|
+
{ },
|
|
702
|
+
{ },
|
|
703
|
+
body,
|
|
704
|
+
['PureCloud OAuth'],
|
|
705
|
+
['application/json'],
|
|
706
|
+
['application/json']
|
|
707
|
+
);
|
|
708
|
+
}
|
|
709
|
+
|
|
665
710
|
/**
|
|
666
711
|
* Assign a list of objects to a division
|
|
667
712
|
* Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, DATATABLES or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. ["206ce31f-61ec-40ed-a8b1-be6f06303998","250a754e-f5e4-4f51-800f-a92f09d3bf8c"]
|
|
@@ -5,7 +5,7 @@ class ConversationsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Conversations service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 154.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -21,7 +21,7 @@ class ConversationsApi {
|
|
|
21
21
|
|
|
22
22
|
|
|
23
23
|
/**
|
|
24
|
-
* Delete/cancel an async
|
|
24
|
+
* Delete/cancel an async details job
|
|
25
25
|
*
|
|
26
26
|
* @param {String} jobId jobId
|
|
27
27
|
*/
|
|
@@ -395,7 +395,7 @@ class ConversationsApi {
|
|
|
395
395
|
}
|
|
396
396
|
|
|
397
397
|
/**
|
|
398
|
-
* Fetch a page of results for an async
|
|
398
|
+
* Fetch a page of results for an async details job
|
|
399
399
|
*
|
|
400
400
|
* @param {String} jobId jobId
|
|
401
401
|
* @param {Object} opts Optional parameters
|
|
@@ -5,7 +5,7 @@ class LearningApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Learning service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 154.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -305,6 +305,7 @@ class LearningApi {
|
|
|
305
305
|
* @param {String} opts.searchTerm Search Term (searchable by name)
|
|
306
306
|
* @param {Array.<String>} opts.expand Fields to expand in response(case insensitive)
|
|
307
307
|
* @param {Object} opts.isPublished Specifies if only the Unpublished (isPublished is False) or Published (isPublished is True) modules are returned. If isPublished is Any or omitted, both types are returned (default to Any)
|
|
308
|
+
* @param {Array.<String>} opts.statuses Specifies the module statuses to filter by
|
|
308
309
|
*/
|
|
309
310
|
getLearningModules(opts) {
|
|
310
311
|
opts = opts || {};
|
|
@@ -314,7 +315,7 @@ class LearningApi {
|
|
|
314
315
|
'/api/v2/learning/modules',
|
|
315
316
|
'GET',
|
|
316
317
|
{ },
|
|
317
|
-
{ 'isArchived': opts['isArchived'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'],'searchTerm': opts['searchTerm'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'isPublished': opts['isPublished'] },
|
|
318
|
+
{ 'isArchived': opts['isArchived'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'],'searchTerm': opts['searchTerm'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'isPublished': opts['isPublished'],'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi') },
|
|
318
319
|
{ },
|
|
319
320
|
{ },
|
|
320
321
|
null,
|
|
@@ -5,7 +5,7 @@ class OutboundApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Outbound service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 154.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -2629,6 +2629,36 @@ class OutboundApi {
|
|
|
2629
2629
|
);
|
|
2630
2630
|
}
|
|
2631
2631
|
|
|
2632
|
+
/**
|
|
2633
|
+
* Add email addresses to a DNC list.
|
|
2634
|
+
* Only Internal DNC lists may be appended to
|
|
2635
|
+
* @param {String} dncListId DncList ID
|
|
2636
|
+
* @param {Array.<String>} body DNC email addresses
|
|
2637
|
+
*/
|
|
2638
|
+
postOutboundDnclistEmailaddresses(dncListId, body) {
|
|
2639
|
+
// verify the required parameter 'dncListId' is set
|
|
2640
|
+
if (dncListId === undefined || dncListId === null) {
|
|
2641
|
+
throw 'Missing the required parameter "dncListId" when calling postOutboundDnclistEmailaddresses';
|
|
2642
|
+
}
|
|
2643
|
+
// verify the required parameter 'body' is set
|
|
2644
|
+
if (body === undefined || body === null) {
|
|
2645
|
+
throw 'Missing the required parameter "body" when calling postOutboundDnclistEmailaddresses';
|
|
2646
|
+
}
|
|
2647
|
+
|
|
2648
|
+
return this.apiClient.callApi(
|
|
2649
|
+
'/api/v2/outbound/dnclists/{dncListId}/emailaddresses',
|
|
2650
|
+
'POST',
|
|
2651
|
+
{ 'dncListId': dncListId },
|
|
2652
|
+
{ },
|
|
2653
|
+
{ },
|
|
2654
|
+
{ },
|
|
2655
|
+
body,
|
|
2656
|
+
['PureCloud OAuth'],
|
|
2657
|
+
['application/json'],
|
|
2658
|
+
['application/json']
|
|
2659
|
+
);
|
|
2660
|
+
}
|
|
2661
|
+
|
|
2632
2662
|
/**
|
|
2633
2663
|
* Initiate the export of a dnc list.
|
|
2634
2664
|
* Returns 200 if received OK.
|