purecloud-platform-client-v2 189.1.0 → 191.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/node/purecloud-platform-client-v2.js +1160 -114
- package/dist/web-amd/purecloud-platform-client-v2.js +1160 -114
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +516 -274
- package/dist/web-cjs/purecloud-platform-client-v2.js +517 -277
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1229 -495
- 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 +162 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +86 -20
- 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 +33 -8
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +207 -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 -2
- 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 +2 -2
- 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 +24 -2
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +26 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +34 -7
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -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 +4 -4
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +516 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/package.json
CHANGED
|
@@ -5,7 +5,7 @@ class AnalyticsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Analytics service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 191.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -755,6 +755,59 @@ class AnalyticsApi {
|
|
|
755
755
|
);
|
|
756
756
|
}
|
|
757
757
|
|
|
758
|
+
/**
|
|
759
|
+
* Get dashboards summary for a user
|
|
760
|
+
*
|
|
761
|
+
* @param {String} userId User ID
|
|
762
|
+
*/
|
|
763
|
+
getAnalyticsReportingDashboardsUser(userId) {
|
|
764
|
+
// verify the required parameter 'userId' is set
|
|
765
|
+
if (userId === undefined || userId === null) {
|
|
766
|
+
throw 'Missing the required parameter "userId" when calling getAnalyticsReportingDashboardsUser';
|
|
767
|
+
}
|
|
768
|
+
|
|
769
|
+
return this.apiClient.callApi(
|
|
770
|
+
'/api/v2/analytics/reporting/dashboards/users/{userId}',
|
|
771
|
+
'GET',
|
|
772
|
+
{ 'userId': userId },
|
|
773
|
+
{ },
|
|
774
|
+
{ },
|
|
775
|
+
{ },
|
|
776
|
+
null,
|
|
777
|
+
['PureCloud OAuth'],
|
|
778
|
+
['application/json'],
|
|
779
|
+
['application/json']
|
|
780
|
+
);
|
|
781
|
+
}
|
|
782
|
+
|
|
783
|
+
/**
|
|
784
|
+
* Get dashboards summary for users in a org
|
|
785
|
+
*
|
|
786
|
+
* @param {Object} opts Optional parameters
|
|
787
|
+
* @param {String} opts.sortBy (default to asc)
|
|
788
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
789
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
790
|
+
* @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
|
|
791
|
+
* @param {Object} opts.state Only list users of this state
|
|
792
|
+
*/
|
|
793
|
+
getAnalyticsReportingDashboardsUsers(opts) {
|
|
794
|
+
opts = opts || {};
|
|
795
|
+
|
|
796
|
+
|
|
797
|
+
return this.apiClient.callApi(
|
|
798
|
+
'/api/v2/analytics/reporting/dashboards/users',
|
|
799
|
+
'GET',
|
|
800
|
+
{ },
|
|
801
|
+
{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'state': opts['state'] },
|
|
802
|
+
{ },
|
|
803
|
+
{ },
|
|
804
|
+
null,
|
|
805
|
+
['PureCloud OAuth'],
|
|
806
|
+
['application/json'],
|
|
807
|
+
['application/json']
|
|
808
|
+
);
|
|
809
|
+
}
|
|
810
|
+
|
|
758
811
|
/**
|
|
759
812
|
* Get all view export requests for a user
|
|
760
813
|
*
|
|
@@ -1030,6 +1083,39 @@ class AnalyticsApi {
|
|
|
1030
1083
|
);
|
|
1031
1084
|
}
|
|
1032
1085
|
|
|
1086
|
+
/**
|
|
1087
|
+
* Get list of dashboards for an user
|
|
1088
|
+
*
|
|
1089
|
+
* @param {String} userId User ID
|
|
1090
|
+
* @param {Object} opts Optional parameters
|
|
1091
|
+
* @param {String} opts.sortBy (default to asc)
|
|
1092
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
1093
|
+
* @param {Number} opts.pageSize (default to 50)
|
|
1094
|
+
* @param {Boolean} opts.publicOnly If true, retrieve only public dashboards
|
|
1095
|
+
* @param {Boolean} opts.favoriteOnly If true, retrieve only favorite dashboards
|
|
1096
|
+
*/
|
|
1097
|
+
getAnalyticsReportingSettingsUserDashboards(userId, opts) {
|
|
1098
|
+
opts = opts || {};
|
|
1099
|
+
|
|
1100
|
+
// verify the required parameter 'userId' is set
|
|
1101
|
+
if (userId === undefined || userId === null) {
|
|
1102
|
+
throw 'Missing the required parameter "userId" when calling getAnalyticsReportingSettingsUserDashboards';
|
|
1103
|
+
}
|
|
1104
|
+
|
|
1105
|
+
return this.apiClient.callApi(
|
|
1106
|
+
'/api/v2/analytics/reporting/settings/users/{userId}/dashboards',
|
|
1107
|
+
'GET',
|
|
1108
|
+
{ 'userId': userId },
|
|
1109
|
+
{ 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'publicOnly': opts['publicOnly'],'favoriteOnly': opts['favoriteOnly'] },
|
|
1110
|
+
{ },
|
|
1111
|
+
{ },
|
|
1112
|
+
null,
|
|
1113
|
+
['PureCloud OAuth'],
|
|
1114
|
+
['application/json'],
|
|
1115
|
+
['application/json']
|
|
1116
|
+
);
|
|
1117
|
+
}
|
|
1118
|
+
|
|
1033
1119
|
/**
|
|
1034
1120
|
* Get a list of report time periods.
|
|
1035
1121
|
*
|
|
@@ -2080,6 +2166,31 @@ class AnalyticsApi {
|
|
|
2080
2166
|
);
|
|
2081
2167
|
}
|
|
2082
2168
|
|
|
2169
|
+
/**
|
|
2170
|
+
* Bulk delete dashboards owned by other user(s)
|
|
2171
|
+
*
|
|
2172
|
+
* @param {Array.<String>} body List of userIds
|
|
2173
|
+
*/
|
|
2174
|
+
postAnalyticsReportingDashboardsUsersBulkRemove(body) {
|
|
2175
|
+
// verify the required parameter 'body' is set
|
|
2176
|
+
if (body === undefined || body === null) {
|
|
2177
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsReportingDashboardsUsersBulkRemove';
|
|
2178
|
+
}
|
|
2179
|
+
|
|
2180
|
+
return this.apiClient.callApi(
|
|
2181
|
+
'/api/v2/analytics/reporting/dashboards/users/bulk/remove',
|
|
2182
|
+
'POST',
|
|
2183
|
+
{ },
|
|
2184
|
+
{ },
|
|
2185
|
+
{ },
|
|
2186
|
+
{ },
|
|
2187
|
+
body,
|
|
2188
|
+
['PureCloud OAuth'],
|
|
2189
|
+
['application/json'],
|
|
2190
|
+
['application/json']
|
|
2191
|
+
);
|
|
2192
|
+
}
|
|
2193
|
+
|
|
2083
2194
|
/**
|
|
2084
2195
|
* Generate a view export request
|
|
2085
2196
|
* This API creates a reporting export but the desired way to export analytics data is to use the analytics query APIs instead
|
|
@@ -2157,6 +2268,56 @@ class AnalyticsApi {
|
|
|
2157
2268
|
);
|
|
2158
2269
|
}
|
|
2159
2270
|
|
|
2271
|
+
/**
|
|
2272
|
+
* Bulk remove dashboard configurations
|
|
2273
|
+
*
|
|
2274
|
+
* @param {Object} body
|
|
2275
|
+
*/
|
|
2276
|
+
postAnalyticsReportingSettingsDashboardsBulkRemove(body) {
|
|
2277
|
+
// verify the required parameter 'body' is set
|
|
2278
|
+
if (body === undefined || body === null) {
|
|
2279
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsReportingSettingsDashboardsBulkRemove';
|
|
2280
|
+
}
|
|
2281
|
+
|
|
2282
|
+
return this.apiClient.callApi(
|
|
2283
|
+
'/api/v2/analytics/reporting/settings/dashboards/bulk/remove',
|
|
2284
|
+
'POST',
|
|
2285
|
+
{ },
|
|
2286
|
+
{ },
|
|
2287
|
+
{ },
|
|
2288
|
+
{ },
|
|
2289
|
+
body,
|
|
2290
|
+
['PureCloud OAuth'],
|
|
2291
|
+
['application/json'],
|
|
2292
|
+
['application/json']
|
|
2293
|
+
);
|
|
2294
|
+
}
|
|
2295
|
+
|
|
2296
|
+
/**
|
|
2297
|
+
* Query dashboard configurations
|
|
2298
|
+
*
|
|
2299
|
+
* @param {Object} body
|
|
2300
|
+
*/
|
|
2301
|
+
postAnalyticsReportingSettingsDashboardsQuery(body) {
|
|
2302
|
+
// verify the required parameter 'body' is set
|
|
2303
|
+
if (body === undefined || body === null) {
|
|
2304
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsReportingSettingsDashboardsQuery';
|
|
2305
|
+
}
|
|
2306
|
+
|
|
2307
|
+
return this.apiClient.callApi(
|
|
2308
|
+
'/api/v2/analytics/reporting/settings/dashboards/query',
|
|
2309
|
+
'POST',
|
|
2310
|
+
{ },
|
|
2311
|
+
{ },
|
|
2312
|
+
{ },
|
|
2313
|
+
{ },
|
|
2314
|
+
body,
|
|
2315
|
+
['PureCloud OAuth'],
|
|
2316
|
+
['application/json'],
|
|
2317
|
+
['application/json']
|
|
2318
|
+
);
|
|
2319
|
+
}
|
|
2320
|
+
|
|
2160
2321
|
/**
|
|
2161
2322
|
* Query for resolution aggregates asynchronously
|
|
2162
2323
|
*
|
|
@@ -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 191.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -25,7 +25,6 @@ class ChatApi {
|
|
|
25
25
|
*
|
|
26
26
|
* @param {String} roomJid roomId
|
|
27
27
|
* @param {String} messageId messageId
|
|
28
|
-
* deleteChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
29
28
|
*/
|
|
30
29
|
deleteChatsRoomMessage(roomJid, messageId) {
|
|
31
30
|
// verify the required parameter 'roomJid' is set
|
|
@@ -56,7 +55,6 @@ class ChatApi {
|
|
|
56
55
|
*
|
|
57
56
|
* @param {String} roomJid roomJid
|
|
58
57
|
* @param {String} userId userId
|
|
59
|
-
* deleteChatsRoomParticipant is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60
58
|
*/
|
|
61
59
|
deleteChatsRoomParticipant(roomJid, userId) {
|
|
62
60
|
// verify the required parameter 'roomJid' is set
|
|
@@ -87,7 +85,6 @@ class ChatApi {
|
|
|
87
85
|
*
|
|
88
86
|
* @param {String} roomJid roomJid
|
|
89
87
|
* @param {String} pinnedMessageId pinnedMessageId
|
|
90
|
-
* deleteChatsRoomPinnedmessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
91
88
|
*/
|
|
92
89
|
deleteChatsRoomPinnedmessage(roomJid, pinnedMessageId) {
|
|
93
90
|
// verify the required parameter 'roomJid' is set
|
|
@@ -118,7 +115,6 @@ class ChatApi {
|
|
|
118
115
|
*
|
|
119
116
|
* @param {String} userId userId
|
|
120
117
|
* @param {String} messageId messageId
|
|
121
|
-
* deleteChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
122
118
|
*/
|
|
123
119
|
deleteChatsUserMessage(userId, messageId) {
|
|
124
120
|
// verify the required parameter 'userId' is set
|
|
@@ -148,7 +144,6 @@ class ChatApi {
|
|
|
148
144
|
* Get a message
|
|
149
145
|
*
|
|
150
146
|
* @param {String} messageId messageId
|
|
151
|
-
* getChatsMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
152
147
|
*/
|
|
153
148
|
getChatsMessage(messageId) {
|
|
154
149
|
// verify the required parameter 'messageId' is set
|
|
@@ -174,7 +169,6 @@ class ChatApi {
|
|
|
174
169
|
* Get a room
|
|
175
170
|
*
|
|
176
171
|
* @param {String} roomJid roomJid
|
|
177
|
-
* getChatsRoom is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
178
172
|
*/
|
|
179
173
|
getChatsRoom(roomJid) {
|
|
180
174
|
// verify the required parameter 'roomJid' is set
|
|
@@ -201,7 +195,6 @@ class ChatApi {
|
|
|
201
195
|
*
|
|
202
196
|
* @param {String} roomJid roomJid
|
|
203
197
|
* @param {String} messageIds messageIds, comma separated
|
|
204
|
-
* getChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
205
198
|
*/
|
|
206
199
|
getChatsRoomMessage(roomJid, messageIds) {
|
|
207
200
|
// verify the required parameter 'roomJid' is set
|
|
@@ -235,7 +228,6 @@ class ChatApi {
|
|
|
235
228
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
236
229
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
237
230
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
238
|
-
* getChatsRoomMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
239
231
|
*/
|
|
240
232
|
getChatsRoomMessages(roomJid, opts) {
|
|
241
233
|
opts = opts || {};
|
|
@@ -259,6 +251,61 @@ class ChatApi {
|
|
|
259
251
|
);
|
|
260
252
|
}
|
|
261
253
|
|
|
254
|
+
/**
|
|
255
|
+
* Get a room participant
|
|
256
|
+
*
|
|
257
|
+
* @param {String} roomJid roomJid
|
|
258
|
+
* @param {String} participantJid participantJid
|
|
259
|
+
*/
|
|
260
|
+
getChatsRoomParticipant(roomJid, participantJid) {
|
|
261
|
+
// verify the required parameter 'roomJid' is set
|
|
262
|
+
if (roomJid === undefined || roomJid === null) {
|
|
263
|
+
throw 'Missing the required parameter "roomJid" when calling getChatsRoomParticipant';
|
|
264
|
+
}
|
|
265
|
+
// verify the required parameter 'participantJid' is set
|
|
266
|
+
if (participantJid === undefined || participantJid === null) {
|
|
267
|
+
throw 'Missing the required parameter "participantJid" when calling getChatsRoomParticipant';
|
|
268
|
+
}
|
|
269
|
+
|
|
270
|
+
return this.apiClient.callApi(
|
|
271
|
+
'/api/v2/chats/rooms/{roomJid}/participants/{participantJid}',
|
|
272
|
+
'GET',
|
|
273
|
+
{ 'roomJid': roomJid,'participantJid': participantJid },
|
|
274
|
+
{ },
|
|
275
|
+
{ },
|
|
276
|
+
{ },
|
|
277
|
+
null,
|
|
278
|
+
['PureCloud OAuth'],
|
|
279
|
+
['application/json'],
|
|
280
|
+
['application/json']
|
|
281
|
+
);
|
|
282
|
+
}
|
|
283
|
+
|
|
284
|
+
/**
|
|
285
|
+
* Get room participants in a room
|
|
286
|
+
*
|
|
287
|
+
* @param {String} roomJid roomJid
|
|
288
|
+
*/
|
|
289
|
+
getChatsRoomParticipants(roomJid) {
|
|
290
|
+
// verify the required parameter 'roomJid' is set
|
|
291
|
+
if (roomJid === undefined || roomJid === null) {
|
|
292
|
+
throw 'Missing the required parameter "roomJid" when calling getChatsRoomParticipants';
|
|
293
|
+
}
|
|
294
|
+
|
|
295
|
+
return this.apiClient.callApi(
|
|
296
|
+
'/api/v2/chats/rooms/{roomJid}/participants',
|
|
297
|
+
'GET',
|
|
298
|
+
{ 'roomJid': roomJid },
|
|
299
|
+
{ },
|
|
300
|
+
{ },
|
|
301
|
+
{ },
|
|
302
|
+
null,
|
|
303
|
+
['PureCloud OAuth'],
|
|
304
|
+
['application/json'],
|
|
305
|
+
['application/json']
|
|
306
|
+
);
|
|
307
|
+
}
|
|
308
|
+
|
|
262
309
|
/**
|
|
263
310
|
* Get Chat Settings.
|
|
264
311
|
*
|
|
@@ -287,7 +334,6 @@ class ChatApi {
|
|
|
287
334
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
288
335
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
289
336
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
290
|
-
* getChatsThreadMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
291
337
|
*/
|
|
292
338
|
getChatsThreadMessages(threadId, opts) {
|
|
293
339
|
opts = opts || {};
|
|
@@ -316,7 +362,6 @@ class ChatApi {
|
|
|
316
362
|
*
|
|
317
363
|
* @param {String} userId userId
|
|
318
364
|
* @param {String} messageIds messageIds, comma separated
|
|
319
|
-
* getChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
320
365
|
*/
|
|
321
366
|
getChatsUserMessage(userId, messageIds) {
|
|
322
367
|
// verify the required parameter 'userId' is set
|
|
@@ -350,7 +395,6 @@ class ChatApi {
|
|
|
350
395
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
351
396
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
352
397
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
353
|
-
* getChatsUserMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
354
398
|
*/
|
|
355
399
|
getChatsUserMessages(userId, opts) {
|
|
356
400
|
opts = opts || {};
|
|
@@ -405,7 +449,6 @@ class ChatApi {
|
|
|
405
449
|
*
|
|
406
450
|
* @param {String} roomJid roomJid
|
|
407
451
|
* @param {Object} body Room properties
|
|
408
|
-
* patchChatsRoom is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
409
452
|
*/
|
|
410
453
|
patchChatsRoom(roomJid, body) {
|
|
411
454
|
// verify the required parameter 'roomJid' is set
|
|
@@ -437,7 +480,6 @@ class ChatApi {
|
|
|
437
480
|
* @param {String} roomJid roomId
|
|
438
481
|
* @param {String} messageId messageId
|
|
439
482
|
* @param {Object} body messageBody
|
|
440
|
-
* patchChatsRoomMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
441
483
|
*/
|
|
442
484
|
patchChatsRoomMessage(roomJid, messageId, body) {
|
|
443
485
|
// verify the required parameter 'roomJid' is set
|
|
@@ -498,7 +540,6 @@ class ChatApi {
|
|
|
498
540
|
* @param {String} userId userId
|
|
499
541
|
* @param {String} messageId messageId
|
|
500
542
|
* @param {Object} body message body
|
|
501
|
-
* patchChatsUserMessage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
502
543
|
*/
|
|
503
544
|
patchChatsUserMessage(userId, messageId, body) {
|
|
504
545
|
// verify the required parameter 'userId' is set
|
|
@@ -564,7 +605,6 @@ class ChatApi {
|
|
|
564
605
|
*
|
|
565
606
|
* @param {String} roomJid roomId
|
|
566
607
|
* @param {Object} body messageBody
|
|
567
|
-
* postChatsRoomMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
568
608
|
*/
|
|
569
609
|
postChatsRoomMessages(roomJid, body) {
|
|
570
610
|
// verify the required parameter 'roomJid' is set
|
|
@@ -595,7 +635,6 @@ class ChatApi {
|
|
|
595
635
|
*
|
|
596
636
|
* @param {String} roomJid roomJid
|
|
597
637
|
* @param {String} userId userId
|
|
598
|
-
* postChatsRoomParticipant is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
599
638
|
*/
|
|
600
639
|
postChatsRoomParticipant(roomJid, userId) {
|
|
601
640
|
// verify the required parameter 'roomJid' is set
|
|
@@ -626,7 +665,6 @@ class ChatApi {
|
|
|
626
665
|
*
|
|
627
666
|
* @param {String} roomJid roomJid
|
|
628
667
|
* @param {Object} body Pinned Message Ids
|
|
629
|
-
* postChatsRoomPinnedmessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
630
668
|
*/
|
|
631
669
|
postChatsRoomPinnedmessages(roomJid, body) {
|
|
632
670
|
// verify the required parameter 'roomJid' is set
|
|
@@ -656,7 +694,6 @@ class ChatApi {
|
|
|
656
694
|
* Create an adhoc room
|
|
657
695
|
*
|
|
658
696
|
* @param {Object} body Room properties
|
|
659
|
-
* postChatsRooms is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
660
697
|
*/
|
|
661
698
|
postChatsRooms(body) {
|
|
662
699
|
// verify the required parameter 'body' is set
|
|
@@ -683,7 +720,6 @@ class ChatApi {
|
|
|
683
720
|
*
|
|
684
721
|
* @param {String} userId userId
|
|
685
722
|
* @param {Object} body message body
|
|
686
|
-
* postChatsUserMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
687
723
|
*/
|
|
688
724
|
postChatsUserMessages(userId, body) {
|
|
689
725
|
// verify the required parameter 'userId' is set
|
|
@@ -709,6 +745,36 @@ class ChatApi {
|
|
|
709
745
|
);
|
|
710
746
|
}
|
|
711
747
|
|
|
748
|
+
/**
|
|
749
|
+
* Update reactions to a message
|
|
750
|
+
*
|
|
751
|
+
* @param {String} messageId messageId
|
|
752
|
+
* @param {Object} body reactionUpdate
|
|
753
|
+
*/
|
|
754
|
+
putChatsMessageReactions(messageId, body) {
|
|
755
|
+
// verify the required parameter 'messageId' is set
|
|
756
|
+
if (messageId === undefined || messageId === null) {
|
|
757
|
+
throw 'Missing the required parameter "messageId" when calling putChatsMessageReactions';
|
|
758
|
+
}
|
|
759
|
+
// verify the required parameter 'body' is set
|
|
760
|
+
if (body === undefined || body === null) {
|
|
761
|
+
throw 'Missing the required parameter "body" when calling putChatsMessageReactions';
|
|
762
|
+
}
|
|
763
|
+
|
|
764
|
+
return this.apiClient.callApi(
|
|
765
|
+
'/api/v2/chats/messages/{messageId}/reactions',
|
|
766
|
+
'PUT',
|
|
767
|
+
{ 'messageId': messageId },
|
|
768
|
+
{ },
|
|
769
|
+
{ },
|
|
770
|
+
{ },
|
|
771
|
+
body,
|
|
772
|
+
['PureCloud OAuth'],
|
|
773
|
+
['application/json'],
|
|
774
|
+
['application/json']
|
|
775
|
+
);
|
|
776
|
+
}
|
|
777
|
+
|
|
712
778
|
/**
|
|
713
779
|
* Update Chat Settings.
|
|
714
780
|
*
|
|
@@ -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 191.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -298,8 +298,9 @@ class ConversationsApi {
|
|
|
298
298
|
|
|
299
299
|
/**
|
|
300
300
|
* Delete a Twitter messaging integration
|
|
301
|
-
*
|
|
301
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
302
302
|
* @param {String} integrationId Integration ID
|
|
303
|
+
* @deprecated
|
|
303
304
|
*/
|
|
304
305
|
deleteConversationsMessagingIntegrationsTwitterIntegrationId(integrationId) {
|
|
305
306
|
// verify the required parameter 'integrationId' is set
|
|
@@ -2115,6 +2116,26 @@ class ConversationsApi {
|
|
|
2115
2116
|
);
|
|
2116
2117
|
}
|
|
2117
2118
|
|
|
2119
|
+
/**
|
|
2120
|
+
* Get a list of Facebook Permissions
|
|
2121
|
+
*
|
|
2122
|
+
*/
|
|
2123
|
+
getConversationsMessagingFacebookPermissions() {
|
|
2124
|
+
|
|
2125
|
+
return this.apiClient.callApi(
|
|
2126
|
+
'/api/v2/conversations/messaging/facebook/permissions',
|
|
2127
|
+
'GET',
|
|
2128
|
+
{ },
|
|
2129
|
+
{ },
|
|
2130
|
+
{ },
|
|
2131
|
+
{ },
|
|
2132
|
+
null,
|
|
2133
|
+
['PureCloud OAuth'],
|
|
2134
|
+
['application/json'],
|
|
2135
|
+
['application/json']
|
|
2136
|
+
);
|
|
2137
|
+
}
|
|
2138
|
+
|
|
2118
2139
|
/**
|
|
2119
2140
|
* Get a list of Integrations
|
|
2120
2141
|
*
|
|
@@ -2374,14 +2395,15 @@ class ConversationsApi {
|
|
|
2374
2395
|
}
|
|
2375
2396
|
|
|
2376
2397
|
/**
|
|
2377
|
-
* Get a list of Twitter Integrations
|
|
2378
|
-
*
|
|
2398
|
+
* Get a list of Twitter Integrations (Deprecated)
|
|
2399
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
2379
2400
|
* @param {Object} opts Optional parameters
|
|
2380
2401
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
2381
2402
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
2382
2403
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
2383
2404
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
2384
2405
|
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
2406
|
+
* @deprecated
|
|
2385
2407
|
*/
|
|
2386
2408
|
getConversationsMessagingIntegrationsTwitter(opts) {
|
|
2387
2409
|
opts = opts || {};
|
|
@@ -2402,11 +2424,12 @@ class ConversationsApi {
|
|
|
2402
2424
|
}
|
|
2403
2425
|
|
|
2404
2426
|
/**
|
|
2405
|
-
* Get a Twitter messaging integration
|
|
2406
|
-
*
|
|
2427
|
+
* Get a Twitter messaging integration (Deprecated)
|
|
2428
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
2407
2429
|
* @param {String} integrationId Integration ID
|
|
2408
2430
|
* @param {Object} opts Optional parameters
|
|
2409
2431
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
2432
|
+
* @deprecated
|
|
2410
2433
|
*/
|
|
2411
2434
|
getConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, opts) {
|
|
2412
2435
|
opts = opts || {};
|
|
@@ -4025,9 +4048,10 @@ class ConversationsApi {
|
|
|
4025
4048
|
|
|
4026
4049
|
/**
|
|
4027
4050
|
* Update Twitter messaging integration
|
|
4028
|
-
*
|
|
4051
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
4029
4052
|
* @param {String} integrationId Integration ID
|
|
4030
4053
|
* @param {Object} body TwitterIntegrationRequest
|
|
4054
|
+
* @deprecated
|
|
4031
4055
|
*/
|
|
4032
4056
|
patchConversationsMessagingIntegrationsTwitterIntegrationId(integrationId, body) {
|
|
4033
4057
|
// verify the required parameter 'integrationId' is set
|
|
@@ -6313,8 +6337,9 @@ class ConversationsApi {
|
|
|
6313
6337
|
|
|
6314
6338
|
/**
|
|
6315
6339
|
* Create a Twitter Integration
|
|
6316
|
-
*
|
|
6340
|
+
* This endpoint is deprecated. Please see the article https://help.mypurecloud.com/articles/deprecation-native-x-formerly-twitter-third-party-messaging-channel/
|
|
6317
6341
|
* @param {Object} body TwitterIntegrationRequest
|
|
6342
|
+
* @deprecated
|
|
6318
6343
|
*/
|
|
6319
6344
|
postConversationsMessagingIntegrationsTwitter(body) {
|
|
6320
6345
|
// verify the required parameter 'body' is set
|