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
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "purecloud-platform-client-v2",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "187.0.0",
|
|
4
4
|
"description": "A JavaScript library to interface with the PureCloud Platform API",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"main": "dist/node/purecloud-platform-client-v2.js",
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
"url": "https://developer.mypurecloud.com"
|
|
31
31
|
},
|
|
32
32
|
"dependencies": {
|
|
33
|
-
"axios": "^1.6.
|
|
33
|
+
"axios": "^1.6.5",
|
|
34
34
|
"configparser": "^0.3.9",
|
|
35
35
|
"qs": "^6.10.3",
|
|
36
36
|
"winston": "^3.6.0"
|
|
@@ -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 187.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1061,8 +1061,14 @@ class ArchitectApi {
|
|
|
1061
1061
|
* Get specified user prompt
|
|
1062
1062
|
*
|
|
1063
1063
|
* @param {String} promptId Prompt ID
|
|
1064
|
+
* @param {Object} opts Optional parameters
|
|
1065
|
+
* @param {Boolean} opts.includeMediaUris Include the media URIs for each resource (default to true)
|
|
1066
|
+
* @param {Boolean} opts.includeResources Include the resources for each system prompt (default to true)
|
|
1067
|
+
* @param {Array.<String>} opts.language Filter the resources down to the provided languages
|
|
1064
1068
|
*/
|
|
1065
|
-
getArchitectPrompt(promptId) {
|
|
1069
|
+
getArchitectPrompt(promptId, opts) {
|
|
1070
|
+
opts = opts || {};
|
|
1071
|
+
|
|
1066
1072
|
// verify the required parameter 'promptId' is set
|
|
1067
1073
|
if (promptId === undefined || promptId === null) {
|
|
1068
1074
|
throw 'Missing the required parameter "promptId" when calling getArchitectPrompt';
|
|
@@ -1072,7 +1078,7 @@ class ArchitectApi {
|
|
|
1072
1078
|
'/api/v2/architect/prompts/{promptId}',
|
|
1073
1079
|
'GET',
|
|
1074
1080
|
{ 'promptId': promptId },
|
|
1075
|
-
{
|
|
1081
|
+
{ 'includeMediaUris': opts['includeMediaUris'],'includeResources': opts['includeResources'],'language': this.apiClient.buildCollectionParam(opts['language'], 'multi') },
|
|
1076
1082
|
{ },
|
|
1077
1083
|
{ },
|
|
1078
1084
|
null,
|
|
@@ -1191,6 +1197,9 @@ class ArchitectApi {
|
|
|
1191
1197
|
* @param {String} opts.nameOrDescription Name or description
|
|
1192
1198
|
* @param {String} opts.sortBy Sort by (default to id)
|
|
1193
1199
|
* @param {String} opts.sortOrder Sort order (default to asc)
|
|
1200
|
+
* @param {Boolean} opts.includeMediaUris Include the media URIs for each resource (default to true)
|
|
1201
|
+
* @param {Boolean} opts.includeResources Include the resources for each system prompt (default to true)
|
|
1202
|
+
* @param {Array.<String>} opts.language Filter the resources down to the provided languages
|
|
1194
1203
|
*/
|
|
1195
1204
|
getArchitectPrompts(opts) {
|
|
1196
1205
|
opts = opts || {};
|
|
@@ -1200,7 +1209,7 @@ class ArchitectApi {
|
|
|
1200
1209
|
'/api/v2/architect/prompts',
|
|
1201
1210
|
'GET',
|
|
1202
1211
|
{ },
|
|
1203
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'name': this.apiClient.buildCollectionParam(opts['name'], 'multi'),'description': opts['description'],'nameOrDescription': opts['nameOrDescription'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
|
|
1212
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'name': this.apiClient.buildCollectionParam(opts['name'], 'multi'),'description': opts['description'],'nameOrDescription': opts['nameOrDescription'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'includeMediaUris': opts['includeMediaUris'],'includeResources': opts['includeResources'],'language': this.apiClient.buildCollectionParam(opts['language'], 'multi') },
|
|
1204
1213
|
{ },
|
|
1205
1214
|
{ },
|
|
1206
1215
|
null,
|
|
@@ -1383,8 +1392,14 @@ class ArchitectApi {
|
|
|
1383
1392
|
* Get a system prompt
|
|
1384
1393
|
*
|
|
1385
1394
|
* @param {String} promptId promptId
|
|
1395
|
+
* @param {Object} opts Optional parameters
|
|
1396
|
+
* @param {Boolean} opts.includeMediaUris Include the media URIs for each resource (default to true)
|
|
1397
|
+
* @param {Boolean} opts.includeResources Include the resources for each system prompt (default to true)
|
|
1398
|
+
* @param {Array.<String>} opts.language Filter the resources down to the provided languages
|
|
1386
1399
|
*/
|
|
1387
|
-
getArchitectSystemprompt(promptId) {
|
|
1400
|
+
getArchitectSystemprompt(promptId, opts) {
|
|
1401
|
+
opts = opts || {};
|
|
1402
|
+
|
|
1388
1403
|
// verify the required parameter 'promptId' is set
|
|
1389
1404
|
if (promptId === undefined || promptId === null) {
|
|
1390
1405
|
throw 'Missing the required parameter "promptId" when calling getArchitectSystemprompt';
|
|
@@ -1394,7 +1409,7 @@ class ArchitectApi {
|
|
|
1394
1409
|
'/api/v2/architect/systemprompts/{promptId}',
|
|
1395
1410
|
'GET',
|
|
1396
1411
|
{ 'promptId': promptId },
|
|
1397
|
-
{
|
|
1412
|
+
{ 'includeMediaUris': opts['includeMediaUris'],'includeResources': opts['includeResources'],'language': this.apiClient.buildCollectionParam(opts['language'], 'multi') },
|
|
1398
1413
|
{ },
|
|
1399
1414
|
{ },
|
|
1400
1415
|
null,
|
|
@@ -1515,6 +1530,9 @@ class ArchitectApi {
|
|
|
1515
1530
|
* @param {String} opts.name Name
|
|
1516
1531
|
* @param {String} opts.description Description
|
|
1517
1532
|
* @param {String} opts.nameOrDescription Name or description
|
|
1533
|
+
* @param {Boolean} opts.includeMediaUris Include the media URIs for each resource (default to true)
|
|
1534
|
+
* @param {Boolean} opts.includeResources Include the resources for each system prompt (default to true)
|
|
1535
|
+
* @param {Array.<String>} opts.language Filter the resources down to the provided languages
|
|
1518
1536
|
*/
|
|
1519
1537
|
getArchitectSystemprompts(opts) {
|
|
1520
1538
|
opts = opts || {};
|
|
@@ -1524,7 +1542,7 @@ class ArchitectApi {
|
|
|
1524
1542
|
'/api/v2/architect/systemprompts',
|
|
1525
1543
|
'GET',
|
|
1526
1544
|
{ },
|
|
1527
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'description': opts['description'],'nameOrDescription': opts['nameOrDescription'] },
|
|
1545
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'name': opts['name'],'description': opts['description'],'nameOrDescription': opts['nameOrDescription'],'includeMediaUris': opts['includeMediaUris'],'includeResources': opts['includeResources'],'language': this.apiClient.buildCollectionParam(opts['language'], 'multi') },
|
|
1528
1546
|
{ },
|
|
1529
1547
|
{ },
|
|
1530
1548
|
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 187.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -179,7 +179,6 @@ class AuthorizationApi {
|
|
|
179
179
|
* @param {String} opts.nextPage next page token
|
|
180
180
|
* @param {String} opts.previousPage Previous page token
|
|
181
181
|
* @param {Boolean} opts.objectCount Include the count of objects contained in the division (default to false)
|
|
182
|
-
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
183
182
|
* @param {String} opts.name Search term to filter by division name
|
|
184
183
|
*/
|
|
185
184
|
getAuthorizationDivisions(opts) {
|
|
@@ -190,7 +189,7 @@ class AuthorizationApi {
|
|
|
190
189
|
'/api/v2/authorization/divisions',
|
|
191
190
|
'GET',
|
|
192
191
|
{ },
|
|
193
|
-
{ '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'],'
|
|
192
|
+
{ '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'] },
|
|
194
193
|
{ },
|
|
195
194
|
{ },
|
|
196
195
|
null,
|
|
@@ -5,7 +5,7 @@ class ChatApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Chat service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 187.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -232,12 +232,6 @@ class ChatApi {
|
|
|
232
232
|
*
|
|
233
233
|
* @param {String} roomJid roomJid
|
|
234
234
|
* @param {Object} opts Optional parameters
|
|
235
|
-
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
236
|
-
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
237
|
-
* @param {String} opts.sortBy variable name requested to sort by
|
|
238
|
-
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
239
|
-
* @param {String} opts.nextPage next page token
|
|
240
|
-
* @param {String} opts.previousPage Previous page token
|
|
241
235
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
242
236
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
243
237
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
@@ -255,7 +249,7 @@ class ChatApi {
|
|
|
255
249
|
'/api/v2/chats/rooms/{roomJid}/messages',
|
|
256
250
|
'GET',
|
|
257
251
|
{ 'roomJid': roomJid },
|
|
258
|
-
{ '
|
|
252
|
+
{ 'limit': opts['limit'],'before': opts['before'],'after': opts['after'] },
|
|
259
253
|
{ },
|
|
260
254
|
{ },
|
|
261
255
|
null,
|
|
@@ -290,12 +284,6 @@ class ChatApi {
|
|
|
290
284
|
*
|
|
291
285
|
* @param {String} threadId threadId
|
|
292
286
|
* @param {Object} opts Optional parameters
|
|
293
|
-
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
294
|
-
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
295
|
-
* @param {String} opts.sortBy variable name requested to sort by
|
|
296
|
-
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
297
|
-
* @param {String} opts.nextPage next page token
|
|
298
|
-
* @param {String} opts.previousPage Previous page token
|
|
299
287
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
300
288
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
301
289
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
@@ -313,7 +301,7 @@ class ChatApi {
|
|
|
313
301
|
'/api/v2/chats/threads/{threadId}/messages',
|
|
314
302
|
'GET',
|
|
315
303
|
{ 'threadId': threadId },
|
|
316
|
-
{ '
|
|
304
|
+
{ 'limit': opts['limit'],'before': opts['before'],'after': opts['after'] },
|
|
317
305
|
{ },
|
|
318
306
|
{ },
|
|
319
307
|
null,
|
|
@@ -359,12 +347,6 @@ class ChatApi {
|
|
|
359
347
|
*
|
|
360
348
|
* @param {String} userId userId
|
|
361
349
|
* @param {Object} opts Optional parameters
|
|
362
|
-
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
363
|
-
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
364
|
-
* @param {String} opts.sortBy variable name requested to sort by
|
|
365
|
-
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
366
|
-
* @param {String} opts.nextPage next page token
|
|
367
|
-
* @param {String} opts.previousPage Previous page token
|
|
368
350
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
369
351
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
370
352
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
@@ -382,7 +364,33 @@ class ChatApi {
|
|
|
382
364
|
'/api/v2/chats/users/{userId}/messages',
|
|
383
365
|
'GET',
|
|
384
366
|
{ 'userId': userId },
|
|
385
|
-
{ '
|
|
367
|
+
{ 'limit': opts['limit'],'before': opts['before'],'after': opts['after'] },
|
|
368
|
+
{ },
|
|
369
|
+
{ },
|
|
370
|
+
null,
|
|
371
|
+
['PureCloud OAuth'],
|
|
372
|
+
['application/json'],
|
|
373
|
+
['application/json']
|
|
374
|
+
);
|
|
375
|
+
}
|
|
376
|
+
|
|
377
|
+
/**
|
|
378
|
+
* Get a user's chat settings
|
|
379
|
+
*
|
|
380
|
+
* @param {String} userId User ID
|
|
381
|
+
* getChatsUserSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
382
|
+
*/
|
|
383
|
+
getChatsUserSettings(userId) {
|
|
384
|
+
// verify the required parameter 'userId' is set
|
|
385
|
+
if (userId === undefined || userId === null) {
|
|
386
|
+
throw 'Missing the required parameter "userId" when calling getChatsUserSettings';
|
|
387
|
+
}
|
|
388
|
+
|
|
389
|
+
return this.apiClient.callApi(
|
|
390
|
+
'/api/v2/chats/users/{userId}/settings',
|
|
391
|
+
'GET',
|
|
392
|
+
{ 'userId': userId },
|
|
393
|
+
{ },
|
|
386
394
|
{ },
|
|
387
395
|
{ },
|
|
388
396
|
null,
|
|
@@ -520,6 +528,37 @@ class ChatApi {
|
|
|
520
528
|
);
|
|
521
529
|
}
|
|
522
530
|
|
|
531
|
+
/**
|
|
532
|
+
* Update a user's chat settings
|
|
533
|
+
*
|
|
534
|
+
* @param {String} userId User ID
|
|
535
|
+
* @param {Object} body
|
|
536
|
+
* patchChatsUserSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
537
|
+
*/
|
|
538
|
+
patchChatsUserSettings(userId, body) {
|
|
539
|
+
// verify the required parameter 'userId' is set
|
|
540
|
+
if (userId === undefined || userId === null) {
|
|
541
|
+
throw 'Missing the required parameter "userId" when calling patchChatsUserSettings';
|
|
542
|
+
}
|
|
543
|
+
// verify the required parameter 'body' is set
|
|
544
|
+
if (body === undefined || body === null) {
|
|
545
|
+
throw 'Missing the required parameter "body" when calling patchChatsUserSettings';
|
|
546
|
+
}
|
|
547
|
+
|
|
548
|
+
return this.apiClient.callApi(
|
|
549
|
+
'/api/v2/chats/users/{userId}/settings',
|
|
550
|
+
'PATCH',
|
|
551
|
+
{ 'userId': userId },
|
|
552
|
+
{ },
|
|
553
|
+
{ },
|
|
554
|
+
{ },
|
|
555
|
+
body,
|
|
556
|
+
['PureCloud OAuth'],
|
|
557
|
+
['application/json'],
|
|
558
|
+
['application/json']
|
|
559
|
+
);
|
|
560
|
+
}
|
|
561
|
+
|
|
523
562
|
/**
|
|
524
563
|
* Send a message to a room
|
|
525
564
|
*
|
|
@@ -5,7 +5,7 @@ class ContentManagementApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* ContentManagement service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 187.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -217,41 +217,6 @@ class ContentManagementApi {
|
|
|
217
217
|
);
|
|
218
218
|
}
|
|
219
219
|
|
|
220
|
-
/**
|
|
221
|
-
* Get a list of audits for a document.
|
|
222
|
-
* This api is deprecated, use https://developer.genesys.cloud/platform/audit/ instead.
|
|
223
|
-
* @param {String} documentId Document ID
|
|
224
|
-
* @param {Object} opts Optional parameters
|
|
225
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
226
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
227
|
-
* @param {String} opts.transactionFilter Transaction filter
|
|
228
|
-
* @param {String} opts.level level (default to USER)
|
|
229
|
-
* @param {String} opts.sortBy Sort by
|
|
230
|
-
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
231
|
-
* @deprecated
|
|
232
|
-
*/
|
|
233
|
-
getContentmanagementDocumentAudits(documentId, opts) {
|
|
234
|
-
opts = opts || {};
|
|
235
|
-
|
|
236
|
-
// verify the required parameter 'documentId' is set
|
|
237
|
-
if (documentId === undefined || documentId === null) {
|
|
238
|
-
throw 'Missing the required parameter "documentId" when calling getContentmanagementDocumentAudits';
|
|
239
|
-
}
|
|
240
|
-
|
|
241
|
-
return this.apiClient.callApi(
|
|
242
|
-
'/api/v2/contentmanagement/documents/{documentId}/audits',
|
|
243
|
-
'GET',
|
|
244
|
-
{ 'documentId': documentId },
|
|
245
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'transactionFilter': opts['transactionFilter'],'level': opts['level'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
|
|
246
|
-
{ },
|
|
247
|
-
{ },
|
|
248
|
-
null,
|
|
249
|
-
['PureCloud OAuth'],
|
|
250
|
-
['application/json'],
|
|
251
|
-
['application/json']
|
|
252
|
-
);
|
|
253
|
-
}
|
|
254
|
-
|
|
255
220
|
/**
|
|
256
221
|
* Download a document.
|
|
257
222
|
*
|
|
@@ -773,32 +738,6 @@ class ContentManagementApi {
|
|
|
773
738
|
);
|
|
774
739
|
}
|
|
775
740
|
|
|
776
|
-
/**
|
|
777
|
-
* Query audits
|
|
778
|
-
* This api is deprecated, use https://developer.genesys.cloud/platform/audit/ instead.
|
|
779
|
-
* @param {Object} body Allows for a filtered query returning facet information
|
|
780
|
-
* @deprecated
|
|
781
|
-
*/
|
|
782
|
-
postContentmanagementAuditquery(body) {
|
|
783
|
-
// verify the required parameter 'body' is set
|
|
784
|
-
if (body === undefined || body === null) {
|
|
785
|
-
throw 'Missing the required parameter "body" when calling postContentmanagementAuditquery';
|
|
786
|
-
}
|
|
787
|
-
|
|
788
|
-
return this.apiClient.callApi(
|
|
789
|
-
'/api/v2/contentmanagement/auditquery',
|
|
790
|
-
'POST',
|
|
791
|
-
{ },
|
|
792
|
-
{ },
|
|
793
|
-
{ },
|
|
794
|
-
{ },
|
|
795
|
-
body,
|
|
796
|
-
['PureCloud OAuth'],
|
|
797
|
-
['application/json'],
|
|
798
|
-
['application/json']
|
|
799
|
-
);
|
|
800
|
-
}
|
|
801
|
-
|
|
802
741
|
/**
|
|
803
742
|
* Update a document.
|
|
804
743
|
*
|
|
@@ -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 187.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -4708,6 +4708,40 @@ class ConversationsApi {
|
|
|
4708
4708
|
);
|
|
4709
4709
|
}
|
|
4710
4710
|
|
|
4711
|
+
/**
|
|
4712
|
+
* Submit feedback for the summary.
|
|
4713
|
+
*
|
|
4714
|
+
* @param {String} conversationId Conversation ID
|
|
4715
|
+
* @param {String} summaryId Summary ID
|
|
4716
|
+
* @param {Object} opts Optional parameters
|
|
4717
|
+
* @param {Object} opts.body
|
|
4718
|
+
*/
|
|
4719
|
+
postConversationSummaryFeedback(conversationId, summaryId, opts) {
|
|
4720
|
+
opts = opts || {};
|
|
4721
|
+
|
|
4722
|
+
// verify the required parameter 'conversationId' is set
|
|
4723
|
+
if (conversationId === undefined || conversationId === null) {
|
|
4724
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationSummaryFeedback';
|
|
4725
|
+
}
|
|
4726
|
+
// verify the required parameter 'summaryId' is set
|
|
4727
|
+
if (summaryId === undefined || summaryId === null) {
|
|
4728
|
+
throw 'Missing the required parameter "summaryId" when calling postConversationSummaryFeedback';
|
|
4729
|
+
}
|
|
4730
|
+
|
|
4731
|
+
return this.apiClient.callApi(
|
|
4732
|
+
'/api/v2/conversations/{conversationId}/summaries/{summaryId}/feedback',
|
|
4733
|
+
'POST',
|
|
4734
|
+
{ 'conversationId': conversationId,'summaryId': summaryId },
|
|
4735
|
+
{ },
|
|
4736
|
+
{ },
|
|
4737
|
+
{ },
|
|
4738
|
+
opts['body'],
|
|
4739
|
+
['PureCloud OAuth'],
|
|
4740
|
+
['application/json'],
|
|
4741
|
+
['application/json']
|
|
4742
|
+
);
|
|
4743
|
+
}
|
|
4744
|
+
|
|
4711
4745
|
/**
|
|
4712
4746
|
* Place a new call as part of a callback conversation.
|
|
4713
4747
|
*
|
|
@@ -6231,9 +6265,10 @@ class ConversationsApi {
|
|
|
6231
6265
|
}
|
|
6232
6266
|
|
|
6233
6267
|
/**
|
|
6234
|
-
* Create a LINE messenger Integration
|
|
6235
|
-
*
|
|
6268
|
+
* Create a LINE messenger Integration (Deprecated)
|
|
6269
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
6236
6270
|
* @param {Object} body LineIntegrationRequest
|
|
6271
|
+
* @deprecated
|
|
6237
6272
|
*/
|
|
6238
6273
|
postConversationsMessagingIntegrationsLine(body) {
|
|
6239
6274
|
// verify the required parameter 'body' is set
|
|
@@ -5,7 +5,7 @@ class ExternalContactsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* ExternalContacts service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 187.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -331,7 +331,7 @@ class ExternalContactsApi {
|
|
|
331
331
|
* @param {Object} opts Optional parameters
|
|
332
332
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
333
333
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
334
|
-
* @param {String} opts.sortOrder
|
|
334
|
+
* @param {String} opts.sortOrder The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. createDate:asc, createDate:desc
|
|
335
335
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
336
336
|
*/
|
|
337
337
|
getExternalcontactsContactNotes(contactId, opts) {
|
|
@@ -392,7 +392,7 @@ class ExternalContactsApi {
|
|
|
392
392
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
393
393
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
394
394
|
* @param {String} opts.q User supplied search keywords (no special syntax is currently supported)
|
|
395
|
-
* @param {String} opts.sortOrder
|
|
395
|
+
* @param {String} opts.sortOrder The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. firstName:asc, title:desc
|
|
396
396
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
397
397
|
*/
|
|
398
398
|
getExternalcontactsContacts(opts) {
|
|
@@ -551,7 +551,7 @@ class ExternalContactsApi {
|
|
|
551
551
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
552
552
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
553
553
|
* @param {String} opts.q User supplied search keywords (no special syntax is currently supported)
|
|
554
|
-
* @param {String} opts.sortOrder
|
|
554
|
+
* @param {String} opts.sortOrder The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. firstName:asc, title:desc
|
|
555
555
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
556
556
|
*/
|
|
557
557
|
getExternalcontactsOrganizationContacts(externalOrganizationId, opts) {
|
|
@@ -617,7 +617,7 @@ class ExternalContactsApi {
|
|
|
617
617
|
* @param {Object} opts Optional parameters
|
|
618
618
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
619
619
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
620
|
-
* @param {String} opts.sortOrder
|
|
620
|
+
* @param {String} opts.sortOrder The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. createDate:asc, createDate:desc
|
|
621
621
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
622
622
|
*/
|
|
623
623
|
getExternalcontactsOrganizationNotes(externalOrganizationId, opts) {
|
|
@@ -650,7 +650,7 @@ class ExternalContactsApi {
|
|
|
650
650
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
651
651
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
652
652
|
* @param {Object} opts.expand which fields, if any, to expand
|
|
653
|
-
* @param {String} opts.sortOrder
|
|
653
|
+
* @param {String} opts.sortOrder The Relationship field to sort by. Any of: [createDate, relationship]. Direction: [asc, desc]. e.g. createDate:asc, relationship:desc
|
|
654
654
|
*/
|
|
655
655
|
getExternalcontactsOrganizationRelationships(externalOrganizationId, opts) {
|
|
656
656
|
opts = opts || {};
|
|
@@ -682,7 +682,7 @@ class ExternalContactsApi {
|
|
|
682
682
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
683
683
|
* @param {String} opts.q Search query
|
|
684
684
|
* @param {Array.<String>} opts.trustorId Search for external organizations by trustorIds (limit 25). If supplied, the 'q' parameters is ignored. Items are returned in the order requested
|
|
685
|
-
* @param {String} opts.sortOrder
|
|
685
|
+
* @param {String} opts.sortOrder The Organization field to sort by. Any of: [companyType, industry, name]. Direction: [asc, desc]. e.g. companyType:asc, industry:desc
|
|
686
686
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
687
687
|
* @param {Boolean} opts.includeTrustors (true or false) whether or not to include trustor information embedded in the externalOrganization
|
|
688
688
|
*/
|