purecloud-platform-client-v2 187.0.0 → 188.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 +406 -93
- package/dist/web-amd/purecloud-platform-client-v2.js +406 -93
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +173 -94
- package/dist/web-cjs/purecloud-platform-client-v2.js +261 -139
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +379 -146
- 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 +26 -2
- 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 +3 -2
- 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 +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 -10
- 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 +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/InfrastructureAsCodeApi.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 +201 -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 +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 +3 -2
- 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 +34 -4
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.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/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +3 -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/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 -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 +63 -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 +1 -1
|
@@ -5,7 +5,7 @@ class ObjectsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Objects service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 188.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -89,6 +89,7 @@ class ObjectsApi {
|
|
|
89
89
|
* @param {String} opts.nextPage next page token
|
|
90
90
|
* @param {String} opts.previousPage Previous page token
|
|
91
91
|
* @param {Boolean} opts.objectCount Include the count of objects contained in the division (default to false)
|
|
92
|
+
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
92
93
|
* @param {String} opts.name Search term to filter by division name
|
|
93
94
|
*/
|
|
94
95
|
getAuthorizationDivisions(opts) {
|
|
@@ -99,7 +100,7 @@ class ObjectsApi {
|
|
|
99
100
|
'/api/v2/authorization/divisions',
|
|
100
101
|
'GET',
|
|
101
102
|
{ },
|
|
102
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'objectCount': opts['objectCount'],'name': opts['name'] },
|
|
103
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'objectCount': opts['objectCount'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'] },
|
|
103
104
|
{ },
|
|
104
105
|
{ },
|
|
105
106
|
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 188.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -2008,8 +2008,12 @@ class OutboundApi {
|
|
|
2008
2008
|
* Get Import Template
|
|
2009
2009
|
*
|
|
2010
2010
|
* @param {String} importTemplateId Import Template ID
|
|
2011
|
+
* @param {Object} opts Optional parameters
|
|
2012
|
+
* @param {Boolean} opts.includeImportStatus Import status (default to false)
|
|
2011
2013
|
*/
|
|
2012
|
-
getOutboundImporttemplate(importTemplateId) {
|
|
2014
|
+
getOutboundImporttemplate(importTemplateId, opts) {
|
|
2015
|
+
opts = opts || {};
|
|
2016
|
+
|
|
2013
2017
|
// verify the required parameter 'importTemplateId' is set
|
|
2014
2018
|
if (importTemplateId === undefined || importTemplateId === null) {
|
|
2015
2019
|
throw 'Missing the required parameter "importTemplateId" when calling getOutboundImporttemplate';
|
|
@@ -2019,7 +2023,7 @@ class OutboundApi {
|
|
|
2019
2023
|
'/api/v2/outbound/importtemplates/{importTemplateId}',
|
|
2020
2024
|
'GET',
|
|
2021
2025
|
{ 'importTemplateId': importTemplateId },
|
|
2022
|
-
{
|
|
2026
|
+
{ 'includeImportStatus': opts['includeImportStatus'] },
|
|
2023
2027
|
{ },
|
|
2024
2028
|
{ },
|
|
2025
2029
|
null,
|
|
@@ -2062,6 +2066,7 @@ class OutboundApi {
|
|
|
2062
2066
|
* Query Import Templates
|
|
2063
2067
|
*
|
|
2064
2068
|
* @param {Object} opts Optional parameters
|
|
2069
|
+
* @param {Boolean} opts.includeImportStatus Import status (default to false)
|
|
2065
2070
|
* @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
|
|
2066
2071
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
2067
2072
|
* @param {Boolean} opts.allowEmptyResult Whether to return an empty page when there are no results for that page (default to false)
|
|
@@ -2079,7 +2084,7 @@ class OutboundApi {
|
|
|
2079
2084
|
'/api/v2/outbound/importtemplates',
|
|
2080
2085
|
'GET',
|
|
2081
2086
|
{ },
|
|
2082
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'allowEmptyResult': opts['allowEmptyResult'],'filterType': opts['filterType'],'name': opts['name'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'contactListTemplateId': opts['contactListTemplateId'] },
|
|
2087
|
+
{ 'includeImportStatus': opts['includeImportStatus'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'allowEmptyResult': opts['allowEmptyResult'],'filterType': opts['filterType'],'name': opts['name'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'contactListTemplateId': opts['contactListTemplateId'] },
|
|
2083
2088
|
{ },
|
|
2084
2089
|
{ },
|
|
2085
2090
|
null,
|
|
@@ -3077,6 +3082,31 @@ class OutboundApi {
|
|
|
3077
3082
|
);
|
|
3078
3083
|
}
|
|
3079
3084
|
|
|
3085
|
+
/**
|
|
3086
|
+
* Retrieve multiple contact list filters
|
|
3087
|
+
*
|
|
3088
|
+
* @param {Object} body The contact list filters to retrieve
|
|
3089
|
+
*/
|
|
3090
|
+
postOutboundContactlistfiltersBulkRetrieve(body) {
|
|
3091
|
+
// verify the required parameter 'body' is set
|
|
3092
|
+
if (body === undefined || body === null) {
|
|
3093
|
+
throw 'Missing the required parameter "body" when calling postOutboundContactlistfiltersBulkRetrieve';
|
|
3094
|
+
}
|
|
3095
|
+
|
|
3096
|
+
return this.apiClient.callApi(
|
|
3097
|
+
'/api/v2/outbound/contactlistfilters/bulk/retrieve',
|
|
3098
|
+
'POST',
|
|
3099
|
+
{ },
|
|
3100
|
+
{ },
|
|
3101
|
+
{ },
|
|
3102
|
+
{ },
|
|
3103
|
+
body,
|
|
3104
|
+
['PureCloud OAuth'],
|
|
3105
|
+
['application/json'],
|
|
3106
|
+
['application/json']
|
|
3107
|
+
);
|
|
3108
|
+
}
|
|
3109
|
+
|
|
3080
3110
|
/**
|
|
3081
3111
|
* Get a preview of the output of a contact list filter
|
|
3082
3112
|
*
|
|
@@ -5,7 +5,7 @@ class SpeechTextAnalyticsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* SpeechTextAnalytics service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 188.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -599,6 +599,7 @@ class SpeechTextAnalyticsApi {
|
|
|
599
599
|
* @param {Object} opts.state Topic state. Defaults to latest
|
|
600
600
|
* @param {String} opts.name Case insensitive partial name to filter by
|
|
601
601
|
* @param {Array.<String>} opts.ids Comma separated Topic IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed.
|
|
602
|
+
* @param {Array.<String>} opts.dialects Comma separated dialect strings to filter by. Maximum of 15 dialects allowed.
|
|
602
603
|
* @param {Object} opts.sortBy Sort results by. Defaults to name
|
|
603
604
|
* @param {Object} opts.sortOrder Sort order. Defaults to asc
|
|
604
605
|
*/
|
|
@@ -610,7 +611,7 @@ class SpeechTextAnalyticsApi {
|
|
|
610
611
|
'/api/v2/speechandtextanalytics/topics',
|
|
611
612
|
'GET',
|
|
612
613
|
{ },
|
|
613
|
-
{ 'nextPage': opts['nextPage'],'pageSize': opts['pageSize'],'state': opts['state'],'name': opts['name'],'ids': this.apiClient.buildCollectionParam(opts['ids'], 'multi'),'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
|
|
614
|
+
{ 'nextPage': opts['nextPage'],'pageSize': opts['pageSize'],'state': opts['state'],'name': opts['name'],'ids': this.apiClient.buildCollectionParam(opts['ids'], 'multi'),'dialects': this.apiClient.buildCollectionParam(opts['dialects'], 'multi'),'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
|
|
614
615
|
{ },
|
|
615
616
|
{ },
|
|
616
617
|
null,
|
|
@@ -5,7 +5,7 @@ class UploadsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Uploads service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 188.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -20,6 +20,37 @@ class UploadsApi {
|
|
|
20
20
|
}
|
|
21
21
|
|
|
22
22
|
|
|
23
|
+
/**
|
|
24
|
+
* Get content upload from URL job status
|
|
25
|
+
*
|
|
26
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
27
|
+
* @param {String} jobId Upload job ID
|
|
28
|
+
* getKnowledgeKnowledgebaseUploadsUrlsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
29
|
+
*/
|
|
30
|
+
getKnowledgeKnowledgebaseUploadsUrlsJob(knowledgeBaseId, jobId) {
|
|
31
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
32
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
33
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseUploadsUrlsJob';
|
|
34
|
+
}
|
|
35
|
+
// verify the required parameter 'jobId' is set
|
|
36
|
+
if (jobId === undefined || jobId === null) {
|
|
37
|
+
throw 'Missing the required parameter "jobId" when calling getKnowledgeKnowledgebaseUploadsUrlsJob';
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
return this.apiClient.callApi(
|
|
41
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs/{jobId}',
|
|
42
|
+
'GET',
|
|
43
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'jobId': jobId },
|
|
44
|
+
{ },
|
|
45
|
+
{ },
|
|
46
|
+
{ },
|
|
47
|
+
null,
|
|
48
|
+
['PureCloud OAuth'],
|
|
49
|
+
['application/json'],
|
|
50
|
+
['application/json']
|
|
51
|
+
);
|
|
52
|
+
}
|
|
53
|
+
|
|
23
54
|
/**
|
|
24
55
|
* Create upload presigned URL for draft function package file.
|
|
25
56
|
*
|
|
@@ -76,6 +107,37 @@ class UploadsApi {
|
|
|
76
107
|
);
|
|
77
108
|
}
|
|
78
109
|
|
|
110
|
+
/**
|
|
111
|
+
* Create content upload from URL job
|
|
112
|
+
*
|
|
113
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
114
|
+
* @param {Object} body uploadRequest
|
|
115
|
+
* postKnowledgeKnowledgebaseUploadsUrlsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
116
|
+
*/
|
|
117
|
+
postKnowledgeKnowledgebaseUploadsUrlsJobs(knowledgeBaseId, body) {
|
|
118
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
119
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
120
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseUploadsUrlsJobs';
|
|
121
|
+
}
|
|
122
|
+
// verify the required parameter 'body' is set
|
|
123
|
+
if (body === undefined || body === null) {
|
|
124
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseUploadsUrlsJobs';
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
return this.apiClient.callApi(
|
|
128
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/uploads/urls/jobs',
|
|
129
|
+
'POST',
|
|
130
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
131
|
+
{ },
|
|
132
|
+
{ },
|
|
133
|
+
{ },
|
|
134
|
+
body,
|
|
135
|
+
['PureCloud OAuth'],
|
|
136
|
+
['application/json'],
|
|
137
|
+
['application/json']
|
|
138
|
+
);
|
|
139
|
+
}
|
|
140
|
+
|
|
79
141
|
/**
|
|
80
142
|
* Creates a presigned URL for uploading a chat corpus which will be used for mining by intent miner
|
|
81
143
|
*
|