purecloud-platform-client-v2 226.0.0 → 228.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 +3 -3
- package/dist/node/purecloud-platform-client-v2.js +1911 -237
- package/dist/web-amd/purecloud-platform-client-v2.js +1911 -237
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +596 -188
- package/dist/web-cjs/purecloud-platform-client-v2.js +596 -188
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1833 -774
- package/package.json +4 -4
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +32 -1
- 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 +391 -26
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- 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/BusinessRulesApi.js +4 -46
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +52 -4
- 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 +61 -35
- 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 +60 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +27 -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 +86 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +30 -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 +101 -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 +53 -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 -26
- 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 +158 -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 +105 -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 +121 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +27 -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 +12 -12
- 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 +6 -6
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +519 -6
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -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 228.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -170,6 +170,26 @@ class ChatApi {
|
|
|
170
170
|
);
|
|
171
171
|
}
|
|
172
172
|
|
|
173
|
+
/**
|
|
174
|
+
* Delete a user's chat settings
|
|
175
|
+
*
|
|
176
|
+
*/
|
|
177
|
+
deleteChatsUsersMeSettings() {
|
|
178
|
+
|
|
179
|
+
return this.apiClient.callApi(
|
|
180
|
+
'/api/v2/chats/users/me/settings',
|
|
181
|
+
'DELETE',
|
|
182
|
+
{ },
|
|
183
|
+
{ },
|
|
184
|
+
{ },
|
|
185
|
+
{ },
|
|
186
|
+
null,
|
|
187
|
+
['PureCloud OAuth'],
|
|
188
|
+
['application/json'],
|
|
189
|
+
['application/json']
|
|
190
|
+
);
|
|
191
|
+
}
|
|
192
|
+
|
|
173
193
|
/**
|
|
174
194
|
* Get a message
|
|
175
195
|
*
|
|
@@ -258,6 +278,7 @@ class ChatApi {
|
|
|
258
278
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
259
279
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
260
280
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
281
|
+
* @param {Boolean} opts.excludeMetadata Whether to exclude metadata for messages
|
|
261
282
|
*/
|
|
262
283
|
getChatsRoomMessages(roomJid, opts) {
|
|
263
284
|
opts = opts || {};
|
|
@@ -271,7 +292,7 @@ class ChatApi {
|
|
|
271
292
|
'/api/v2/chats/rooms/{roomJid}/messages',
|
|
272
293
|
'GET',
|
|
273
294
|
{ 'roomJid': roomJid },
|
|
274
|
-
{ 'limit': opts['limit'],'before': opts['before'],'after': opts['after'] },
|
|
295
|
+
{ 'limit': opts['limit'],'before': opts['before'],'after': opts['after'],'excludeMetadata': opts['excludeMetadata'] },
|
|
275
296
|
{ },
|
|
276
297
|
{ },
|
|
277
298
|
null,
|
|
@@ -368,6 +389,7 @@ class ChatApi {
|
|
|
368
389
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
369
390
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
370
391
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
392
|
+
* @param {Boolean} opts.excludeMetadata Whether to exclude metadata for messages
|
|
371
393
|
*/
|
|
372
394
|
getChatsThreadMessages(threadId, opts) {
|
|
373
395
|
opts = opts || {};
|
|
@@ -381,7 +403,7 @@ class ChatApi {
|
|
|
381
403
|
'/api/v2/chats/threads/{threadId}/messages',
|
|
382
404
|
'GET',
|
|
383
405
|
{ 'threadId': threadId },
|
|
384
|
-
{ 'limit': opts['limit'],'before': opts['before'],'after': opts['after'] },
|
|
406
|
+
{ 'limit': opts['limit'],'before': opts['before'],'after': opts['after'],'excludeMetadata': opts['excludeMetadata'] },
|
|
385
407
|
{ },
|
|
386
408
|
{ },
|
|
387
409
|
null,
|
|
@@ -454,6 +476,7 @@ class ChatApi {
|
|
|
454
476
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
455
477
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
456
478
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
479
|
+
* @param {Boolean} opts.excludeMetadata Whether to exclude metadata for messages
|
|
457
480
|
*/
|
|
458
481
|
getChatsUserMessages(userId, opts) {
|
|
459
482
|
opts = opts || {};
|
|
@@ -467,7 +490,7 @@ class ChatApi {
|
|
|
467
490
|
'/api/v2/chats/users/{userId}/messages',
|
|
468
491
|
'GET',
|
|
469
492
|
{ 'userId': userId },
|
|
470
|
-
{ 'limit': opts['limit'],'before': opts['before'],'after': opts['after'] },
|
|
493
|
+
{ 'limit': opts['limit'],'before': opts['before'],'after': opts['after'],'excludeMetadata': opts['excludeMetadata'] },
|
|
471
494
|
{ },
|
|
472
495
|
{ },
|
|
473
496
|
null,
|
|
@@ -877,6 +900,31 @@ class ChatApi {
|
|
|
877
900
|
);
|
|
878
901
|
}
|
|
879
902
|
|
|
903
|
+
/**
|
|
904
|
+
* Create a user's chat settings
|
|
905
|
+
*
|
|
906
|
+
* @param {Object} body
|
|
907
|
+
*/
|
|
908
|
+
postChatsUsersMeSettings(body) {
|
|
909
|
+
// verify the required parameter 'body' is set
|
|
910
|
+
if (body === undefined || body === null) {
|
|
911
|
+
throw 'Missing the required parameter "body" when calling postChatsUsersMeSettings';
|
|
912
|
+
}
|
|
913
|
+
|
|
914
|
+
return this.apiClient.callApi(
|
|
915
|
+
'/api/v2/chats/users/me/settings',
|
|
916
|
+
'POST',
|
|
917
|
+
{ },
|
|
918
|
+
{ },
|
|
919
|
+
{ },
|
|
920
|
+
{ },
|
|
921
|
+
body,
|
|
922
|
+
['PureCloud OAuth'],
|
|
923
|
+
['application/json'],
|
|
924
|
+
['application/json']
|
|
925
|
+
);
|
|
926
|
+
}
|
|
927
|
+
|
|
880
928
|
/**
|
|
881
929
|
* Update reactions to a message
|
|
882
930
|
*
|
|
@@ -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 228.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -20,6 +20,32 @@ class ConversationsApi {
|
|
|
20
20
|
}
|
|
21
21
|
|
|
22
22
|
|
|
23
|
+
/**
|
|
24
|
+
* Delete/cancel an async request for conversation aggregates
|
|
25
|
+
*
|
|
26
|
+
* @param {String} jobId jobId
|
|
27
|
+
* deleteAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
28
|
+
*/
|
|
29
|
+
deleteAnalyticsConversationsAggregatesJob(jobId) {
|
|
30
|
+
// verify the required parameter 'jobId' is set
|
|
31
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
32
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsConversationsAggregatesJob';
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
return this.apiClient.callApi(
|
|
36
|
+
'/api/v2/analytics/conversations/aggregates/jobs/{jobId}',
|
|
37
|
+
'DELETE',
|
|
38
|
+
{ 'jobId': jobId },
|
|
39
|
+
{ },
|
|
40
|
+
{ },
|
|
41
|
+
{ },
|
|
42
|
+
null,
|
|
43
|
+
['PureCloud OAuth'],
|
|
44
|
+
['application/json'],
|
|
45
|
+
['application/json']
|
|
46
|
+
);
|
|
47
|
+
}
|
|
48
|
+
|
|
23
49
|
/**
|
|
24
50
|
* Delete/cancel an async details job
|
|
25
51
|
*
|
|
@@ -1278,7 +1304,7 @@ class ConversationsApi {
|
|
|
1278
1304
|
|
|
1279
1305
|
/**
|
|
1280
1306
|
* Get chat conversation
|
|
1281
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
1307
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
1282
1308
|
* @param {String} conversationId conversationId
|
|
1283
1309
|
* @deprecated
|
|
1284
1310
|
*/
|
|
@@ -1304,7 +1330,7 @@ class ConversationsApi {
|
|
|
1304
1330
|
|
|
1305
1331
|
/**
|
|
1306
1332
|
* Get a web chat conversation message
|
|
1307
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
1333
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/. The current user must be involved with the conversation to get its messages.
|
|
1308
1334
|
* @param {String} conversationId conversationId
|
|
1309
1335
|
* @param {String} messageId messageId
|
|
1310
1336
|
* @deprecated
|
|
@@ -1335,7 +1361,7 @@ class ConversationsApi {
|
|
|
1335
1361
|
|
|
1336
1362
|
/**
|
|
1337
1363
|
* Get the messages of a chat conversation.
|
|
1338
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
1364
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/. The current user must be involved with the conversation to get its messages.
|
|
1339
1365
|
* @param {String} conversationId conversationId
|
|
1340
1366
|
* @param {Object} opts Optional parameters
|
|
1341
1367
|
* @param {String} opts.after If specified, get the messages chronologically after the id of this message
|
|
@@ -1368,7 +1394,7 @@ class ConversationsApi {
|
|
|
1368
1394
|
|
|
1369
1395
|
/**
|
|
1370
1396
|
* Get the wrap-up for this conversation communication.
|
|
1371
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
1397
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
1372
1398
|
* @param {String} conversationId conversationId
|
|
1373
1399
|
* @param {String} participantId participantId
|
|
1374
1400
|
* @param {String} communicationId communicationId
|
|
@@ -1408,7 +1434,7 @@ class ConversationsApi {
|
|
|
1408
1434
|
|
|
1409
1435
|
/**
|
|
1410
1436
|
* Get the wrap-up for this conversation participant.
|
|
1411
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
1437
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
1412
1438
|
* @param {String} conversationId conversationId
|
|
1413
1439
|
* @param {String} participantId participantId
|
|
1414
1440
|
* @param {Object} opts Optional parameters
|
|
@@ -1443,7 +1469,7 @@ class ConversationsApi {
|
|
|
1443
1469
|
|
|
1444
1470
|
/**
|
|
1445
1471
|
* Get list of wrapup codes for this conversation participant
|
|
1446
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
1472
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
1447
1473
|
* @param {String} conversationId conversationId
|
|
1448
1474
|
* @param {String} participantId participantId
|
|
1449
1475
|
* @deprecated
|
|
@@ -1474,7 +1500,7 @@ class ConversationsApi {
|
|
|
1474
1500
|
|
|
1475
1501
|
/**
|
|
1476
1502
|
* Get active chat conversations for the logged in user
|
|
1477
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
1503
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
1478
1504
|
* @deprecated
|
|
1479
1505
|
*/
|
|
1480
1506
|
getConversationsChats() {
|
|
@@ -1520,7 +1546,7 @@ class ConversationsApi {
|
|
|
1520
1546
|
|
|
1521
1547
|
/**
|
|
1522
1548
|
* Get the wrap-up for this conversation communication.
|
|
1523
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
1549
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
1524
1550
|
* @param {String} conversationId conversationId
|
|
1525
1551
|
* @param {String} participantId participantId
|
|
1526
1552
|
* @param {String} communicationId communicationId
|
|
@@ -1560,7 +1586,7 @@ class ConversationsApi {
|
|
|
1560
1586
|
|
|
1561
1587
|
/**
|
|
1562
1588
|
* Get the wrap-up for this conversation participant.
|
|
1563
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
1589
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
1564
1590
|
* @param {String} conversationId conversationId
|
|
1565
1591
|
* @param {String} participantId participantId
|
|
1566
1592
|
* @param {Object} opts Optional parameters
|
|
@@ -1595,7 +1621,7 @@ class ConversationsApi {
|
|
|
1595
1621
|
|
|
1596
1622
|
/**
|
|
1597
1623
|
* Get list of wrapup codes for this conversation participant
|
|
1598
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
1624
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
1599
1625
|
* @param {String} conversationId conversationId
|
|
1600
1626
|
* @param {String} participantId participantId
|
|
1601
1627
|
* @deprecated
|
|
@@ -2997,7 +3023,7 @@ class ConversationsApi {
|
|
|
2997
3023
|
|
|
2998
3024
|
/**
|
|
2999
3025
|
* Get the wrap-up for this conversation communication.
|
|
3000
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
3026
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
3001
3027
|
* @param {String} conversationId conversationId
|
|
3002
3028
|
* @param {String} participantId participantId
|
|
3003
3029
|
* @param {String} communicationId communicationId
|
|
@@ -3524,7 +3550,7 @@ class ConversationsApi {
|
|
|
3524
3550
|
}
|
|
3525
3551
|
|
|
3526
3552
|
/**
|
|
3527
|
-
* Update conversation participant's communication by disconnecting it.
|
|
3553
|
+
* Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup.
|
|
3528
3554
|
*
|
|
3529
3555
|
* @param {String} conversationId conversationId
|
|
3530
3556
|
* @param {String} participantId participantId
|
|
@@ -3765,7 +3791,7 @@ class ConversationsApi {
|
|
|
3765
3791
|
|
|
3766
3792
|
/**
|
|
3767
3793
|
* Update a conversation by disconnecting all of the participants
|
|
3768
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
3794
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
3769
3795
|
* @param {String} conversationId conversationId
|
|
3770
3796
|
* @param {Object} body Conversation
|
|
3771
3797
|
* @deprecated
|
|
@@ -3796,7 +3822,7 @@ class ConversationsApi {
|
|
|
3796
3822
|
|
|
3797
3823
|
/**
|
|
3798
3824
|
* Update conversation participant
|
|
3799
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
3825
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
3800
3826
|
* @param {String} conversationId conversationId
|
|
3801
3827
|
* @param {String} participantId participantId
|
|
3802
3828
|
* @param {Object} body Update request
|
|
@@ -3832,7 +3858,7 @@ class ConversationsApi {
|
|
|
3832
3858
|
|
|
3833
3859
|
/**
|
|
3834
3860
|
* Update the attributes on a conversation participant.
|
|
3835
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
3861
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
3836
3862
|
* @param {String} conversationId conversationId
|
|
3837
3863
|
* @param {String} participantId participantId
|
|
3838
3864
|
* @param {Object} body Participant attributes
|
|
@@ -3867,8 +3893,8 @@ class ConversationsApi {
|
|
|
3867
3893
|
}
|
|
3868
3894
|
|
|
3869
3895
|
/**
|
|
3870
|
-
* Update conversation participant's communication by disconnecting it.
|
|
3871
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
3896
|
+
* Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup.
|
|
3897
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
3872
3898
|
* @param {String} conversationId conversationId
|
|
3873
3899
|
* @param {String} participantId participantId
|
|
3874
3900
|
* @param {String} communicationId communicationId
|
|
@@ -3909,7 +3935,7 @@ class ConversationsApi {
|
|
|
3909
3935
|
|
|
3910
3936
|
/**
|
|
3911
3937
|
* Update a conversation by disconnecting all of the participants
|
|
3912
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
3938
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
3913
3939
|
* @param {String} conversationId conversationId
|
|
3914
3940
|
* @param {Object} body Conversation
|
|
3915
3941
|
* @deprecated
|
|
@@ -3940,7 +3966,7 @@ class ConversationsApi {
|
|
|
3940
3966
|
|
|
3941
3967
|
/**
|
|
3942
3968
|
* Update conversation participant
|
|
3943
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
3969
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
3944
3970
|
* @param {String} conversationId conversationId
|
|
3945
3971
|
* @param {String} participantId participantId
|
|
3946
3972
|
* @param {Object} opts Optional parameters
|
|
@@ -3975,7 +4001,7 @@ class ConversationsApi {
|
|
|
3975
4001
|
|
|
3976
4002
|
/**
|
|
3977
4003
|
* Update the attributes on a conversation participant.
|
|
3978
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
4004
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
3979
4005
|
* @param {String} conversationId conversationId
|
|
3980
4006
|
* @param {String} participantId participantId
|
|
3981
4007
|
* @param {Object} opts Optional parameters
|
|
@@ -4010,7 +4036,7 @@ class ConversationsApi {
|
|
|
4010
4036
|
|
|
4011
4037
|
/**
|
|
4012
4038
|
* Update conversation participant's communication by disconnecting it.
|
|
4013
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
4039
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
4014
4040
|
* @param {String} conversationId conversationId
|
|
4015
4041
|
* @param {String} participantId participantId
|
|
4016
4042
|
* @param {String} communicationId communicationId
|
|
@@ -4181,7 +4207,7 @@ class ConversationsApi {
|
|
|
4181
4207
|
}
|
|
4182
4208
|
|
|
4183
4209
|
/**
|
|
4184
|
-
* Update conversation participant's communication by disconnecting it.
|
|
4210
|
+
* Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup.
|
|
4185
4211
|
*
|
|
4186
4212
|
* @param {String} conversationId conversationId
|
|
4187
4213
|
* @param {String} participantId participantId
|
|
@@ -4354,7 +4380,7 @@ class ConversationsApi {
|
|
|
4354
4380
|
}
|
|
4355
4381
|
|
|
4356
4382
|
/**
|
|
4357
|
-
* Update conversation participant's communication by disconnecting it.
|
|
4383
|
+
* Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup.
|
|
4358
4384
|
*
|
|
4359
4385
|
* @param {String} conversationId conversationId
|
|
4360
4386
|
* @param {String} participantId participantId
|
|
@@ -6022,7 +6048,7 @@ class ConversationsApi {
|
|
|
6022
6048
|
|
|
6023
6049
|
/**
|
|
6024
6050
|
* Send a message on behalf of a communication in a chat conversation.
|
|
6025
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
6051
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
6026
6052
|
* @param {String} conversationId conversationId
|
|
6027
6053
|
* @param {String} communicationId communicationId
|
|
6028
6054
|
* @param {Object} body Message
|
|
@@ -6058,7 +6084,7 @@ class ConversationsApi {
|
|
|
6058
6084
|
|
|
6059
6085
|
/**
|
|
6060
6086
|
* Send a typing-indicator on behalf of a communication in a chat conversation.
|
|
6061
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
6087
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
6062
6088
|
* @param {String} conversationId conversationId
|
|
6063
6089
|
* @param {String} communicationId communicationId
|
|
6064
6090
|
* @deprecated
|
|
@@ -6089,7 +6115,7 @@ class ConversationsApi {
|
|
|
6089
6115
|
|
|
6090
6116
|
/**
|
|
6091
6117
|
* Apply wrap-up for this conversation communication
|
|
6092
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
6118
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
6093
6119
|
* @param {String} conversationId conversationId
|
|
6094
6120
|
* @param {String} participantId participantId
|
|
6095
6121
|
* @param {String} communicationId communicationId
|
|
@@ -6129,7 +6155,7 @@ class ConversationsApi {
|
|
|
6129
6155
|
|
|
6130
6156
|
/**
|
|
6131
6157
|
* Replace this participant with the specified user and/or address
|
|
6132
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
6158
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
6133
6159
|
* @param {String} conversationId conversationId
|
|
6134
6160
|
* @param {String} participantId participantId
|
|
6135
6161
|
* @param {Object} body Transfer request
|
|
@@ -6165,7 +6191,7 @@ class ConversationsApi {
|
|
|
6165
6191
|
|
|
6166
6192
|
/**
|
|
6167
6193
|
* Create a web chat conversation
|
|
6168
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
6194
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
6169
6195
|
* @param {Object} body Create web chat request
|
|
6170
6196
|
* @deprecated
|
|
6171
6197
|
*/
|
|
@@ -6191,7 +6217,7 @@ class ConversationsApi {
|
|
|
6191
6217
|
|
|
6192
6218
|
/**
|
|
6193
6219
|
* Apply wrap-up for this conversation communication
|
|
6194
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
6220
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
6195
6221
|
* @param {String} conversationId conversationId
|
|
6196
6222
|
* @param {String} participantId participantId
|
|
6197
6223
|
* @param {String} communicationId communicationId
|
|
@@ -6231,7 +6257,7 @@ class ConversationsApi {
|
|
|
6231
6257
|
|
|
6232
6258
|
/**
|
|
6233
6259
|
* Replace this participant with the specified user and/or address
|
|
6234
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
6260
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
6235
6261
|
* @param {String} conversationId conversationId
|
|
6236
6262
|
* @param {String} participantId participantId
|
|
6237
6263
|
* @param {Object} opts Optional parameters
|
|
@@ -7319,7 +7345,7 @@ class ConversationsApi {
|
|
|
7319
7345
|
|
|
7320
7346
|
/**
|
|
7321
7347
|
* Apply wrap-up for this conversation communication
|
|
7322
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
7348
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
7323
7349
|
* @param {String} conversationId conversationId
|
|
7324
7350
|
* @param {String} participantId participantId
|
|
7325
7351
|
* @param {String} communicationId communicationId
|
|
@@ -7684,7 +7710,7 @@ class ConversationsApi {
|
|
|
7684
7710
|
|
|
7685
7711
|
/**
|
|
7686
7712
|
* Update a conversation by setting its recording state
|
|
7687
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
7713
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
7688
7714
|
* @param {String} conversationId conversationId
|
|
7689
7715
|
* @param {Object} body SetRecordingState
|
|
7690
7716
|
* @deprecated
|
|
@@ -7715,7 +7741,7 @@ class ConversationsApi {
|
|
|
7715
7741
|
|
|
7716
7742
|
/**
|
|
7717
7743
|
* Update a conversation by setting its recording state
|
|
7718
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
7744
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
7719
7745
|
* @param {String} conversationId conversationId
|
|
7720
7746
|
* @param {Object} body SetRecordingState
|
|
7721
7747
|
* @deprecated
|
|
@@ -8122,7 +8148,7 @@ class ConversationsApi {
|
|
|
8122
8148
|
|
|
8123
8149
|
/**
|
|
8124
8150
|
* Update a conversation by setting its recording state
|
|
8125
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
8151
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
8126
8152
|
* @param {String} conversationId conversationId
|
|
8127
8153
|
* @param {Object} body SetRecordingState
|
|
8128
8154
|
* @deprecated
|
|
@@ -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 228.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -334,6 +334,36 @@ class ExternalContactsApi {
|
|
|
334
334
|
);
|
|
335
335
|
}
|
|
336
336
|
|
|
337
|
+
/**
|
|
338
|
+
* Retrieve segment assignments by external contact ID.
|
|
339
|
+
*
|
|
340
|
+
* @param {String} contactId ExternalContact ID
|
|
341
|
+
* @param {Object} opts Optional parameters
|
|
342
|
+
* @param {Boolean} opts.includeMerged Indicates whether to return segment assignments from all external contacts in the merge-set of the given one.
|
|
343
|
+
* @param {Number} opts.limit Number of entities to return. Default of 25, maximum of 500.
|
|
344
|
+
*/
|
|
345
|
+
getExternalcontactsContactJourneySegments(contactId, opts) {
|
|
346
|
+
opts = opts || {};
|
|
347
|
+
|
|
348
|
+
// verify the required parameter 'contactId' is set
|
|
349
|
+
if (contactId === undefined || contactId === null || contactId === '') {
|
|
350
|
+
throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactJourneySegments';
|
|
351
|
+
}
|
|
352
|
+
|
|
353
|
+
return this.apiClient.callApi(
|
|
354
|
+
'/api/v2/externalcontacts/contacts/{contactId}/journey/segments',
|
|
355
|
+
'GET',
|
|
356
|
+
{ 'contactId': contactId },
|
|
357
|
+
{ 'includeMerged': opts['includeMerged'],'limit': opts['limit'] },
|
|
358
|
+
{ },
|
|
359
|
+
{ },
|
|
360
|
+
null,
|
|
361
|
+
['PureCloud OAuth'],
|
|
362
|
+
['application/json'],
|
|
363
|
+
['application/json']
|
|
364
|
+
);
|
|
365
|
+
}
|
|
366
|
+
|
|
337
367
|
/**
|
|
338
368
|
* Retrieve all sessions for a given external contact.
|
|
339
369
|
*
|
|
@@ -2205,6 +2235,35 @@ class ExternalContactsApi {
|
|
|
2205
2235
|
);
|
|
2206
2236
|
}
|
|
2207
2237
|
|
|
2238
|
+
/**
|
|
2239
|
+
* Assign/Unassign up to 10 segments to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment. Any unprocessed segment assignments are returned in the body for the client to retry, in the event of a partial success.
|
|
2240
|
+
*
|
|
2241
|
+
* @param {String} contactId ExternalContact ID
|
|
2242
|
+
* @param {Object} opts Optional parameters
|
|
2243
|
+
* @param {Object} opts.body
|
|
2244
|
+
*/
|
|
2245
|
+
postExternalcontactsContactJourneySegments(contactId, opts) {
|
|
2246
|
+
opts = opts || {};
|
|
2247
|
+
|
|
2248
|
+
// verify the required parameter 'contactId' is set
|
|
2249
|
+
if (contactId === undefined || contactId === null || contactId === '') {
|
|
2250
|
+
throw 'Missing the required parameter "contactId" when calling postExternalcontactsContactJourneySegments';
|
|
2251
|
+
}
|
|
2252
|
+
|
|
2253
|
+
return this.apiClient.callApi(
|
|
2254
|
+
'/api/v2/externalcontacts/contacts/{contactId}/journey/segments',
|
|
2255
|
+
'POST',
|
|
2256
|
+
{ 'contactId': contactId },
|
|
2257
|
+
{ },
|
|
2258
|
+
{ },
|
|
2259
|
+
{ },
|
|
2260
|
+
opts['body'],
|
|
2261
|
+
['PureCloud OAuth'],
|
|
2262
|
+
['application/json'],
|
|
2263
|
+
['application/json']
|
|
2264
|
+
);
|
|
2265
|
+
}
|
|
2266
|
+
|
|
2208
2267
|
/**
|
|
2209
2268
|
* Create a note for an external contact
|
|
2210
2269
|
*
|