purecloud-platform-client-v2 191.0.0 → 192.1.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 +448 -170
- package/dist/web-amd/purecloud-platform-client-v2.js +448 -170
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +211 -128
- package/dist/web-cjs/purecloud-platform-client-v2.js +259 -163
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +528 -258
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- 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 +13 -5
- 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 +127 -39
- 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 -16
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +45 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -2
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +22 -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 +4 -3
- 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 +3 -3
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -2
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +79 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -22
- 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 +8 -3
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +13 -5
- 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 +5 -3
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/package.json
CHANGED
|
@@ -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 192.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -565,8 +565,12 @@ class AuthorizationApi {
|
|
|
565
565
|
* Returns a listing of roles and permissions for a user.
|
|
566
566
|
*
|
|
567
567
|
* @param {String} subjectId Subject ID (user or group)
|
|
568
|
+
* @param {Object} opts Optional parameters
|
|
569
|
+
* @param {Object} opts.includeDuplicates Include multiple entries with the same role and division but different subjects (default to false)
|
|
568
570
|
*/
|
|
569
|
-
getAuthorizationSubject(subjectId) {
|
|
571
|
+
getAuthorizationSubject(subjectId, opts) {
|
|
572
|
+
opts = opts || {};
|
|
573
|
+
|
|
570
574
|
// verify the required parameter 'subjectId' is set
|
|
571
575
|
if (subjectId === undefined || subjectId === null) {
|
|
572
576
|
throw 'Missing the required parameter "subjectId" when calling getAuthorizationSubject';
|
|
@@ -576,7 +580,7 @@ class AuthorizationApi {
|
|
|
576
580
|
'/api/v2/authorization/subjects/{subjectId}',
|
|
577
581
|
'GET',
|
|
578
582
|
{ 'subjectId': subjectId },
|
|
579
|
-
{
|
|
583
|
+
{ 'includeDuplicates': opts['includeDuplicates'] },
|
|
580
584
|
{ },
|
|
581
585
|
{ },
|
|
582
586
|
null,
|
|
@@ -589,14 +593,18 @@ class AuthorizationApi {
|
|
|
589
593
|
/**
|
|
590
594
|
* Returns a listing of roles and permissions for the currently authenticated user.
|
|
591
595
|
*
|
|
596
|
+
* @param {Object} opts Optional parameters
|
|
597
|
+
* @param {Object} opts.includeDuplicates Include multiple entries with the same role and division but different subjects (default to false)
|
|
592
598
|
*/
|
|
593
|
-
getAuthorizationSubjectsMe() {
|
|
599
|
+
getAuthorizationSubjectsMe(opts) {
|
|
600
|
+
opts = opts || {};
|
|
601
|
+
|
|
594
602
|
|
|
595
603
|
return this.apiClient.callApi(
|
|
596
604
|
'/api/v2/authorization/subjects/me',
|
|
597
605
|
'GET',
|
|
598
606
|
{ },
|
|
599
|
-
{
|
|
607
|
+
{ 'includeDuplicates': opts['includeDuplicates'] },
|
|
600
608
|
{ },
|
|
601
609
|
{ },
|
|
602
610
|
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 192.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -51,25 +51,25 @@ class ChatApi {
|
|
|
51
51
|
}
|
|
52
52
|
|
|
53
53
|
/**
|
|
54
|
-
* Remove a
|
|
54
|
+
* Remove a pinned message from a room
|
|
55
55
|
*
|
|
56
56
|
* @param {String} roomJid roomJid
|
|
57
|
-
* @param {String}
|
|
57
|
+
* @param {String} pinnedMessageId pinnedMessageId
|
|
58
58
|
*/
|
|
59
|
-
|
|
59
|
+
deleteChatsRoomMessagesPin(roomJid, pinnedMessageId) {
|
|
60
60
|
// verify the required parameter 'roomJid' is set
|
|
61
61
|
if (roomJid === undefined || roomJid === null) {
|
|
62
|
-
throw 'Missing the required parameter "roomJid" when calling
|
|
62
|
+
throw 'Missing the required parameter "roomJid" when calling deleteChatsRoomMessagesPin';
|
|
63
63
|
}
|
|
64
|
-
// verify the required parameter '
|
|
65
|
-
if (
|
|
66
|
-
throw 'Missing the required parameter "
|
|
64
|
+
// verify the required parameter 'pinnedMessageId' is set
|
|
65
|
+
if (pinnedMessageId === undefined || pinnedMessageId === null) {
|
|
66
|
+
throw 'Missing the required parameter "pinnedMessageId" when calling deleteChatsRoomMessagesPin';
|
|
67
67
|
}
|
|
68
68
|
|
|
69
69
|
return this.apiClient.callApi(
|
|
70
|
-
'/api/v2/chats/rooms/{roomJid}/
|
|
70
|
+
'/api/v2/chats/rooms/{roomJid}/messages/pins/{pinnedMessageId}',
|
|
71
71
|
'DELETE',
|
|
72
|
-
{ 'roomJid': roomJid,'
|
|
72
|
+
{ 'roomJid': roomJid,'pinnedMessageId': pinnedMessageId },
|
|
73
73
|
{ },
|
|
74
74
|
{ },
|
|
75
75
|
{ },
|
|
@@ -81,25 +81,25 @@ class ChatApi {
|
|
|
81
81
|
}
|
|
82
82
|
|
|
83
83
|
/**
|
|
84
|
-
* Remove a
|
|
84
|
+
* Remove a user from a room.
|
|
85
85
|
*
|
|
86
86
|
* @param {String} roomJid roomJid
|
|
87
|
-
* @param {String}
|
|
87
|
+
* @param {String} userId userId
|
|
88
88
|
*/
|
|
89
|
-
|
|
89
|
+
deleteChatsRoomParticipant(roomJid, userId) {
|
|
90
90
|
// verify the required parameter 'roomJid' is set
|
|
91
91
|
if (roomJid === undefined || roomJid === null) {
|
|
92
|
-
throw 'Missing the required parameter "roomJid" when calling
|
|
92
|
+
throw 'Missing the required parameter "roomJid" when calling deleteChatsRoomParticipant';
|
|
93
93
|
}
|
|
94
|
-
// verify the required parameter '
|
|
95
|
-
if (
|
|
96
|
-
throw 'Missing the required parameter "
|
|
94
|
+
// verify the required parameter 'userId' is set
|
|
95
|
+
if (userId === undefined || userId === null) {
|
|
96
|
+
throw 'Missing the required parameter "userId" when calling deleteChatsRoomParticipant';
|
|
97
97
|
}
|
|
98
98
|
|
|
99
99
|
return this.apiClient.callApi(
|
|
100
|
-
'/api/v2/chats/rooms/{roomJid}/
|
|
100
|
+
'/api/v2/chats/rooms/{roomJid}/participants/{userId}',
|
|
101
101
|
'DELETE',
|
|
102
|
-
{ 'roomJid': roomJid,'
|
|
102
|
+
{ 'roomJid': roomJid,'userId': userId },
|
|
103
103
|
{ },
|
|
104
104
|
{ },
|
|
105
105
|
{ },
|
|
@@ -140,6 +140,37 @@ class ChatApi {
|
|
|
140
140
|
);
|
|
141
141
|
}
|
|
142
142
|
|
|
143
|
+
/**
|
|
144
|
+
* Remove a pinned message from a 1on1
|
|
145
|
+
*
|
|
146
|
+
* @param {String} userId userId
|
|
147
|
+
* @param {String} pinnedMessageId pinnedMessageId
|
|
148
|
+
* deleteChatsUserMessagesPin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
149
|
+
*/
|
|
150
|
+
deleteChatsUserMessagesPin(userId, pinnedMessageId) {
|
|
151
|
+
// verify the required parameter 'userId' is set
|
|
152
|
+
if (userId === undefined || userId === null) {
|
|
153
|
+
throw 'Missing the required parameter "userId" when calling deleteChatsUserMessagesPin';
|
|
154
|
+
}
|
|
155
|
+
// verify the required parameter 'pinnedMessageId' is set
|
|
156
|
+
if (pinnedMessageId === undefined || pinnedMessageId === null) {
|
|
157
|
+
throw 'Missing the required parameter "pinnedMessageId" when calling deleteChatsUserMessagesPin';
|
|
158
|
+
}
|
|
159
|
+
|
|
160
|
+
return this.apiClient.callApi(
|
|
161
|
+
'/api/v2/chats/users/{userId}/messages/pins/{pinnedMessageId}',
|
|
162
|
+
'DELETE',
|
|
163
|
+
{ 'userId': userId,'pinnedMessageId': pinnedMessageId },
|
|
164
|
+
{ },
|
|
165
|
+
{ },
|
|
166
|
+
{ },
|
|
167
|
+
null,
|
|
168
|
+
['PureCloud OAuth'],
|
|
169
|
+
['application/json'],
|
|
170
|
+
['application/json']
|
|
171
|
+
);
|
|
172
|
+
}
|
|
173
|
+
|
|
143
174
|
/**
|
|
144
175
|
* Get a message
|
|
145
176
|
*
|
|
@@ -357,6 +388,32 @@ class ChatApi {
|
|
|
357
388
|
);
|
|
358
389
|
}
|
|
359
390
|
|
|
391
|
+
/**
|
|
392
|
+
* Get information for a 1on1
|
|
393
|
+
*
|
|
394
|
+
* @param {String} userId userId
|
|
395
|
+
* getChatsUser is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
396
|
+
*/
|
|
397
|
+
getChatsUser(userId) {
|
|
398
|
+
// verify the required parameter 'userId' is set
|
|
399
|
+
if (userId === undefined || userId === null) {
|
|
400
|
+
throw 'Missing the required parameter "userId" when calling getChatsUser';
|
|
401
|
+
}
|
|
402
|
+
|
|
403
|
+
return this.apiClient.callApi(
|
|
404
|
+
'/api/v2/chats/users/{userId}',
|
|
405
|
+
'GET',
|
|
406
|
+
{ 'userId': userId },
|
|
407
|
+
{ },
|
|
408
|
+
{ },
|
|
409
|
+
{ },
|
|
410
|
+
null,
|
|
411
|
+
['PureCloud OAuth'],
|
|
412
|
+
['application/json'],
|
|
413
|
+
['application/json']
|
|
414
|
+
);
|
|
415
|
+
}
|
|
416
|
+
|
|
360
417
|
/**
|
|
361
418
|
* Get messages by id(s) from a 1on1
|
|
362
419
|
*
|
|
@@ -631,29 +688,29 @@ class ChatApi {
|
|
|
631
688
|
}
|
|
632
689
|
|
|
633
690
|
/**
|
|
634
|
-
*
|
|
691
|
+
* Add pinned messages for a room, up to a maximum of 5 pinned messages
|
|
635
692
|
*
|
|
636
693
|
* @param {String} roomJid roomJid
|
|
637
|
-
* @param {
|
|
694
|
+
* @param {Object} body Pinned Message Ids
|
|
638
695
|
*/
|
|
639
|
-
|
|
696
|
+
postChatsRoomMessagesPins(roomJid, body) {
|
|
640
697
|
// verify the required parameter 'roomJid' is set
|
|
641
698
|
if (roomJid === undefined || roomJid === null) {
|
|
642
|
-
throw 'Missing the required parameter "roomJid" when calling
|
|
699
|
+
throw 'Missing the required parameter "roomJid" when calling postChatsRoomMessagesPins';
|
|
643
700
|
}
|
|
644
|
-
// verify the required parameter '
|
|
645
|
-
if (
|
|
646
|
-
throw 'Missing the required parameter "
|
|
701
|
+
// verify the required parameter 'body' is set
|
|
702
|
+
if (body === undefined || body === null) {
|
|
703
|
+
throw 'Missing the required parameter "body" when calling postChatsRoomMessagesPins';
|
|
647
704
|
}
|
|
648
705
|
|
|
649
706
|
return this.apiClient.callApi(
|
|
650
|
-
'/api/v2/chats/rooms/{roomJid}/
|
|
707
|
+
'/api/v2/chats/rooms/{roomJid}/messages/pins',
|
|
651
708
|
'POST',
|
|
652
|
-
{ 'roomJid': roomJid
|
|
709
|
+
{ 'roomJid': roomJid },
|
|
653
710
|
{ },
|
|
654
711
|
{ },
|
|
655
712
|
{ },
|
|
656
|
-
|
|
713
|
+
body,
|
|
657
714
|
['PureCloud OAuth'],
|
|
658
715
|
['application/json'],
|
|
659
716
|
['application/json']
|
|
@@ -661,29 +718,29 @@ class ChatApi {
|
|
|
661
718
|
}
|
|
662
719
|
|
|
663
720
|
/**
|
|
664
|
-
*
|
|
721
|
+
* Join a room
|
|
665
722
|
*
|
|
666
723
|
* @param {String} roomJid roomJid
|
|
667
|
-
* @param {
|
|
724
|
+
* @param {String} userId userId
|
|
668
725
|
*/
|
|
669
|
-
|
|
726
|
+
postChatsRoomParticipant(roomJid, userId) {
|
|
670
727
|
// verify the required parameter 'roomJid' is set
|
|
671
728
|
if (roomJid === undefined || roomJid === null) {
|
|
672
|
-
throw 'Missing the required parameter "roomJid" when calling
|
|
729
|
+
throw 'Missing the required parameter "roomJid" when calling postChatsRoomParticipant';
|
|
673
730
|
}
|
|
674
|
-
// verify the required parameter '
|
|
675
|
-
if (
|
|
676
|
-
throw 'Missing the required parameter "
|
|
731
|
+
// verify the required parameter 'userId' is set
|
|
732
|
+
if (userId === undefined || userId === null) {
|
|
733
|
+
throw 'Missing the required parameter "userId" when calling postChatsRoomParticipant';
|
|
677
734
|
}
|
|
678
735
|
|
|
679
736
|
return this.apiClient.callApi(
|
|
680
|
-
'/api/v2/chats/rooms/{roomJid}/
|
|
737
|
+
'/api/v2/chats/rooms/{roomJid}/participants/{userId}',
|
|
681
738
|
'POST',
|
|
682
|
-
{ 'roomJid': roomJid },
|
|
739
|
+
{ 'roomJid': roomJid,'userId': userId },
|
|
683
740
|
{ },
|
|
684
741
|
{ },
|
|
685
742
|
{ },
|
|
686
|
-
|
|
743
|
+
null,
|
|
687
744
|
['PureCloud OAuth'],
|
|
688
745
|
['application/json'],
|
|
689
746
|
['application/json']
|
|
@@ -745,6 +802,37 @@ class ChatApi {
|
|
|
745
802
|
);
|
|
746
803
|
}
|
|
747
804
|
|
|
805
|
+
/**
|
|
806
|
+
* Add pinned messages for a 1on1, up to a maximum of 5 pinned messages
|
|
807
|
+
*
|
|
808
|
+
* @param {String} userId userId
|
|
809
|
+
* @param {Object} body Pinned Message Ids
|
|
810
|
+
* postChatsUserMessagesPins is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
811
|
+
*/
|
|
812
|
+
postChatsUserMessagesPins(userId, body) {
|
|
813
|
+
// verify the required parameter 'userId' is set
|
|
814
|
+
if (userId === undefined || userId === null) {
|
|
815
|
+
throw 'Missing the required parameter "userId" when calling postChatsUserMessagesPins';
|
|
816
|
+
}
|
|
817
|
+
// verify the required parameter 'body' is set
|
|
818
|
+
if (body === undefined || body === null) {
|
|
819
|
+
throw 'Missing the required parameter "body" when calling postChatsUserMessagesPins';
|
|
820
|
+
}
|
|
821
|
+
|
|
822
|
+
return this.apiClient.callApi(
|
|
823
|
+
'/api/v2/chats/users/{userId}/messages/pins',
|
|
824
|
+
'POST',
|
|
825
|
+
{ 'userId': userId },
|
|
826
|
+
{ },
|
|
827
|
+
{ },
|
|
828
|
+
{ },
|
|
829
|
+
body,
|
|
830
|
+
['PureCloud OAuth'],
|
|
831
|
+
['application/json'],
|
|
832
|
+
['application/json']
|
|
833
|
+
);
|
|
834
|
+
}
|
|
835
|
+
|
|
748
836
|
/**
|
|
749
837
|
* Update reactions to a message
|
|
750
838
|
*
|
|
@@ -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 192.1.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1380,12 +1380,13 @@ class ConversationsApi {
|
|
|
1380
1380
|
|
|
1381
1381
|
/**
|
|
1382
1382
|
* Get the wrap-up for this conversation communication.
|
|
1383
|
-
*
|
|
1383
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
1384
1384
|
* @param {String} conversationId conversationId
|
|
1385
1385
|
* @param {String} participantId participantId
|
|
1386
1386
|
* @param {String} communicationId communicationId
|
|
1387
1387
|
* @param {Object} opts Optional parameters
|
|
1388
1388
|
* @param {Boolean} opts.provisional Indicates if the wrap-up code is provisional. (default to false)
|
|
1389
|
+
* @deprecated
|
|
1389
1390
|
*/
|
|
1390
1391
|
getConversationsCobrowsesessionParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
1391
1392
|
opts = opts || {};
|
|
@@ -1419,11 +1420,12 @@ class ConversationsApi {
|
|
|
1419
1420
|
|
|
1420
1421
|
/**
|
|
1421
1422
|
* Get the wrap-up for this conversation participant.
|
|
1422
|
-
*
|
|
1423
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
1423
1424
|
* @param {String} conversationId conversationId
|
|
1424
1425
|
* @param {String} participantId participantId
|
|
1425
1426
|
* @param {Object} opts Optional parameters
|
|
1426
1427
|
* @param {Boolean} opts.provisional Indicates if the wrap-up code is provisional. (default to false)
|
|
1428
|
+
* @deprecated
|
|
1427
1429
|
*/
|
|
1428
1430
|
getConversationsCobrowsesessionParticipantWrapup(conversationId, participantId, opts) {
|
|
1429
1431
|
opts = opts || {};
|
|
@@ -1453,9 +1455,10 @@ class ConversationsApi {
|
|
|
1453
1455
|
|
|
1454
1456
|
/**
|
|
1455
1457
|
* Get list of wrapup codes for this conversation participant
|
|
1456
|
-
*
|
|
1458
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
1457
1459
|
* @param {String} conversationId conversationId
|
|
1458
1460
|
* @param {String} participantId participantId
|
|
1461
|
+
* @deprecated
|
|
1459
1462
|
*/
|
|
1460
1463
|
getConversationsCobrowsesessionParticipantWrapupcodes(conversationId, participantId) {
|
|
1461
1464
|
// verify the required parameter 'conversationId' is set
|
|
@@ -2581,12 +2584,13 @@ class ConversationsApi {
|
|
|
2581
2584
|
}
|
|
2582
2585
|
|
|
2583
2586
|
/**
|
|
2584
|
-
* Get a list of Messaging Stickers
|
|
2585
|
-
*
|
|
2587
|
+
* Get a list of Messaging Stickers (Deprecated)
|
|
2588
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-line-third-party-messaging-channel/
|
|
2586
2589
|
* @param {Object} messengerType Messenger Type
|
|
2587
2590
|
* @param {Object} opts Optional parameters
|
|
2588
2591
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
2589
2592
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
2593
|
+
* @deprecated
|
|
2590
2594
|
*/
|
|
2591
2595
|
getConversationsMessagingSticker(messengerType, opts) {
|
|
2592
2596
|
opts = opts || {};
|
|
@@ -2702,12 +2706,13 @@ class ConversationsApi {
|
|
|
2702
2706
|
|
|
2703
2707
|
/**
|
|
2704
2708
|
* Get the wrap-up for this conversation communication.
|
|
2705
|
-
*
|
|
2709
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
2706
2710
|
* @param {String} conversationId conversationId
|
|
2707
2711
|
* @param {String} participantId participantId
|
|
2708
2712
|
* @param {String} communicationId communicationId
|
|
2709
2713
|
* @param {Object} opts Optional parameters
|
|
2710
2714
|
* @param {Boolean} opts.provisional Indicates if the wrap-up code is provisional. (default to false)
|
|
2715
|
+
* @deprecated
|
|
2711
2716
|
*/
|
|
2712
2717
|
getConversationsScreenshareParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
2713
2718
|
opts = opts || {};
|
|
@@ -2989,6 +2994,37 @@ class ConversationsApi {
|
|
|
2989
2994
|
);
|
|
2990
2995
|
}
|
|
2991
2996
|
|
|
2997
|
+
/**
|
|
2998
|
+
* Update the utilization label on a conversation. When there is no value provided, the system default label is applied
|
|
2999
|
+
*
|
|
3000
|
+
* @param {String} conversationId conversation ID
|
|
3001
|
+
* @param {Object} body Conversation Utilization Label
|
|
3002
|
+
* patchConversationUtilizationlabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3003
|
+
*/
|
|
3004
|
+
patchConversationUtilizationlabel(conversationId, body) {
|
|
3005
|
+
// verify the required parameter 'conversationId' is set
|
|
3006
|
+
if (conversationId === undefined || conversationId === null) {
|
|
3007
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationUtilizationlabel';
|
|
3008
|
+
}
|
|
3009
|
+
// verify the required parameter 'body' is set
|
|
3010
|
+
if (body === undefined || body === null) {
|
|
3011
|
+
throw 'Missing the required parameter "body" when calling patchConversationUtilizationlabel';
|
|
3012
|
+
}
|
|
3013
|
+
|
|
3014
|
+
return this.apiClient.callApi(
|
|
3015
|
+
'/api/v2/conversations/{conversationId}/utilizationlabel',
|
|
3016
|
+
'PATCH',
|
|
3017
|
+
{ 'conversationId': conversationId },
|
|
3018
|
+
{ },
|
|
3019
|
+
{ },
|
|
3020
|
+
{ },
|
|
3021
|
+
body,
|
|
3022
|
+
['PureCloud OAuth'],
|
|
3023
|
+
['application/json'],
|
|
3024
|
+
['application/json']
|
|
3025
|
+
);
|
|
3026
|
+
}
|
|
3027
|
+
|
|
2992
3028
|
/**
|
|
2993
3029
|
* Update after-call work for this conversation communication.
|
|
2994
3030
|
*
|
|
@@ -3511,9 +3547,10 @@ class ConversationsApi {
|
|
|
3511
3547
|
|
|
3512
3548
|
/**
|
|
3513
3549
|
* Update a conversation by disconnecting all of the participants
|
|
3514
|
-
*
|
|
3550
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
3515
3551
|
* @param {String} conversationId conversationId
|
|
3516
3552
|
* @param {Object} body Conversation
|
|
3553
|
+
* @deprecated
|
|
3517
3554
|
*/
|
|
3518
3555
|
patchConversationsCobrowsesession(conversationId, body) {
|
|
3519
3556
|
// verify the required parameter 'conversationId' is set
|
|
@@ -3541,11 +3578,12 @@ class ConversationsApi {
|
|
|
3541
3578
|
|
|
3542
3579
|
/**
|
|
3543
3580
|
* Update conversation participant
|
|
3544
|
-
*
|
|
3581
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
3545
3582
|
* @param {String} conversationId conversationId
|
|
3546
3583
|
* @param {String} participantId participantId
|
|
3547
3584
|
* @param {Object} opts Optional parameters
|
|
3548
3585
|
* @param {Object} opts.body
|
|
3586
|
+
* @deprecated
|
|
3549
3587
|
*/
|
|
3550
3588
|
patchConversationsCobrowsesessionParticipant(conversationId, participantId, opts) {
|
|
3551
3589
|
opts = opts || {};
|
|
@@ -3575,11 +3613,12 @@ class ConversationsApi {
|
|
|
3575
3613
|
|
|
3576
3614
|
/**
|
|
3577
3615
|
* Update the attributes on a conversation participant.
|
|
3578
|
-
*
|
|
3616
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
3579
3617
|
* @param {String} conversationId conversationId
|
|
3580
3618
|
* @param {String} participantId participantId
|
|
3581
3619
|
* @param {Object} opts Optional parameters
|
|
3582
3620
|
* @param {Object} opts.body
|
|
3621
|
+
* @deprecated
|
|
3583
3622
|
*/
|
|
3584
3623
|
patchConversationsCobrowsesessionParticipantAttributes(conversationId, participantId, opts) {
|
|
3585
3624
|
opts = opts || {};
|
|
@@ -3609,11 +3648,12 @@ class ConversationsApi {
|
|
|
3609
3648
|
|
|
3610
3649
|
/**
|
|
3611
3650
|
* Update conversation participant's communication by disconnecting it.
|
|
3612
|
-
*
|
|
3651
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
3613
3652
|
* @param {String} conversationId conversationId
|
|
3614
3653
|
* @param {String} participantId participantId
|
|
3615
3654
|
* @param {String} communicationId communicationId
|
|
3616
3655
|
* @param {Object} body Participant
|
|
3656
|
+
* @deprecated
|
|
3617
3657
|
*/
|
|
3618
3658
|
patchConversationsCobrowsesessionParticipantCommunication(conversationId, participantId, communicationId, body) {
|
|
3619
3659
|
// verify the required parameter 'conversationId' is set
|
|
@@ -5471,12 +5511,13 @@ class ConversationsApi {
|
|
|
5471
5511
|
|
|
5472
5512
|
/**
|
|
5473
5513
|
* Apply wrap-up for this conversation communication
|
|
5474
|
-
*
|
|
5514
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
5475
5515
|
* @param {String} conversationId conversationId
|
|
5476
5516
|
* @param {String} participantId participantId
|
|
5477
5517
|
* @param {String} communicationId communicationId
|
|
5478
5518
|
* @param {Object} opts Optional parameters
|
|
5479
5519
|
* @param {Object} opts.body Wrap-up
|
|
5520
|
+
* @deprecated
|
|
5480
5521
|
*/
|
|
5481
5522
|
postConversationsCobrowsesessionParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
5482
5523
|
opts = opts || {};
|
|
@@ -5510,11 +5551,12 @@ class ConversationsApi {
|
|
|
5510
5551
|
|
|
5511
5552
|
/**
|
|
5512
5553
|
* Replace this participant with the specified user and/or address
|
|
5513
|
-
*
|
|
5554
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
5514
5555
|
* @param {String} conversationId conversationId
|
|
5515
5556
|
* @param {String} participantId participantId
|
|
5516
5557
|
* @param {Object} opts Optional parameters
|
|
5517
5558
|
* @param {Object} opts.body
|
|
5559
|
+
* @deprecated
|
|
5518
5560
|
*/
|
|
5519
5561
|
postConversationsCobrowsesessionParticipantReplace(conversationId, participantId, opts) {
|
|
5520
5562
|
opts = opts || {};
|
|
@@ -6211,8 +6253,9 @@ class ConversationsApi {
|
|
|
6211
6253
|
|
|
6212
6254
|
/**
|
|
6213
6255
|
* Send an inbound Open Message
|
|
6214
|
-
*
|
|
6256
|
+
* [This API is deprecated. Instead, use 1. POST /api/v2/conversations/messages/{integrationId}/inbound/open/event, if you want to send an inbound Open Event Message 2. POST /api/v2/conversations/messages/{integrationId}/inbound/open/message, if you want to send an inbound Open Message 3. POST /api/v2/conversations/messages/{integrationId}/inbound/open/receipt, to send an inbound Open Receipt Message] In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
|
|
6215
6257
|
* @param {Object} body NormalizedMessage
|
|
6258
|
+
* @deprecated
|
|
6216
6259
|
*/
|
|
6217
6260
|
postConversationsMessagesInboundOpen(body) {
|
|
6218
6261
|
// verify the required parameter 'body' is set
|
|
@@ -6489,12 +6532,13 @@ class ConversationsApi {
|
|
|
6489
6532
|
|
|
6490
6533
|
/**
|
|
6491
6534
|
* Apply wrap-up for this conversation communication
|
|
6492
|
-
*
|
|
6535
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
6493
6536
|
* @param {String} conversationId conversationId
|
|
6494
6537
|
* @param {String} participantId participantId
|
|
6495
6538
|
* @param {String} communicationId communicationId
|
|
6496
6539
|
* @param {Object} opts Optional parameters
|
|
6497
6540
|
* @param {Object} opts.body Wrap-up
|
|
6541
|
+
* @deprecated
|
|
6498
6542
|
*/
|
|
6499
6543
|
postConversationsScreenshareParticipantCommunicationWrapup(conversationId, participantId, communicationId, opts) {
|
|
6500
6544
|
opts = opts || {};
|
|
@@ -7108,9 +7152,10 @@ class ConversationsApi {
|
|
|
7108
7152
|
|
|
7109
7153
|
/**
|
|
7110
7154
|
* Update a conversation by setting its recording state
|
|
7111
|
-
*
|
|
7155
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
7112
7156
|
* @param {String} conversationId conversationId
|
|
7113
7157
|
* @param {Object} body SetRecordingState
|
|
7158
|
+
* @deprecated
|
|
7114
7159
|
*/
|
|
7115
7160
|
putConversationsScreenshareRecordingstate(conversationId, body) {
|
|
7116
7161
|
// verify the required parameter 'conversationId' is set
|