purecloud-platform-client-v2 141.1.0 → 144.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 +274 -73
- package/dist/web-amd/purecloud-platform-client-v2.js +274 -73
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +274 -73
- package/dist/web-cjs/purecloud-platform-client-v2.js +274 -73
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +172 -3
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/PureCloudRegionHosts.js +1 -0
- 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 +1 -1
- 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 +157 -8
- 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 +26 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- 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 +3 -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/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 +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -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 144.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -20,6 +20,81 @@ class GamificationApi {
|
|
|
20
20
|
}
|
|
21
21
|
|
|
22
22
|
|
|
23
|
+
/**
|
|
24
|
+
* Delete an External Metric Definition
|
|
25
|
+
*
|
|
26
|
+
* @param {String} metricId Specifies the External Metric Definition ID
|
|
27
|
+
*/
|
|
28
|
+
deleteEmployeeperformanceExternalmetricsDefinition(metricId) {
|
|
29
|
+
// verify the required parameter 'metricId' is set
|
|
30
|
+
if (metricId === undefined || metricId === null) {
|
|
31
|
+
throw 'Missing the required parameter "metricId" when calling deleteEmployeeperformanceExternalmetricsDefinition';
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
return this.apiClient.callApi(
|
|
35
|
+
'/api/v2/employeeperformance/externalmetrics/definitions/{metricId}',
|
|
36
|
+
'DELETE',
|
|
37
|
+
{ 'metricId': metricId },
|
|
38
|
+
{ },
|
|
39
|
+
{ },
|
|
40
|
+
{ },
|
|
41
|
+
null,
|
|
42
|
+
['PureCloud OAuth'],
|
|
43
|
+
['application/json'],
|
|
44
|
+
['application/json']
|
|
45
|
+
);
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
/**
|
|
49
|
+
* Get an External Metric Definition
|
|
50
|
+
*
|
|
51
|
+
* @param {String} metricId Specifies the External Metric Definition ID
|
|
52
|
+
*/
|
|
53
|
+
getEmployeeperformanceExternalmetricsDefinition(metricId) {
|
|
54
|
+
// verify the required parameter 'metricId' is set
|
|
55
|
+
if (metricId === undefined || metricId === null) {
|
|
56
|
+
throw 'Missing the required parameter "metricId" when calling getEmployeeperformanceExternalmetricsDefinition';
|
|
57
|
+
}
|
|
58
|
+
|
|
59
|
+
return this.apiClient.callApi(
|
|
60
|
+
'/api/v2/employeeperformance/externalmetrics/definitions/{metricId}',
|
|
61
|
+
'GET',
|
|
62
|
+
{ 'metricId': metricId },
|
|
63
|
+
{ },
|
|
64
|
+
{ },
|
|
65
|
+
{ },
|
|
66
|
+
null,
|
|
67
|
+
['PureCloud OAuth'],
|
|
68
|
+
['application/json'],
|
|
69
|
+
['application/json']
|
|
70
|
+
);
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
/**
|
|
74
|
+
* Get a list of External Metric Definitions of an organization, sorted by name in ascending order
|
|
75
|
+
*
|
|
76
|
+
* @param {Object} opts Optional parameters
|
|
77
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
78
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
79
|
+
*/
|
|
80
|
+
getEmployeeperformanceExternalmetricsDefinitions(opts) {
|
|
81
|
+
opts = opts || {};
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
return this.apiClient.callApi(
|
|
85
|
+
'/api/v2/employeeperformance/externalmetrics/definitions',
|
|
86
|
+
'GET',
|
|
87
|
+
{ },
|
|
88
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
89
|
+
{ },
|
|
90
|
+
{ },
|
|
91
|
+
null,
|
|
92
|
+
['PureCloud OAuth'],
|
|
93
|
+
['application/json'],
|
|
94
|
+
['application/json']
|
|
95
|
+
);
|
|
96
|
+
}
|
|
97
|
+
|
|
23
98
|
/**
|
|
24
99
|
* Leaderboard of the requesting user's division or performance profile
|
|
25
100
|
*
|
|
@@ -684,14 +759,14 @@ class GamificationApi {
|
|
|
684
759
|
* @param {String} profileId performanceProfileId
|
|
685
760
|
* @param {String} metricId metricId
|
|
686
761
|
* @param {Object} filterType Filter type for the query request.
|
|
687
|
-
* @param {String} filterId ID for the filter type. For example, division Id
|
|
688
762
|
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
689
763
|
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
690
764
|
* @param {Object} opts Optional parameters
|
|
765
|
+
* @param {String} opts.filterId ID for the filter type. Only required when filterType is Division.
|
|
691
766
|
* @param {String} opts.referenceWorkday Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
692
767
|
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
693
768
|
*/
|
|
694
|
-
getGamificationScorecardsProfileMetricUsersValuesTrends(profileId, metricId, filterType,
|
|
769
|
+
getGamificationScorecardsProfileMetricUsersValuesTrends(profileId, metricId, filterType, startWorkday, endWorkday, opts) {
|
|
695
770
|
opts = opts || {};
|
|
696
771
|
|
|
697
772
|
// verify the required parameter 'profileId' is set
|
|
@@ -706,10 +781,6 @@ class GamificationApi {
|
|
|
706
781
|
if (filterType === undefined || filterType === null) {
|
|
707
782
|
throw 'Missing the required parameter "filterType" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
708
783
|
}
|
|
709
|
-
// verify the required parameter 'filterId' is set
|
|
710
|
-
if (filterId === undefined || filterId === null) {
|
|
711
|
-
throw 'Missing the required parameter "filterId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
712
|
-
}
|
|
713
784
|
// verify the required parameter 'startWorkday' is set
|
|
714
785
|
if (startWorkday === undefined || startWorkday === null) {
|
|
715
786
|
throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
@@ -723,7 +794,7 @@ class GamificationApi {
|
|
|
723
794
|
'/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/values/trends',
|
|
724
795
|
'GET',
|
|
725
796
|
{ 'profileId': profileId,'metricId': metricId },
|
|
726
|
-
{ 'filterType': filterType,'filterId': filterId,'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
797
|
+
{ 'filterType': filterType,'filterId': opts['filterId'],'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
727
798
|
{ },
|
|
728
799
|
{ },
|
|
729
800
|
null,
|
|
@@ -1229,6 +1300,84 @@ class GamificationApi {
|
|
|
1229
1300
|
);
|
|
1230
1301
|
}
|
|
1231
1302
|
|
|
1303
|
+
/**
|
|
1304
|
+
* Update External Metric Definition
|
|
1305
|
+
*
|
|
1306
|
+
* @param {String} metricId Specifies the metric definition ID
|
|
1307
|
+
* @param {Object} body The External Metric Definition parameters to be updated
|
|
1308
|
+
*/
|
|
1309
|
+
patchEmployeeperformanceExternalmetricsDefinition(metricId, body) {
|
|
1310
|
+
// verify the required parameter 'metricId' is set
|
|
1311
|
+
if (metricId === undefined || metricId === null) {
|
|
1312
|
+
throw 'Missing the required parameter "metricId" when calling patchEmployeeperformanceExternalmetricsDefinition';
|
|
1313
|
+
}
|
|
1314
|
+
// verify the required parameter 'body' is set
|
|
1315
|
+
if (body === undefined || body === null) {
|
|
1316
|
+
throw 'Missing the required parameter "body" when calling patchEmployeeperformanceExternalmetricsDefinition';
|
|
1317
|
+
}
|
|
1318
|
+
|
|
1319
|
+
return this.apiClient.callApi(
|
|
1320
|
+
'/api/v2/employeeperformance/externalmetrics/definitions/{metricId}',
|
|
1321
|
+
'PATCH',
|
|
1322
|
+
{ 'metricId': metricId },
|
|
1323
|
+
{ },
|
|
1324
|
+
{ },
|
|
1325
|
+
{ },
|
|
1326
|
+
body,
|
|
1327
|
+
['PureCloud OAuth'],
|
|
1328
|
+
['application/json'],
|
|
1329
|
+
['application/json']
|
|
1330
|
+
);
|
|
1331
|
+
}
|
|
1332
|
+
|
|
1333
|
+
/**
|
|
1334
|
+
* Write External Metric Data
|
|
1335
|
+
*
|
|
1336
|
+
* @param {Object} opts Optional parameters
|
|
1337
|
+
* @param {Object} opts.body The External Metric Data to be added
|
|
1338
|
+
*/
|
|
1339
|
+
postEmployeeperformanceExternalmetricsData(opts) {
|
|
1340
|
+
opts = opts || {};
|
|
1341
|
+
|
|
1342
|
+
|
|
1343
|
+
return this.apiClient.callApi(
|
|
1344
|
+
'/api/v2/employeeperformance/externalmetrics/data',
|
|
1345
|
+
'POST',
|
|
1346
|
+
{ },
|
|
1347
|
+
{ },
|
|
1348
|
+
{ },
|
|
1349
|
+
{ },
|
|
1350
|
+
opts['body'],
|
|
1351
|
+
['PureCloud OAuth'],
|
|
1352
|
+
['application/json'],
|
|
1353
|
+
['application/json']
|
|
1354
|
+
);
|
|
1355
|
+
}
|
|
1356
|
+
|
|
1357
|
+
/**
|
|
1358
|
+
* Create External Metric Definition
|
|
1359
|
+
*
|
|
1360
|
+
* @param {Object} opts Optional parameters
|
|
1361
|
+
* @param {Object} opts.body The External Metric Definition to be created
|
|
1362
|
+
*/
|
|
1363
|
+
postEmployeeperformanceExternalmetricsDefinitions(opts) {
|
|
1364
|
+
opts = opts || {};
|
|
1365
|
+
|
|
1366
|
+
|
|
1367
|
+
return this.apiClient.callApi(
|
|
1368
|
+
'/api/v2/employeeperformance/externalmetrics/definitions',
|
|
1369
|
+
'POST',
|
|
1370
|
+
{ },
|
|
1371
|
+
{ },
|
|
1372
|
+
{ },
|
|
1373
|
+
{ },
|
|
1374
|
+
opts['body'],
|
|
1375
|
+
['PureCloud OAuth'],
|
|
1376
|
+
['application/json'],
|
|
1377
|
+
['application/json']
|
|
1378
|
+
);
|
|
1379
|
+
}
|
|
1380
|
+
|
|
1232
1381
|
/**
|
|
1233
1382
|
* Creates a gamified metric with a given metric definition and metric objective
|
|
1234
1383
|
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
|
|
@@ -5,7 +5,7 @@ class LearningApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Learning service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 144.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -358,6 +358,31 @@ class LearningApi {
|
|
|
358
358
|
);
|
|
359
359
|
}
|
|
360
360
|
|
|
361
|
+
/**
|
|
362
|
+
* Get a specific Learning Module cover art using ID
|
|
363
|
+
*
|
|
364
|
+
* @param {String} coverArtId Key identifier for the cover art
|
|
365
|
+
*/
|
|
366
|
+
getLearningModulesCoverartCoverArtId(coverArtId) {
|
|
367
|
+
// verify the required parameter 'coverArtId' is set
|
|
368
|
+
if (coverArtId === undefined || coverArtId === null) {
|
|
369
|
+
throw 'Missing the required parameter "coverArtId" when calling getLearningModulesCoverartCoverArtId';
|
|
370
|
+
}
|
|
371
|
+
|
|
372
|
+
return this.apiClient.callApi(
|
|
373
|
+
'/api/v2/learning/modules/coverart/{coverArtId}',
|
|
374
|
+
'GET',
|
|
375
|
+
{ 'coverArtId': coverArtId },
|
|
376
|
+
{ },
|
|
377
|
+
{ },
|
|
378
|
+
{ },
|
|
379
|
+
null,
|
|
380
|
+
['PureCloud OAuth'],
|
|
381
|
+
['application/json'],
|
|
382
|
+
['application/json']
|
|
383
|
+
);
|
|
384
|
+
}
|
|
385
|
+
|
|
361
386
|
/**
|
|
362
387
|
* Update Learning Assignment
|
|
363
388
|
*
|
|
@@ -5,7 +5,7 @@ class SpeechTextAnalyticsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* SpeechTextAnalytics service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 144.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -230,6 +230,7 @@ class SpeechTextAnalyticsApi {
|
|
|
230
230
|
* @param {Object} opts Optional parameters
|
|
231
231
|
* @param {String} opts.nextPage The key for listing the next page
|
|
232
232
|
* @param {Number} opts.pageSize The page size for the listing (default to 20)
|
|
233
|
+
* @param {Object} opts.state Program state. Defaults to Latest
|
|
233
234
|
*/
|
|
234
235
|
getSpeechandtextanalyticsPrograms(opts) {
|
|
235
236
|
opts = opts || {};
|
|
@@ -239,7 +240,7 @@ class SpeechTextAnalyticsApi {
|
|
|
239
240
|
'/api/v2/speechandtextanalytics/programs',
|
|
240
241
|
'GET',
|
|
241
242
|
{ },
|
|
242
|
-
{ 'nextPage': opts['nextPage'],'pageSize': opts['pageSize'] },
|
|
243
|
+
{ 'nextPage': opts['nextPage'],'pageSize': opts['pageSize'],'state': opts['state'] },
|
|
243
244
|
{ },
|
|
244
245
|
{ },
|
|
245
246
|
null,
|