purecloud-platform-client-v2 219.0.0 → 220.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 +4 -4
- package/dist/node/purecloud-platform-client-v2.js +159 -100
- package/dist/web-amd/purecloud-platform-client-v2.js +159 -100
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +123 -112
- package/dist/web-cjs/purecloud-platform-client-v2.js +123 -112
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1000 -760
- package/package.json +2 -2
- package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.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 +2 -2
- 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/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 +37 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.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/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +4 -4
- 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 +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 +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 +1 -1
- 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 +1 -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 +3 -3
- 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 +33 -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/SocialMediaApi.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 -10
- 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 +3 -3
- 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 +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5,7 +5,7 @@ class RecordingApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Recording service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 220.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -607,7 +607,7 @@ class RecordingApi {
|
|
|
607
607
|
* @param {Object} opts Optional parameters
|
|
608
608
|
* @param {Number} opts.pageSize Page size. Maximum is 100. (default to 25)
|
|
609
609
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
610
|
-
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
|
|
610
|
+
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber. It is recommended to set it to false for improved performance.
|
|
611
611
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
612
612
|
*/
|
|
613
613
|
getRecordingJobFailedrecordings(jobId, opts) {
|
|
@@ -642,7 +642,7 @@ class RecordingApi {
|
|
|
642
642
|
* @param {Object} opts.state Filter by state
|
|
643
643
|
* @param {Boolean} opts.showOnlyMyJobs Show only my jobs
|
|
644
644
|
* @param {Object} opts.jobType Job Type (Can be left empty for both)
|
|
645
|
-
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber.
|
|
645
|
+
* @param {Boolean} opts.includeTotal If false, cursor will be used to locate the page instead of pageNumber. It is recommended to set it to false for improved performance.
|
|
646
646
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
647
647
|
*/
|
|
648
648
|
getRecordingJobs(opts) {
|
|
@@ -5,7 +5,7 @@ class ScriptsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Scripts service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 220.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -205,6 +205,38 @@ class ScriptsApi {
|
|
|
205
205
|
);
|
|
206
206
|
}
|
|
207
207
|
|
|
208
|
+
/**
|
|
209
|
+
* Get the published variables
|
|
210
|
+
*
|
|
211
|
+
* @param {String} scriptId Script ID
|
|
212
|
+
* @param {Object} opts Optional parameters
|
|
213
|
+
* @param {Object} opts.input input
|
|
214
|
+
* @param {Object} opts.output output
|
|
215
|
+
* @param {Object} opts.type type
|
|
216
|
+
* @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
|
|
217
|
+
*/
|
|
218
|
+
getScriptsPublishedDivisionviewVariables(scriptId, opts) {
|
|
219
|
+
opts = opts || {};
|
|
220
|
+
|
|
221
|
+
// verify the required parameter 'scriptId' is set
|
|
222
|
+
if (scriptId === undefined || scriptId === null) {
|
|
223
|
+
throw 'Missing the required parameter "scriptId" when calling getScriptsPublishedDivisionviewVariables';
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
return this.apiClient.callApi(
|
|
227
|
+
'/api/v2/scripts/published/divisionviews/{scriptId}/variables',
|
|
228
|
+
'GET',
|
|
229
|
+
{ 'scriptId': scriptId },
|
|
230
|
+
{ 'input': opts['input'],'output': opts['output'],'type': opts['type'],'scriptDataVersion': opts['scriptDataVersion'] },
|
|
231
|
+
{ },
|
|
232
|
+
{ },
|
|
233
|
+
null,
|
|
234
|
+
['PureCloud OAuth'],
|
|
235
|
+
['application/json'],
|
|
236
|
+
['application/json']
|
|
237
|
+
);
|
|
238
|
+
}
|
|
239
|
+
|
|
208
240
|
/**
|
|
209
241
|
* Get the published scripts metadata.
|
|
210
242
|
*
|
|
@@ -5,7 +5,7 @@ class TaskManagementApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* TaskManagement service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 220.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -323,7 +323,6 @@ class TaskManagementApi {
|
|
|
323
323
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
324
324
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
325
325
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
326
|
-
* getTaskmanagementWorkbinHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
327
326
|
*/
|
|
328
327
|
getTaskmanagementWorkbinHistory(workbinId, opts) {
|
|
329
328
|
opts = opts || {};
|
|
@@ -352,7 +351,6 @@ class TaskManagementApi {
|
|
|
352
351
|
*
|
|
353
352
|
* @param {String} workbinId Workbin ID
|
|
354
353
|
* @param {Number} entityVersion Workbin version
|
|
355
|
-
* getTaskmanagementWorkbinVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
356
354
|
*/
|
|
357
355
|
getTaskmanagementWorkbinVersion(workbinId, entityVersion) {
|
|
358
356
|
// verify the required parameter 'workbinId' is set
|
|
@@ -386,7 +384,6 @@ class TaskManagementApi {
|
|
|
386
384
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
387
385
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
388
386
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
389
|
-
* getTaskmanagementWorkbinVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
390
387
|
*/
|
|
391
388
|
getTaskmanagementWorkbinVersions(workbinId, opts) {
|
|
392
389
|
opts = opts || {};
|
|
@@ -447,7 +444,6 @@ class TaskManagementApi {
|
|
|
447
444
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
448
445
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
449
446
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
450
|
-
* getTaskmanagementWorkitemHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
451
447
|
*/
|
|
452
448
|
getTaskmanagementWorkitemHistory(workitemId, opts) {
|
|
453
449
|
opts = opts || {};
|
|
@@ -513,7 +509,6 @@ class TaskManagementApi {
|
|
|
513
509
|
*
|
|
514
510
|
* @param {String} workitemId Workitem ID
|
|
515
511
|
* @param {Number} entityVersion Workitem version
|
|
516
|
-
* getTaskmanagementWorkitemVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
517
512
|
*/
|
|
518
513
|
getTaskmanagementWorkitemVersion(workitemId, entityVersion) {
|
|
519
514
|
// verify the required parameter 'workitemId' is set
|
|
@@ -547,7 +542,6 @@ class TaskManagementApi {
|
|
|
547
542
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
548
543
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
549
544
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
550
|
-
* getTaskmanagementWorkitemVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
551
545
|
*/
|
|
552
546
|
getTaskmanagementWorkitemVersions(workitemId, opts) {
|
|
553
547
|
opts = opts || {};
|
|
@@ -1163,7 +1157,6 @@ class TaskManagementApi {
|
|
|
1163
1157
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
1164
1158
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
1165
1159
|
* @param {Array.<String>} opts.fields Comma-separated list of fields. The response will contain only versions created as a result of changes to these fields.
|
|
1166
|
-
* getTaskmanagementWorktypeHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1167
1160
|
*/
|
|
1168
1161
|
getTaskmanagementWorktypeHistory(worktypeId, opts) {
|
|
1169
1162
|
opts = opts || {};
|
|
@@ -1247,7 +1240,6 @@ class TaskManagementApi {
|
|
|
1247
1240
|
*
|
|
1248
1241
|
* @param {String} worktypeId Worktype id
|
|
1249
1242
|
* @param {Number} entityVersion Worktype version
|
|
1250
|
-
* getTaskmanagementWorktypeVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1251
1243
|
*/
|
|
1252
1244
|
getTaskmanagementWorktypeVersion(worktypeId, entityVersion) {
|
|
1253
1245
|
// verify the required parameter 'worktypeId' is set
|
|
@@ -1281,7 +1273,6 @@ class TaskManagementApi {
|
|
|
1281
1273
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
1282
1274
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
1283
1275
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
1284
|
-
* getTaskmanagementWorktypeVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1285
1276
|
*/
|
|
1286
1277
|
getTaskmanagementWorktypeVersions(worktypeId, opts) {
|
|
1287
1278
|
opts = opts || {};
|
|
@@ -5,7 +5,7 @@ class TextbotsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Textbots service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 220.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -26,8 +26,8 @@ class TextbotsApi {
|
|
|
26
26
|
* @param {Object} opts Optional parameters
|
|
27
27
|
* @param {Array.<String>} opts.botType Bot types
|
|
28
28
|
* @param {String} opts.botName Bot name
|
|
29
|
-
* @param {Array.<String>} opts.botId Bot IDs
|
|
30
|
-
* @param {Number} opts.pageSize The maximum results to return (default to 25)
|
|
29
|
+
* @param {Array.<String>} opts.botId Bot IDs. Maximum of 50
|
|
30
|
+
* @param {Number} opts.pageSize The maximum results to return. Maximum of 100 (default to 25)
|
|
31
31
|
*/
|
|
32
32
|
getTextbotsBotsSearch(opts) {
|
|
33
33
|
opts = opts || {};
|