purecloud-platform-client-v2 131.1.0 → 133.0.1
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 +122 -84
- package/dist/web-amd/purecloud-platform-client-v2.js +123 -85
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +128 -90
- package/dist/web-cjs/purecloud-platform-client-v2.js +3775 -945
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +245 -11
- package/package.json +9 -9
- package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.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 +27 -2
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.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 +7 -3
- 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/IntegrationsApi.js +1 -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/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/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +4 -4
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +8 -5
- 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/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.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/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 +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 +2 -2
- package/src/purecloud-platform-client-v2/index.js +1 -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 133.0.1
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1336,6 +1336,31 @@ class ConversationsApi {
|
|
|
1336
1336
|
);
|
|
1337
1337
|
}
|
|
1338
1338
|
|
|
1339
|
+
/**
|
|
1340
|
+
* Get emails settings for a given conversation
|
|
1341
|
+
*
|
|
1342
|
+
* @param {String} conversationId conversationId
|
|
1343
|
+
*/
|
|
1344
|
+
getConversationsEmailSettings(conversationId) {
|
|
1345
|
+
// verify the required parameter 'conversationId' is set
|
|
1346
|
+
if (conversationId === undefined || conversationId === null) {
|
|
1347
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationsEmailSettings';
|
|
1348
|
+
}
|
|
1349
|
+
|
|
1350
|
+
return this.apiClient.callApi(
|
|
1351
|
+
'/api/v2/conversations/emails/{conversationId}/settings',
|
|
1352
|
+
'GET',
|
|
1353
|
+
{ 'conversationId': conversationId },
|
|
1354
|
+
{ },
|
|
1355
|
+
{ },
|
|
1356
|
+
{ },
|
|
1357
|
+
null,
|
|
1358
|
+
['PureCloud OAuth'],
|
|
1359
|
+
['application/json'],
|
|
1360
|
+
['application/json']
|
|
1361
|
+
);
|
|
1362
|
+
}
|
|
1363
|
+
|
|
1339
1364
|
/**
|
|
1340
1365
|
* Get active email conversations for the logged in user
|
|
1341
1366
|
*
|
|
@@ -4155,7 +4180,7 @@ class ConversationsApi {
|
|
|
4155
4180
|
|
|
4156
4181
|
/**
|
|
4157
4182
|
* Send an agentless outbound message
|
|
4158
|
-
* Send an
|
|
4183
|
+
* Send an agentless (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will generate a new Conversation, if there is an existing active Conversation between the fromAddress and toAddress already, then this POST will fail.
|
|
4159
4184
|
* @param {Object} body Create agentless outbound messaging request
|
|
4160
4185
|
*/
|
|
4161
4186
|
postConversationsMessagesAgentless(body) {
|
|
@@ -5,7 +5,7 @@ class GamificationApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Gamification service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 133.0.1
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1281,8 +1281,12 @@ class GamificationApi {
|
|
|
1281
1281
|
* Create a new custom performance profile
|
|
1282
1282
|
*
|
|
1283
1283
|
* @param {Object} body performanceProfile
|
|
1284
|
+
* @param {Object} opts Optional parameters
|
|
1285
|
+
* @param {Boolean} opts.copyMetrics Flag to copy metrics. If set to false, there will be no metrics associated with the new profile. If set to true or is absent (the default behavior), all metrics from the default profile will be copied over into the new profile. (default to true)
|
|
1284
1286
|
*/
|
|
1285
|
-
postGamificationProfiles(body) {
|
|
1287
|
+
postGamificationProfiles(body, opts) {
|
|
1288
|
+
opts = opts || {};
|
|
1289
|
+
|
|
1286
1290
|
// verify the required parameter 'body' is set
|
|
1287
1291
|
if (body === undefined || body === null) {
|
|
1288
1292
|
throw 'Missing the required parameter "body" when calling postGamificationProfiles';
|
|
@@ -1292,7 +1296,7 @@ class GamificationApi {
|
|
|
1292
1296
|
'/api/v2/gamification/profiles',
|
|
1293
1297
|
'POST',
|
|
1294
1298
|
{ },
|
|
1295
|
-
{
|
|
1299
|
+
{ 'copyMetrics': opts['copyMetrics'] },
|
|
1296
1300
|
{ },
|
|
1297
1301
|
{ },
|
|
1298
1302
|
body,
|
|
@@ -5,7 +5,7 @@ class OutboundApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Outbound service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 133.0.1
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -2390,8 +2390,12 @@ class OutboundApi {
|
|
|
2390
2390
|
* Only Internal DNC lists may be appended to
|
|
2391
2391
|
* @param {String} dncListId DncList ID
|
|
2392
2392
|
* @param {Array.<Object>} body DNC Phone Numbers
|
|
2393
|
+
* @param {Object} opts Optional parameters
|
|
2394
|
+
* @param {String} opts.expirationDateTime Expiration date for DNC phone numbers in yyyy-MM-ddTHH:mmZ format
|
|
2393
2395
|
*/
|
|
2394
|
-
postOutboundDnclistPhonenumbers(dncListId, body) {
|
|
2396
|
+
postOutboundDnclistPhonenumbers(dncListId, body, opts) {
|
|
2397
|
+
opts = opts || {};
|
|
2398
|
+
|
|
2395
2399
|
// verify the required parameter 'dncListId' is set
|
|
2396
2400
|
if (dncListId === undefined || dncListId === null) {
|
|
2397
2401
|
throw 'Missing the required parameter "dncListId" when calling postOutboundDnclistPhonenumbers';
|
|
@@ -2405,7 +2409,7 @@ class OutboundApi {
|
|
|
2405
2409
|
'/api/v2/outbound/dnclists/{dncListId}/phonenumbers',
|
|
2406
2410
|
'POST',
|
|
2407
2411
|
{ 'dncListId': dncListId },
|
|
2408
|
-
{
|
|
2412
|
+
{ 'expirationDateTime': opts['expirationDateTime'] },
|
|
2409
2413
|
{ },
|
|
2410
2414
|
{ },
|
|
2411
2415
|
body,
|
|
@@ -5,7 +5,7 @@ class QualityApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Quality service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 133.0.1
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -56,7 +56,7 @@ class QualityApi {
|
|
|
56
56
|
* @param {String} conversationId conversationId
|
|
57
57
|
* @param {String} evaluationId evaluationId
|
|
58
58
|
* @param {Object} opts Optional parameters
|
|
59
|
-
* @param {String} opts.expand evaluatorId
|
|
59
|
+
* @param {String} opts.expand evaluatorId, evaluationForm
|
|
60
60
|
*/
|
|
61
61
|
deleteQualityConversationEvaluation(conversationId, evaluationId, opts) {
|
|
62
62
|
opts = opts || {};
|
|
@@ -161,7 +161,7 @@ class QualityApi {
|
|
|
161
161
|
|
|
162
162
|
/**
|
|
163
163
|
* Gets a list of Agent Activities
|
|
164
|
-
*
|
|
164
|
+
* Each item on the list shows one agent's evaluation activity comprised of the number of evaluations and the highest, average, and lowest standard and critical scores, as well as a sub list showing the number and average score of evaluations for each evaluator for that agent. evaluatorUserId, startTime, and endTime are all filtering criteria. If specified, the only evaluations used to compile the agent activity response will be ones that match the filtering criteria. agentUserId, name, group, and agentTeamId are all agent selection criteria. criteria. If one or more agent selection criteria are specified, then the returned activity will include users that match the criteria even if those users did not have any agent activity or evaluations that do not match any filtering criteria. If no agent selection criteria are specified but an evaluatorUserId is, then the returned activity will be only for those agents that had evaluations where the evaluator is the evaluatorUserId. If no agent selection criteria are specified and no evaluatorUserId is specified, then the returned activity will be for all users
|
|
165
165
|
* @param {Object} opts Optional parameters
|
|
166
166
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
167
167
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -1425,7 +1425,7 @@ class QualityApi {
|
|
|
1425
1425
|
* @param {String} evaluationId evaluationId
|
|
1426
1426
|
* @param {Object} body evaluation
|
|
1427
1427
|
* @param {Object} opts Optional parameters
|
|
1428
|
-
* @param {String} opts.expand evaluatorId
|
|
1428
|
+
* @param {String} opts.expand evaluatorId, evaluationForm
|
|
1429
1429
|
*/
|
|
1430
1430
|
putQualityConversationEvaluation(conversationId, evaluationId, body, opts) {
|
|
1431
1431
|
opts = opts || {};
|
|
@@ -5,7 +5,7 @@ class RecordingApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Recording service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 133.0.1
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -218,6 +218,7 @@ class RecordingApi {
|
|
|
218
218
|
* @param {Boolean} opts.download requesting a download format of the recording. Valid values:true,false (default to false)
|
|
219
219
|
* @param {String} opts.fileName the name of the downloaded fileName
|
|
220
220
|
* @param {String} opts.locale The locale for the requested file when downloading, as an ISO 639-1 code
|
|
221
|
+
* @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3
|
|
221
222
|
*/
|
|
222
223
|
getConversationRecording(conversationId, recordingId, opts) {
|
|
223
224
|
opts = opts || {};
|
|
@@ -235,7 +236,7 @@ class RecordingApi {
|
|
|
235
236
|
'/api/v2/conversations/{conversationId}/recordings/{recordingId}',
|
|
236
237
|
'GET',
|
|
237
238
|
{ 'conversationId': conversationId,'recordingId': recordingId },
|
|
238
|
-
{ 'formatId': opts['formatId'],'emailFormatId': opts['emailFormatId'],'chatFormatId': opts['chatFormatId'],'messageFormatId': opts['messageFormatId'],'download': opts['download'],'fileName': opts['fileName'],'locale': opts['locale'] },
|
|
239
|
+
{ 'formatId': opts['formatId'],'emailFormatId': opts['emailFormatId'],'chatFormatId': opts['chatFormatId'],'messageFormatId': opts['messageFormatId'],'download': opts['download'],'fileName': opts['fileName'],'locale': opts['locale'],'mediaFormats': this.apiClient.buildCollectionParam(opts['mediaFormats'], 'multi') },
|
|
239
240
|
{ },
|
|
240
241
|
{ },
|
|
241
242
|
null,
|
|
@@ -371,7 +372,8 @@ class RecordingApi {
|
|
|
371
372
|
* @param {String} conversationId Conversation ID
|
|
372
373
|
* @param {Object} opts Optional parameters
|
|
373
374
|
* @param {Number} opts.maxWaitMs The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value. (default to 5000)
|
|
374
|
-
* @param {Object} opts.formatId The desired media format
|
|
375
|
+
* @param {Object} opts.formatId The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE. (default to WEBM)
|
|
376
|
+
* @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3.
|
|
375
377
|
*/
|
|
376
378
|
getConversationRecordings(conversationId, opts) {
|
|
377
379
|
opts = opts || {};
|
|
@@ -385,7 +387,7 @@ class RecordingApi {
|
|
|
385
387
|
'/api/v2/conversations/{conversationId}/recordings',
|
|
386
388
|
'GET',
|
|
387
389
|
{ 'conversationId': conversationId },
|
|
388
|
-
{ 'maxWaitMs': opts['maxWaitMs'],'formatId': opts['formatId'] },
|
|
390
|
+
{ 'maxWaitMs': opts['maxWaitMs'],'formatId': opts['formatId'],'mediaFormats': this.apiClient.buildCollectionParam(opts['mediaFormats'], 'multi') },
|
|
389
391
|
{ },
|
|
390
392
|
{ },
|
|
391
393
|
null,
|
|
@@ -432,6 +434,7 @@ class RecordingApi {
|
|
|
432
434
|
* @param {Boolean} opts.download requesting a download format of the recording (default to false)
|
|
433
435
|
* @param {String} opts.fileName the name of the downloaded fileName
|
|
434
436
|
* @param {String} opts.locale The locale for the requested file when downloading, as an ISO 639-1 code
|
|
437
|
+
* @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3
|
|
435
438
|
*/
|
|
436
439
|
getOrphanrecordingMedia(orphanId, opts) {
|
|
437
440
|
opts = opts || {};
|
|
@@ -445,7 +448,7 @@ class RecordingApi {
|
|
|
445
448
|
'/api/v2/orphanrecordings/{orphanId}/media',
|
|
446
449
|
'GET',
|
|
447
450
|
{ 'orphanId': orphanId },
|
|
448
|
-
{ 'formatId': opts['formatId'],'emailFormatId': opts['emailFormatId'],'chatFormatId': opts['chatFormatId'],'messageFormatId': opts['messageFormatId'],'download': opts['download'],'fileName': opts['fileName'],'locale': opts['locale'] },
|
|
451
|
+
{ 'formatId': opts['formatId'],'emailFormatId': opts['emailFormatId'],'chatFormatId': opts['chatFormatId'],'messageFormatId': opts['messageFormatId'],'download': opts['download'],'fileName': opts['fileName'],'locale': opts['locale'],'mediaFormats': this.apiClient.buildCollectionParam(opts['mediaFormats'], 'multi') },
|
|
449
452
|
{ },
|
|
450
453
|
{ },
|
|
451
454
|
null,
|