purecloud-platform-client-v2 223.0.0 → 224.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 +1046 -116
- package/dist/web-amd/purecloud-platform-client-v2.js +1046 -116
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +378 -120
- package/dist/web-cjs/purecloud-platform-client-v2.js +378 -120
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +730 -249
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +387 -0
- 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 +2 -2
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +4 -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/BusinessRulesApi.js +49 -4
- 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 +292 -16
- 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 +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 +89 -2
- 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 +27 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +31 -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/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 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +43 -2
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +31 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +2 -2
- 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 +16 -10
- package/src/purecloud-platform-client-v2/index.js +7 -1
|
@@ -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 224.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -595,6 +595,78 @@ class ConversationsApi {
|
|
|
595
595
|
);
|
|
596
596
|
}
|
|
597
597
|
|
|
598
|
+
/**
|
|
599
|
+
* Get message
|
|
600
|
+
*
|
|
601
|
+
* @param {String} conversationId conversationId
|
|
602
|
+
* @param {String} communicationId communicationId
|
|
603
|
+
* @param {String} messageId messageId
|
|
604
|
+
* getConversationCommunicationInternalmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
605
|
+
*/
|
|
606
|
+
getConversationCommunicationInternalmessage(conversationId, communicationId, messageId) {
|
|
607
|
+
// verify the required parameter 'conversationId' is set
|
|
608
|
+
if (conversationId === undefined || conversationId === null) {
|
|
609
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationCommunicationInternalmessage';
|
|
610
|
+
}
|
|
611
|
+
// verify the required parameter 'communicationId' is set
|
|
612
|
+
if (communicationId === undefined || communicationId === null) {
|
|
613
|
+
throw 'Missing the required parameter "communicationId" when calling getConversationCommunicationInternalmessage';
|
|
614
|
+
}
|
|
615
|
+
// verify the required parameter 'messageId' is set
|
|
616
|
+
if (messageId === undefined || messageId === null) {
|
|
617
|
+
throw 'Missing the required parameter "messageId" when calling getConversationCommunicationInternalmessage';
|
|
618
|
+
}
|
|
619
|
+
|
|
620
|
+
return this.apiClient.callApi(
|
|
621
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/internalmessages/{messageId}',
|
|
622
|
+
'GET',
|
|
623
|
+
{ 'conversationId': conversationId,'communicationId': communicationId,'messageId': messageId },
|
|
624
|
+
{ },
|
|
625
|
+
{ },
|
|
626
|
+
{ },
|
|
627
|
+
null,
|
|
628
|
+
['PureCloud OAuth'],
|
|
629
|
+
['application/json'],
|
|
630
|
+
['application/json']
|
|
631
|
+
);
|
|
632
|
+
}
|
|
633
|
+
|
|
634
|
+
/**
|
|
635
|
+
* Get messages for communication
|
|
636
|
+
*
|
|
637
|
+
* @param {String} conversationId conversationId
|
|
638
|
+
* @param {String} communicationId communicationId
|
|
639
|
+
* @param {Object} opts Optional parameters
|
|
640
|
+
* @param {Number} opts.pageSize Indicates maximum number of results in response. Default page size is 25 results. The maximum page size is 200. (default to 25)
|
|
641
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
642
|
+
* getConversationCommunicationInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
643
|
+
*/
|
|
644
|
+
getConversationCommunicationInternalmessages(conversationId, communicationId, opts) {
|
|
645
|
+
opts = opts || {};
|
|
646
|
+
|
|
647
|
+
// verify the required parameter 'conversationId' is set
|
|
648
|
+
if (conversationId === undefined || conversationId === null) {
|
|
649
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationCommunicationInternalmessages';
|
|
650
|
+
}
|
|
651
|
+
// verify the required parameter 'communicationId' is set
|
|
652
|
+
if (communicationId === undefined || communicationId === null) {
|
|
653
|
+
throw 'Missing the required parameter "communicationId" when calling getConversationCommunicationInternalmessages';
|
|
654
|
+
}
|
|
655
|
+
|
|
656
|
+
return this.apiClient.callApi(
|
|
657
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/internalmessages',
|
|
658
|
+
'GET',
|
|
659
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
660
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
661
|
+
{ },
|
|
662
|
+
{ },
|
|
663
|
+
null,
|
|
664
|
+
['PureCloud OAuth'],
|
|
665
|
+
['application/json'],
|
|
666
|
+
['application/json']
|
|
667
|
+
);
|
|
668
|
+
}
|
|
669
|
+
|
|
598
670
|
/**
|
|
599
671
|
* Fetch info on a secure session
|
|
600
672
|
*
|
|
@@ -893,7 +965,7 @@ class ConversationsApi {
|
|
|
893
965
|
* @param {String} participantId participantId
|
|
894
966
|
* @param {String} communicationId communicationId
|
|
895
967
|
* @param {Object} opts Optional parameters
|
|
896
|
-
* @param {Boolean} opts.provisional Indicates
|
|
968
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
897
969
|
*/
|
|
898
970
|
getConversationsCallParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
899
971
|
opts = opts || {};
|
|
@@ -931,7 +1003,7 @@ class ConversationsApi {
|
|
|
931
1003
|
* @param {String} conversationId conversationId
|
|
932
1004
|
* @param {String} participantId participantId
|
|
933
1005
|
* @param {Object} opts Optional parameters
|
|
934
|
-
* @param {Boolean} opts.provisional Indicates
|
|
1006
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
935
1007
|
*/
|
|
936
1008
|
getConversationsCallParticipantWrapup(conversationId, participantId, opts) {
|
|
937
1009
|
opts = opts || {};
|
|
@@ -1021,7 +1093,7 @@ class ConversationsApi {
|
|
|
1021
1093
|
* @param {String} participantId participantId
|
|
1022
1094
|
* @param {String} communicationId communicationId
|
|
1023
1095
|
* @param {Object} opts Optional parameters
|
|
1024
|
-
* @param {Boolean} opts.provisional Indicates
|
|
1096
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
1025
1097
|
*/
|
|
1026
1098
|
getConversationsCallbackParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
1027
1099
|
opts = opts || {};
|
|
@@ -1059,7 +1131,7 @@ class ConversationsApi {
|
|
|
1059
1131
|
* @param {String} conversationId conversationId
|
|
1060
1132
|
* @param {String} participantId participantId
|
|
1061
1133
|
* @param {Object} opts Optional parameters
|
|
1062
|
-
* @param {Boolean} opts.provisional Indicates
|
|
1134
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
1063
1135
|
*/
|
|
1064
1136
|
getConversationsCallbackParticipantWrapup(conversationId, participantId, opts) {
|
|
1065
1137
|
opts = opts || {};
|
|
@@ -1301,7 +1373,7 @@ class ConversationsApi {
|
|
|
1301
1373
|
* @param {String} participantId participantId
|
|
1302
1374
|
* @param {String} communicationId communicationId
|
|
1303
1375
|
* @param {Object} opts Optional parameters
|
|
1304
|
-
* @param {Boolean} opts.provisional Indicates
|
|
1376
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
1305
1377
|
* @deprecated
|
|
1306
1378
|
*/
|
|
1307
1379
|
getConversationsChatParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
@@ -1340,7 +1412,7 @@ class ConversationsApi {
|
|
|
1340
1412
|
* @param {String} conversationId conversationId
|
|
1341
1413
|
* @param {String} participantId participantId
|
|
1342
1414
|
* @param {Object} opts Optional parameters
|
|
1343
|
-
* @param {Boolean} opts.provisional Indicates
|
|
1415
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
1344
1416
|
* @deprecated
|
|
1345
1417
|
*/
|
|
1346
1418
|
getConversationsChatParticipantWrapup(conversationId, participantId, opts) {
|
|
@@ -1453,7 +1525,7 @@ class ConversationsApi {
|
|
|
1453
1525
|
* @param {String} participantId participantId
|
|
1454
1526
|
* @param {String} communicationId communicationId
|
|
1455
1527
|
* @param {Object} opts Optional parameters
|
|
1456
|
-
* @param {Boolean} opts.provisional Indicates
|
|
1528
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
1457
1529
|
* @deprecated
|
|
1458
1530
|
*/
|
|
1459
1531
|
getConversationsCobrowsesessionParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
@@ -1492,7 +1564,7 @@ class ConversationsApi {
|
|
|
1492
1564
|
* @param {String} conversationId conversationId
|
|
1493
1565
|
* @param {String} participantId participantId
|
|
1494
1566
|
* @param {Object} opts Optional parameters
|
|
1495
|
-
* @param {Boolean} opts.provisional Indicates
|
|
1567
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
1496
1568
|
* @deprecated
|
|
1497
1569
|
*/
|
|
1498
1570
|
getConversationsCobrowsesessionParticipantWrapup(conversationId, participantId, opts) {
|
|
@@ -1684,7 +1756,7 @@ class ConversationsApi {
|
|
|
1684
1756
|
* @param {String} participantId participantId
|
|
1685
1757
|
* @param {String} communicationId communicationId
|
|
1686
1758
|
* @param {Object} opts Optional parameters
|
|
1687
|
-
* @param {Boolean} opts.provisional Indicates
|
|
1759
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
1688
1760
|
*/
|
|
1689
1761
|
getConversationsEmailParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
1690
1762
|
opts = opts || {};
|
|
@@ -1722,7 +1794,7 @@ class ConversationsApi {
|
|
|
1722
1794
|
* @param {String} conversationId conversationId
|
|
1723
1795
|
* @param {String} participantId participantId
|
|
1724
1796
|
* @param {Object} opts Optional parameters
|
|
1725
|
-
* @param {Boolean} opts.provisional Indicates
|
|
1797
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
1726
1798
|
*/
|
|
1727
1799
|
getConversationsEmailParticipantWrapup(conversationId, participantId, opts) {
|
|
1728
1800
|
opts = opts || {};
|
|
@@ -1825,6 +1897,53 @@ class ConversationsApi {
|
|
|
1825
1897
|
);
|
|
1826
1898
|
}
|
|
1827
1899
|
|
|
1900
|
+
/**
|
|
1901
|
+
* Get internal message conversation
|
|
1902
|
+
*
|
|
1903
|
+
* @param {String} conversationId conversationId
|
|
1904
|
+
* getConversationsInternalmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1905
|
+
*/
|
|
1906
|
+
getConversationsInternalmessage(conversationId) {
|
|
1907
|
+
// verify the required parameter 'conversationId' is set
|
|
1908
|
+
if (conversationId === undefined || conversationId === null) {
|
|
1909
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationsInternalmessage';
|
|
1910
|
+
}
|
|
1911
|
+
|
|
1912
|
+
return this.apiClient.callApi(
|
|
1913
|
+
'/api/v2/conversations/internalmessages/{conversationId}',
|
|
1914
|
+
'GET',
|
|
1915
|
+
{ 'conversationId': conversationId },
|
|
1916
|
+
{ },
|
|
1917
|
+
{ },
|
|
1918
|
+
{ },
|
|
1919
|
+
null,
|
|
1920
|
+
['PureCloud OAuth'],
|
|
1921
|
+
['application/json'],
|
|
1922
|
+
['application/json']
|
|
1923
|
+
);
|
|
1924
|
+
}
|
|
1925
|
+
|
|
1926
|
+
/**
|
|
1927
|
+
* Get active internal message conversations for the logged in user
|
|
1928
|
+
*
|
|
1929
|
+
* getConversationsInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1930
|
+
*/
|
|
1931
|
+
getConversationsInternalmessages() {
|
|
1932
|
+
|
|
1933
|
+
return this.apiClient.callApi(
|
|
1934
|
+
'/api/v2/conversations/internalmessages',
|
|
1935
|
+
'GET',
|
|
1936
|
+
{ },
|
|
1937
|
+
{ },
|
|
1938
|
+
{ },
|
|
1939
|
+
{ },
|
|
1940
|
+
null,
|
|
1941
|
+
['PureCloud OAuth'],
|
|
1942
|
+
['application/json'],
|
|
1943
|
+
['application/json']
|
|
1944
|
+
);
|
|
1945
|
+
}
|
|
1946
|
+
|
|
1828
1947
|
/**
|
|
1829
1948
|
* Get the encryption key configurations
|
|
1830
1949
|
*
|
|
@@ -2000,7 +2119,7 @@ class ConversationsApi {
|
|
|
2000
2119
|
* @param {String} participantId participantId
|
|
2001
2120
|
* @param {String} communicationId communicationId
|
|
2002
2121
|
* @param {Object} opts Optional parameters
|
|
2003
|
-
* @param {Boolean} opts.provisional Indicates
|
|
2122
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
2004
2123
|
*/
|
|
2005
2124
|
getConversationsMessageParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
2006
2125
|
opts = opts || {};
|
|
@@ -2038,7 +2157,7 @@ class ConversationsApi {
|
|
|
2038
2157
|
* @param {String} conversationId conversationId
|
|
2039
2158
|
* @param {String} participantId participantId
|
|
2040
2159
|
* @param {Object} opts Optional parameters
|
|
2041
|
-
* @param {Boolean} opts.provisional Indicates
|
|
2160
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
2042
2161
|
*/
|
|
2043
2162
|
getConversationsMessageParticipantWrapup(conversationId, participantId, opts) {
|
|
2044
2163
|
opts = opts || {};
|
|
@@ -2308,6 +2427,31 @@ class ConversationsApi {
|
|
|
2308
2427
|
);
|
|
2309
2428
|
}
|
|
2310
2429
|
|
|
2430
|
+
/**
|
|
2431
|
+
* Get X (Formally Twitter) messaging integration identity resolution settings
|
|
2432
|
+
*
|
|
2433
|
+
* @param {String} integrationId Integration Id
|
|
2434
|
+
*/
|
|
2435
|
+
getConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId(integrationId) {
|
|
2436
|
+
// verify the required parameter 'integrationId' is set
|
|
2437
|
+
if (integrationId === undefined || integrationId === null) {
|
|
2438
|
+
throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId';
|
|
2439
|
+
}
|
|
2440
|
+
|
|
2441
|
+
return this.apiClient.callApi(
|
|
2442
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/twitter/{integrationId}',
|
|
2443
|
+
'GET',
|
|
2444
|
+
{ 'integrationId': integrationId },
|
|
2445
|
+
{ },
|
|
2446
|
+
{ },
|
|
2447
|
+
{ },
|
|
2448
|
+
null,
|
|
2449
|
+
['PureCloud OAuth'],
|
|
2450
|
+
['application/json'],
|
|
2451
|
+
['application/json']
|
|
2452
|
+
);
|
|
2453
|
+
}
|
|
2454
|
+
|
|
2311
2455
|
/**
|
|
2312
2456
|
* Get a whatsApp integration Identity Resolution settings
|
|
2313
2457
|
*
|
|
@@ -2858,7 +3002,7 @@ class ConversationsApi {
|
|
|
2858
3002
|
* @param {String} participantId participantId
|
|
2859
3003
|
* @param {String} communicationId communicationId
|
|
2860
3004
|
* @param {Object} opts Optional parameters
|
|
2861
|
-
* @param {Boolean} opts.provisional Indicates
|
|
3005
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
2862
3006
|
* @deprecated
|
|
2863
3007
|
*/
|
|
2864
3008
|
getConversationsScreenshareParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
@@ -2918,7 +3062,7 @@ class ConversationsApi {
|
|
|
2918
3062
|
* @param {String} participantId participantId
|
|
2919
3063
|
* @param {String} communicationId communicationId
|
|
2920
3064
|
* @param {Object} opts Optional parameters
|
|
2921
|
-
* @param {Boolean} opts.provisional Indicates
|
|
3065
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
2922
3066
|
*/
|
|
2923
3067
|
getConversationsSocialParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
2924
3068
|
opts = opts || {};
|
|
@@ -2983,7 +3127,7 @@ class ConversationsApi {
|
|
|
2983
3127
|
* @param {String} participantId participantId
|
|
2984
3128
|
* @param {String} communicationId communicationId
|
|
2985
3129
|
* @param {Object} opts Optional parameters
|
|
2986
|
-
* @param {Boolean} opts.provisional Indicates
|
|
3130
|
+
* @param {Boolean} opts.provisional Indicates whether or not to fetch provisional wrap-up code. (default to false)
|
|
2987
3131
|
*/
|
|
2988
3132
|
getConversationsVideoParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
2989
3133
|
opts = opts || {};
|
|
@@ -4755,6 +4899,42 @@ class ConversationsApi {
|
|
|
4755
4899
|
);
|
|
4756
4900
|
}
|
|
4757
4901
|
|
|
4902
|
+
/**
|
|
4903
|
+
* Send internal message
|
|
4904
|
+
* Send a new internal message for an existing communication.
|
|
4905
|
+
* @param {String} conversationId conversationId
|
|
4906
|
+
* @param {String} communicationId communicationId
|
|
4907
|
+
* @param {Object} body Message
|
|
4908
|
+
* postConversationCommunicationInternalmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4909
|
+
*/
|
|
4910
|
+
postConversationCommunicationInternalmessages(conversationId, communicationId, body) {
|
|
4911
|
+
// verify the required parameter 'conversationId' is set
|
|
4912
|
+
if (conversationId === undefined || conversationId === null) {
|
|
4913
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationCommunicationInternalmessages';
|
|
4914
|
+
}
|
|
4915
|
+
// verify the required parameter 'communicationId' is set
|
|
4916
|
+
if (communicationId === undefined || communicationId === null) {
|
|
4917
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationCommunicationInternalmessages';
|
|
4918
|
+
}
|
|
4919
|
+
// verify the required parameter 'body' is set
|
|
4920
|
+
if (body === undefined || body === null) {
|
|
4921
|
+
throw 'Missing the required parameter "body" when calling postConversationCommunicationInternalmessages';
|
|
4922
|
+
}
|
|
4923
|
+
|
|
4924
|
+
return this.apiClient.callApi(
|
|
4925
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/internalmessages',
|
|
4926
|
+
'POST',
|
|
4927
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
4928
|
+
{ },
|
|
4929
|
+
{ },
|
|
4930
|
+
{ },
|
|
4931
|
+
body,
|
|
4932
|
+
['PureCloud OAuth'],
|
|
4933
|
+
['application/json'],
|
|
4934
|
+
['application/json']
|
|
4935
|
+
);
|
|
4936
|
+
}
|
|
4937
|
+
|
|
4758
4938
|
/**
|
|
4759
4939
|
* Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.
|
|
4760
4940
|
*
|
|
@@ -4848,6 +5028,42 @@ class ConversationsApi {
|
|
|
4848
5028
|
);
|
|
4849
5029
|
}
|
|
4850
5030
|
|
|
5031
|
+
/**
|
|
5032
|
+
* Setup internal message communication with user
|
|
5033
|
+
* The target user of the digital consultation must have the `conversation:internalMessaging:accept` permission.
|
|
5034
|
+
* @param {String} conversationId conversation ID
|
|
5035
|
+
* @param {String} participantId participant ID
|
|
5036
|
+
* @param {Object} body Confer request
|
|
5037
|
+
* postConversationParticipantInternalmessagesUsersCommunications is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5038
|
+
*/
|
|
5039
|
+
postConversationParticipantInternalmessagesUsersCommunications(conversationId, participantId, body) {
|
|
5040
|
+
// verify the required parameter 'conversationId' is set
|
|
5041
|
+
if (conversationId === undefined || conversationId === null) {
|
|
5042
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationParticipantInternalmessagesUsersCommunications';
|
|
5043
|
+
}
|
|
5044
|
+
// verify the required parameter 'participantId' is set
|
|
5045
|
+
if (participantId === undefined || participantId === null) {
|
|
5046
|
+
throw 'Missing the required parameter "participantId" when calling postConversationParticipantInternalmessagesUsersCommunications';
|
|
5047
|
+
}
|
|
5048
|
+
// verify the required parameter 'body' is set
|
|
5049
|
+
if (body === undefined || body === null) {
|
|
5050
|
+
throw 'Missing the required parameter "body" when calling postConversationParticipantInternalmessagesUsersCommunications';
|
|
5051
|
+
}
|
|
5052
|
+
|
|
5053
|
+
return this.apiClient.callApi(
|
|
5054
|
+
'/api/v2/conversations/{conversationId}/participants/{participantId}/internalmessages/users/communications',
|
|
5055
|
+
'POST',
|
|
5056
|
+
{ 'conversationId': conversationId,'participantId': participantId },
|
|
5057
|
+
{ },
|
|
5058
|
+
{ },
|
|
5059
|
+
{ },
|
|
5060
|
+
body,
|
|
5061
|
+
['PureCloud OAuth'],
|
|
5062
|
+
['application/json'],
|
|
5063
|
+
['application/json']
|
|
5064
|
+
);
|
|
5065
|
+
}
|
|
5066
|
+
|
|
4851
5067
|
/**
|
|
4852
5068
|
* Replace this participant with the specified user and/or address
|
|
4853
5069
|
*
|
|
@@ -6487,6 +6703,36 @@ class ConversationsApi {
|
|
|
6487
6703
|
);
|
|
6488
6704
|
}
|
|
6489
6705
|
|
|
6706
|
+
/**
|
|
6707
|
+
* Send inbound Open Response
|
|
6708
|
+
* Send an inbound response for a structured message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
|
|
6709
|
+
* @param {String} integrationId integrationId
|
|
6710
|
+
* @param {Object} body OpenInboundStructuredResponseMessage
|
|
6711
|
+
*/
|
|
6712
|
+
postConversationsMessageInboundOpenStructuredResponse(integrationId, body) {
|
|
6713
|
+
// verify the required parameter 'integrationId' is set
|
|
6714
|
+
if (integrationId === undefined || integrationId === null) {
|
|
6715
|
+
throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenStructuredResponse';
|
|
6716
|
+
}
|
|
6717
|
+
// verify the required parameter 'body' is set
|
|
6718
|
+
if (body === undefined || body === null) {
|
|
6719
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenStructuredResponse';
|
|
6720
|
+
}
|
|
6721
|
+
|
|
6722
|
+
return this.apiClient.callApi(
|
|
6723
|
+
'/api/v2/conversations/messages/{integrationId}/inbound/open/structured/response',
|
|
6724
|
+
'POST',
|
|
6725
|
+
{ 'integrationId': integrationId },
|
|
6726
|
+
{ },
|
|
6727
|
+
{ },
|
|
6728
|
+
{ },
|
|
6729
|
+
body,
|
|
6730
|
+
['PureCloud OAuth'],
|
|
6731
|
+
['application/json'],
|
|
6732
|
+
['application/json']
|
|
6733
|
+
);
|
|
6734
|
+
}
|
|
6735
|
+
|
|
6490
6736
|
/**
|
|
6491
6737
|
* Get messages in batch
|
|
6492
6738
|
* The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: ["a3069a33b-bbb1-4703-9d68-061d9e9db96e", "55bc6be3-078c-4a49-a4e6-1e05776ed7e8"]
|
|
@@ -7595,6 +7841,36 @@ class ConversationsApi {
|
|
|
7595
7841
|
);
|
|
7596
7842
|
}
|
|
7597
7843
|
|
|
7844
|
+
/**
|
|
7845
|
+
* Create an identity resolution settings for an X (Formally Twitter) messaging integration
|
|
7846
|
+
*
|
|
7847
|
+
* @param {String} integrationId Integration Id
|
|
7848
|
+
* @param {Object} body IdentityResolutionConfig
|
|
7849
|
+
*/
|
|
7850
|
+
putConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId(integrationId, body) {
|
|
7851
|
+
// verify the required parameter 'integrationId' is set
|
|
7852
|
+
if (integrationId === undefined || integrationId === null) {
|
|
7853
|
+
throw 'Missing the required parameter "integrationId" when calling putConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId';
|
|
7854
|
+
}
|
|
7855
|
+
// verify the required parameter 'body' is set
|
|
7856
|
+
if (body === undefined || body === null) {
|
|
7857
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessagingIdentityresolutionIntegrationsTwitterIntegrationId';
|
|
7858
|
+
}
|
|
7859
|
+
|
|
7860
|
+
return this.apiClient.callApi(
|
|
7861
|
+
'/api/v2/conversations/messaging/identityresolution/integrations/twitter/{integrationId}',
|
|
7862
|
+
'PUT',
|
|
7863
|
+
{ 'integrationId': integrationId },
|
|
7864
|
+
{ },
|
|
7865
|
+
{ },
|
|
7866
|
+
{ },
|
|
7867
|
+
body,
|
|
7868
|
+
['PureCloud OAuth'],
|
|
7869
|
+
['application/json'],
|
|
7870
|
+
['application/json']
|
|
7871
|
+
);
|
|
7872
|
+
}
|
|
7873
|
+
|
|
7598
7874
|
/**
|
|
7599
7875
|
* Update a whatsApp integration Identity Resolution settings
|
|
7600
7876
|
*
|