purecloud-platform-client-v2 131.0.0 → 133.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 +220 -87
- package/dist/web-amd/purecloud-platform-client-v2.js +221 -88
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +226 -93
- package/dist/web-cjs/purecloud-platform-client-v2.js +4099 -1174
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +417 -39
- 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 +46 -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 +3 -3
- 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 +54 -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 +2 -2
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +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
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "purecloud-platform-client-v2",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "133.0.0",
|
|
4
4
|
"description": "A JavaScript library to interface with the PureCloud Platform API",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"main": "dist/node/purecloud-platform-client-v2.js",
|
|
@@ -31,18 +31,18 @@
|
|
|
31
31
|
},
|
|
32
32
|
"dependencies": {
|
|
33
33
|
"configparser": "^0.3.9",
|
|
34
|
-
"superagent": "^
|
|
35
|
-
"winston": "^3.
|
|
34
|
+
"superagent": "^7.1.1",
|
|
35
|
+
"winston": "^3.6.0"
|
|
36
36
|
},
|
|
37
37
|
"devDependencies": {
|
|
38
|
-
"mocha": "~2.
|
|
39
|
-
"sinon": "
|
|
38
|
+
"mocha": "~9.2.0",
|
|
39
|
+
"sinon": "13.0.1",
|
|
40
40
|
"expect.js": "~0.3.1",
|
|
41
|
-
"rollup
|
|
42
|
-
"rollup
|
|
43
|
-
"rollup
|
|
41
|
+
"@rollup/plugin-commonjs": "^21.0.1",
|
|
42
|
+
"@rollup/plugin-node-resolve": "^13.1.3",
|
|
43
|
+
"@rollup/plugin-json": "^4.1.0",
|
|
44
44
|
"rollup-plugin-re": "^1.0.7",
|
|
45
45
|
"rollup-plugin-node-builtins": "^2.1.2",
|
|
46
|
-
"rollup-plugin-node-globals": "^1.
|
|
46
|
+
"rollup-plugin-node-globals": "^1.4.0"
|
|
47
47
|
}
|
|
48
48
|
}
|
|
@@ -3,7 +3,7 @@ import Configuration from './configuration.js';
|
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* @module purecloud-platform-client-v2/ApiClient
|
|
6
|
-
* @version
|
|
6
|
+
* @version 133.0.0
|
|
7
7
|
*/
|
|
8
8
|
class ApiClient {
|
|
9
9
|
/**
|
|
@@ -950,7 +950,7 @@ class ApiClient {
|
|
|
950
950
|
|
|
951
951
|
// set header parameters
|
|
952
952
|
request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
|
|
953
|
-
//request.set({ 'purecloud-sdk': '
|
|
953
|
+
//request.set({ 'purecloud-sdk': '133.0.0' });
|
|
954
954
|
|
|
955
955
|
// set request timeout
|
|
956
956
|
request.timeout(that.timeout);
|
|
@@ -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 133.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -506,6 +506,26 @@ class AnalyticsApi {
|
|
|
506
506
|
);
|
|
507
507
|
}
|
|
508
508
|
|
|
509
|
+
/**
|
|
510
|
+
* Get AnalyticsReportingSettings for an organization
|
|
511
|
+
*
|
|
512
|
+
*/
|
|
513
|
+
getAnalyticsReportingSettings() {
|
|
514
|
+
|
|
515
|
+
return this.apiClient.callApi(
|
|
516
|
+
'/api/v2/analytics/reporting/settings',
|
|
517
|
+
'GET',
|
|
518
|
+
{ },
|
|
519
|
+
{ },
|
|
520
|
+
{ },
|
|
521
|
+
{ },
|
|
522
|
+
null,
|
|
523
|
+
['PureCloud OAuth'],
|
|
524
|
+
['application/json'],
|
|
525
|
+
['application/json']
|
|
526
|
+
);
|
|
527
|
+
}
|
|
528
|
+
|
|
509
529
|
/**
|
|
510
530
|
* Get a list of report time periods.
|
|
511
531
|
*
|
|
@@ -601,6 +621,31 @@ class AnalyticsApi {
|
|
|
601
621
|
);
|
|
602
622
|
}
|
|
603
623
|
|
|
624
|
+
/**
|
|
625
|
+
* Patch AnalyticsReportingSettings values for an organization
|
|
626
|
+
*
|
|
627
|
+
* @param {Object} body AnalyticsReportingSettingsRequest
|
|
628
|
+
*/
|
|
629
|
+
patchAnalyticsReportingSettings(body) {
|
|
630
|
+
// verify the required parameter 'body' is set
|
|
631
|
+
if (body === undefined || body === null) {
|
|
632
|
+
throw 'Missing the required parameter "body" when calling patchAnalyticsReportingSettings';
|
|
633
|
+
}
|
|
634
|
+
|
|
635
|
+
return this.apiClient.callApi(
|
|
636
|
+
'/api/v2/analytics/reporting/settings',
|
|
637
|
+
'PATCH',
|
|
638
|
+
{ },
|
|
639
|
+
{ },
|
|
640
|
+
{ },
|
|
641
|
+
{ },
|
|
642
|
+
body,
|
|
643
|
+
['PureCloud OAuth'],
|
|
644
|
+
['application/json'],
|
|
645
|
+
['application/json']
|
|
646
|
+
);
|
|
647
|
+
}
|
|
648
|
+
|
|
604
649
|
/**
|
|
605
650
|
* Query for bot aggregates
|
|
606
651
|
*
|
|
@@ -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.0
|
|
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.0
|
|
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 LanguageUnderstandingApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* LanguageUnderstanding service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 133.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -463,7 +463,7 @@ class LanguageUnderstandingApi {
|
|
|
463
463
|
* @param {String} minerId Miner ID
|
|
464
464
|
* @param {String} intentId The ID of the intent to be retrieved.
|
|
465
465
|
* @param {Object} opts Optional parameters
|
|
466
|
-
* @param {
|
|
466
|
+
* @param {Object} opts.expand Option to fetch utterances
|
|
467
467
|
*/
|
|
468
468
|
getLanguageunderstandingMinerIntent(minerId, intentId, opts) {
|
|
469
469
|
opts = opts || {};
|
|
@@ -496,7 +496,7 @@ class LanguageUnderstandingApi {
|
|
|
496
496
|
*
|
|
497
497
|
* @param {String} minerId Miner ID
|
|
498
498
|
* @param {Object} opts Optional parameters
|
|
499
|
-
* @param {
|
|
499
|
+
* @param {Object} opts.expand Option to fetch utterances.
|
|
500
500
|
*/
|
|
501
501
|
getLanguageunderstandingMinerIntents(minerId, opts) {
|
|
502
502
|
opts = opts || {};
|
|
@@ -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.0
|
|
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,
|