purecloud-platform-client-v2 218.0.0 → 219.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 +1362 -94
- package/dist/web-amd/purecloud-platform-client-v2.js +1362 -94
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +396 -97
- package/dist/web-cjs/purecloud-platform-client-v2.js +396 -97
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +701 -1
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -4
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +61 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +54 -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 +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 +36 -1
- 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 +65 -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 +396 -2
- 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 +366 -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 +31 -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 +54 -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 +60 -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 +2 -2
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +6 -4
- 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 +65 -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 +66 -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 +26 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +7 -5
- 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 219.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -130,7 +130,6 @@ class AnalyticsApi {
|
|
|
130
130
|
* Get an agent and their active sessions by user ID
|
|
131
131
|
*
|
|
132
132
|
* @param {String} userId userId
|
|
133
|
-
* getAnalyticsAgentStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
134
133
|
*/
|
|
135
134
|
getAnalyticsAgentStatus(userId) {
|
|
136
135
|
// verify the required parameter 'userId' is set
|
|
@@ -1582,7 +1581,6 @@ class AnalyticsApi {
|
|
|
1582
1581
|
* Count agents by segment type
|
|
1583
1582
|
*
|
|
1584
1583
|
* @param {Object} body query
|
|
1585
|
-
* postAnalyticsAgentsStatusCounts is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1586
1584
|
*/
|
|
1587
1585
|
postAnalyticsAgentsStatusCounts(body) {
|
|
1588
1586
|
// verify the required parameter 'body' is set
|
|
@@ -1608,7 +1606,6 @@ class AnalyticsApi {
|
|
|
1608
1606
|
* Retrieve the top 50 agents matching the query filters
|
|
1609
1607
|
*
|
|
1610
1608
|
* @param {Object} body query
|
|
1611
|
-
* postAnalyticsAgentsStatusQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1612
1609
|
*/
|
|
1613
1610
|
postAnalyticsAgentsStatusQuery(body) {
|
|
1614
1611
|
// verify the required parameter 'body' is set
|
|
@@ -5,7 +5,7 @@ class ArchitectApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Architect service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 219.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -3043,6 +3043,36 @@ class ArchitectApi {
|
|
|
3043
3043
|
);
|
|
3044
3044
|
}
|
|
3045
3045
|
|
|
3046
|
+
/**
|
|
3047
|
+
* Creates a presigned URL for uploading a user prompt file
|
|
3048
|
+
*
|
|
3049
|
+
* @param {String} promptId Prompt ID
|
|
3050
|
+
* @param {String} languageCode Language
|
|
3051
|
+
*/
|
|
3052
|
+
postArchitectPromptResourceUploads(promptId, languageCode) {
|
|
3053
|
+
// verify the required parameter 'promptId' is set
|
|
3054
|
+
if (promptId === undefined || promptId === null) {
|
|
3055
|
+
throw 'Missing the required parameter "promptId" when calling postArchitectPromptResourceUploads';
|
|
3056
|
+
}
|
|
3057
|
+
// verify the required parameter 'languageCode' is set
|
|
3058
|
+
if (languageCode === undefined || languageCode === null) {
|
|
3059
|
+
throw 'Missing the required parameter "languageCode" when calling postArchitectPromptResourceUploads';
|
|
3060
|
+
}
|
|
3061
|
+
|
|
3062
|
+
return this.apiClient.callApi(
|
|
3063
|
+
'/api/v2/architect/prompts/{promptId}/resources/{languageCode}/uploads',
|
|
3064
|
+
'POST',
|
|
3065
|
+
{ 'promptId': promptId,'languageCode': languageCode },
|
|
3066
|
+
{ },
|
|
3067
|
+
{ },
|
|
3068
|
+
{ },
|
|
3069
|
+
null,
|
|
3070
|
+
['PureCloud OAuth'],
|
|
3071
|
+
['application/json'],
|
|
3072
|
+
['application/json']
|
|
3073
|
+
);
|
|
3074
|
+
}
|
|
3075
|
+
|
|
3046
3076
|
/**
|
|
3047
3077
|
* Create a new user prompt resource
|
|
3048
3078
|
*
|
|
@@ -3173,6 +3203,36 @@ class ArchitectApi {
|
|
|
3173
3203
|
);
|
|
3174
3204
|
}
|
|
3175
3205
|
|
|
3206
|
+
/**
|
|
3207
|
+
* Creates a presigned URL for uploading a system prompt file
|
|
3208
|
+
*
|
|
3209
|
+
* @param {String} promptId Prompt ID
|
|
3210
|
+
* @param {String} languageCode Language
|
|
3211
|
+
*/
|
|
3212
|
+
postArchitectSystempromptResourceUploads(promptId, languageCode) {
|
|
3213
|
+
// verify the required parameter 'promptId' is set
|
|
3214
|
+
if (promptId === undefined || promptId === null) {
|
|
3215
|
+
throw 'Missing the required parameter "promptId" when calling postArchitectSystempromptResourceUploads';
|
|
3216
|
+
}
|
|
3217
|
+
// verify the required parameter 'languageCode' is set
|
|
3218
|
+
if (languageCode === undefined || languageCode === null) {
|
|
3219
|
+
throw 'Missing the required parameter "languageCode" when calling postArchitectSystempromptResourceUploads';
|
|
3220
|
+
}
|
|
3221
|
+
|
|
3222
|
+
return this.apiClient.callApi(
|
|
3223
|
+
'/api/v2/architect/systemprompts/{promptId}/resources/{languageCode}/uploads',
|
|
3224
|
+
'POST',
|
|
3225
|
+
{ 'promptId': promptId,'languageCode': languageCode },
|
|
3226
|
+
{ },
|
|
3227
|
+
{ },
|
|
3228
|
+
{ },
|
|
3229
|
+
null,
|
|
3230
|
+
['PureCloud OAuth'],
|
|
3231
|
+
['application/json'],
|
|
3232
|
+
['application/json']
|
|
3233
|
+
);
|
|
3234
|
+
}
|
|
3235
|
+
|
|
3176
3236
|
/**
|
|
3177
3237
|
* Create system prompt resource override.
|
|
3178
3238
|
*
|
|
@@ -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 219.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -231,6 +231,31 @@ class AuthorizationApi {
|
|
|
231
231
|
);
|
|
232
232
|
}
|
|
233
233
|
|
|
234
|
+
/**
|
|
235
|
+
* Get a list of soft deleted divisions for the org
|
|
236
|
+
*
|
|
237
|
+
* @param {Object} opts Optional parameters
|
|
238
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
239
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
240
|
+
*/
|
|
241
|
+
getAuthorizationDivisionsDeleted(opts) {
|
|
242
|
+
opts = opts || {};
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
return this.apiClient.callApi(
|
|
246
|
+
'/api/v2/authorization/divisions/deleted',
|
|
247
|
+
'GET',
|
|
248
|
+
{ },
|
|
249
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
250
|
+
{ },
|
|
251
|
+
{ },
|
|
252
|
+
null,
|
|
253
|
+
['PureCloud OAuth'],
|
|
254
|
+
['application/json'],
|
|
255
|
+
['application/json']
|
|
256
|
+
);
|
|
257
|
+
}
|
|
258
|
+
|
|
234
259
|
/**
|
|
235
260
|
* Retrieve the home division for the organization.
|
|
236
261
|
* Will not include object counts.
|
|
@@ -271,6 +296,34 @@ class AuthorizationApi {
|
|
|
271
296
|
);
|
|
272
297
|
}
|
|
273
298
|
|
|
299
|
+
/**
|
|
300
|
+
* Retrieve a list of all divisions defined for the organization with cursor
|
|
301
|
+
* Use "after" and "before" param to fetch next/previous page}
|
|
302
|
+
* @param {Object} opts Optional parameters
|
|
303
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
304
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
305
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
306
|
+
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
307
|
+
* @param {String} opts.name Optionally request specific divisions by division name
|
|
308
|
+
*/
|
|
309
|
+
getAuthorizationDivisionsQuery(opts) {
|
|
310
|
+
opts = opts || {};
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
return this.apiClient.callApi(
|
|
314
|
+
'/api/v2/authorization/divisions/query',
|
|
315
|
+
'GET',
|
|
316
|
+
{ },
|
|
317
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'] },
|
|
318
|
+
{ },
|
|
319
|
+
{ },
|
|
320
|
+
null,
|
|
321
|
+
['PureCloud OAuth'],
|
|
322
|
+
['application/json'],
|
|
323
|
+
['application/json']
|
|
324
|
+
);
|
|
325
|
+
}
|
|
326
|
+
|
|
274
327
|
/**
|
|
275
328
|
* Returns which divisions the current user has the given permission in.
|
|
276
329
|
* This route is deprecated, use authorization/divisionspermitted/paged/me instead.
|
|
@@ -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 219.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -3093,6 +3093,41 @@ class ConversationsApi {
|
|
|
3093
3093
|
);
|
|
3094
3094
|
}
|
|
3095
3095
|
|
|
3096
|
+
/**
|
|
3097
|
+
* Update the feedback for the summary.
|
|
3098
|
+
*
|
|
3099
|
+
* @param {String} conversationId Conversation ID
|
|
3100
|
+
* @param {String} summaryId Summary ID
|
|
3101
|
+
* @param {Object} opts Optional parameters
|
|
3102
|
+
* @param {Object} opts.body
|
|
3103
|
+
* patchConversationSummaryFeedback is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3104
|
+
*/
|
|
3105
|
+
patchConversationSummaryFeedback(conversationId, summaryId, opts) {
|
|
3106
|
+
opts = opts || {};
|
|
3107
|
+
|
|
3108
|
+
// verify the required parameter 'conversationId' is set
|
|
3109
|
+
if (conversationId === undefined || conversationId === null) {
|
|
3110
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationSummaryFeedback';
|
|
3111
|
+
}
|
|
3112
|
+
// verify the required parameter 'summaryId' is set
|
|
3113
|
+
if (summaryId === undefined || summaryId === null) {
|
|
3114
|
+
throw 'Missing the required parameter "summaryId" when calling patchConversationSummaryFeedback';
|
|
3115
|
+
}
|
|
3116
|
+
|
|
3117
|
+
return this.apiClient.callApi(
|
|
3118
|
+
'/api/v2/conversations/{conversationId}/summaries/{summaryId}/feedback',
|
|
3119
|
+
'PATCH',
|
|
3120
|
+
{ 'conversationId': conversationId,'summaryId': summaryId },
|
|
3121
|
+
{ },
|
|
3122
|
+
{ },
|
|
3123
|
+
{ },
|
|
3124
|
+
opts['body'],
|
|
3125
|
+
['PureCloud OAuth'],
|
|
3126
|
+
['application/json'],
|
|
3127
|
+
['application/json']
|
|
3128
|
+
);
|
|
3129
|
+
}
|
|
3130
|
+
|
|
3096
3131
|
/**
|
|
3097
3132
|
* Update the utilization label on a conversation. When there is no value provided, the system default label is applied
|
|
3098
3133
|
*
|
|
@@ -5,7 +5,7 @@ class EmailsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Emails service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 219.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -20,6 +20,26 @@ class EmailsApi {
|
|
|
20
20
|
}
|
|
21
21
|
|
|
22
22
|
|
|
23
|
+
/**
|
|
24
|
+
* Reset email threading settings to default
|
|
25
|
+
*
|
|
26
|
+
*/
|
|
27
|
+
deleteEmailsSettingsThreading() {
|
|
28
|
+
|
|
29
|
+
return this.apiClient.callApi(
|
|
30
|
+
'/api/v2/emails/settings/threading',
|
|
31
|
+
'DELETE',
|
|
32
|
+
{ },
|
|
33
|
+
{ },
|
|
34
|
+
{ },
|
|
35
|
+
{ },
|
|
36
|
+
null,
|
|
37
|
+
['PureCloud OAuth'],
|
|
38
|
+
['application/json'],
|
|
39
|
+
['application/json']
|
|
40
|
+
);
|
|
41
|
+
}
|
|
42
|
+
|
|
23
43
|
/**
|
|
24
44
|
* Get email Contact Center settings
|
|
25
45
|
*
|
|
@@ -40,6 +60,26 @@ class EmailsApi {
|
|
|
40
60
|
);
|
|
41
61
|
}
|
|
42
62
|
|
|
63
|
+
/**
|
|
64
|
+
* Get email threading settings
|
|
65
|
+
*
|
|
66
|
+
*/
|
|
67
|
+
getEmailsSettingsThreading() {
|
|
68
|
+
|
|
69
|
+
return this.apiClient.callApi(
|
|
70
|
+
'/api/v2/emails/settings/threading',
|
|
71
|
+
'GET',
|
|
72
|
+
{ },
|
|
73
|
+
{ },
|
|
74
|
+
{ },
|
|
75
|
+
{ },
|
|
76
|
+
null,
|
|
77
|
+
['PureCloud OAuth'],
|
|
78
|
+
['application/json'],
|
|
79
|
+
['application/json']
|
|
80
|
+
);
|
|
81
|
+
}
|
|
82
|
+
|
|
43
83
|
/**
|
|
44
84
|
* Patch email Contact Center settings
|
|
45
85
|
*
|
|
@@ -64,6 +104,30 @@ class EmailsApi {
|
|
|
64
104
|
);
|
|
65
105
|
}
|
|
66
106
|
|
|
107
|
+
/**
|
|
108
|
+
* Patch email threading settings
|
|
109
|
+
*
|
|
110
|
+
* @param {Object} opts Optional parameters
|
|
111
|
+
* @param {Object} opts.body
|
|
112
|
+
*/
|
|
113
|
+
patchEmailsSettingsThreading(opts) {
|
|
114
|
+
opts = opts || {};
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
return this.apiClient.callApi(
|
|
118
|
+
'/api/v2/emails/settings/threading',
|
|
119
|
+
'PATCH',
|
|
120
|
+
{ },
|
|
121
|
+
{ },
|
|
122
|
+
{ },
|
|
123
|
+
{ },
|
|
124
|
+
opts['body'],
|
|
125
|
+
['PureCloud OAuth'],
|
|
126
|
+
['application/json'],
|
|
127
|
+
['application/json']
|
|
128
|
+
);
|
|
129
|
+
}
|
|
130
|
+
|
|
67
131
|
}
|
|
68
132
|
|
|
69
133
|
|