purecloud-platform-client-v2 140.0.0 → 141.1.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 +504 -80
- package/dist/web-amd/purecloud-platform-client-v2.js +504 -81
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +504 -80
- package/dist/web-cjs/purecloud-platform-client-v2.js +2598 -118
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +396 -196
- package/package.json +2 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +18 -16
- 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 +152 -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/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 +35 -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 +4 -2
- 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 +26 -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/TeamsApi.js +184 -0
- 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 +26 -1
- package/src/purecloud-platform-client-v2/index.js +7 -1
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
3
|
var axios = require('axios');
|
|
4
|
+
var qs = require('qs');
|
|
4
5
|
|
|
5
6
|
function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
|
|
6
7
|
|
|
7
8
|
var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
|
|
9
|
+
var qs__default = /*#__PURE__*/_interopDefaultLegacy(qs);
|
|
8
10
|
|
|
9
11
|
var PureCloudRegionHosts = {
|
|
10
12
|
us_east_1: 'mypurecloud.com',
|
|
@@ -399,7 +401,7 @@ class Configuration {
|
|
|
399
401
|
|
|
400
402
|
/**
|
|
401
403
|
* @module purecloud-platform-client-v2/ApiClient
|
|
402
|
-
* @version
|
|
404
|
+
* @version 141.1.0
|
|
403
405
|
*/
|
|
404
406
|
class ApiClient {
|
|
405
407
|
/**
|
|
@@ -434,7 +436,7 @@ class ApiClient {
|
|
|
434
436
|
|
|
435
437
|
/**
|
|
436
438
|
* Enumeration of collection format separator strategies.
|
|
437
|
-
* @enum {String}
|
|
439
|
+
* @enum {String}
|
|
438
440
|
* @readonly
|
|
439
441
|
*/
|
|
440
442
|
this.CollectionFormatEnum = {
|
|
@@ -581,7 +583,7 @@ class ApiClient {
|
|
|
581
583
|
// Load current auth data
|
|
582
584
|
const tempState = this.authData.state;
|
|
583
585
|
this.authData = localStorage.getItem(`${this.settingsPrefix}_auth_data`);
|
|
584
|
-
if (!this.authData)
|
|
586
|
+
if (!this.authData)
|
|
585
587
|
this.authData = {};
|
|
586
588
|
else
|
|
587
589
|
this.authData = JSON.parse(this.authData);
|
|
@@ -601,7 +603,7 @@ class ApiClient {
|
|
|
601
603
|
* @description Initiates the implicit grant login flow. Will attempt to load the token from local storage, if enabled.
|
|
602
604
|
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
603
605
|
* @param {string} redirectUri - The redirect URI of the OAuth Implicit Grant client
|
|
604
|
-
* @param {object} opts - (optional) Additional options
|
|
606
|
+
* @param {object} opts - (optional) Additional options
|
|
605
607
|
* @param {string} opts.state - (optional) An arbitrary string to be passed back with the login response. Used for client apps to associate login responses with a request.
|
|
606
608
|
* @param {string} opts.org - (optional) The organization name that would normally used when specifying an organization name when logging in. This is only used when a provider is also specified.
|
|
607
609
|
* @param {string} opts.provider - (optional) Authentication provider to log in with e.g. okta, adfs, salesforce, onelogin. This is only used when an org is also specified.
|
|
@@ -747,9 +749,9 @@ class ApiClient {
|
|
|
747
749
|
}
|
|
748
750
|
var encodedData = Buffer.from(clientId + ':' + clientSecret).toString('base64');
|
|
749
751
|
var request = this._formAuthRequest(encodedData,
|
|
750
|
-
{ grant_type: 'urn:ietf:params:oauth:grant-type:saml2-bearer'
|
|
751
|
-
|
|
752
|
-
|
|
752
|
+
{ grant_type: 'urn:ietf:params:oauth:grant-type:saml2-bearer',
|
|
753
|
+
orgName: orgName,
|
|
754
|
+
assertion: assertion });
|
|
753
755
|
request.proxy = this.proxy;
|
|
754
756
|
var bodyParam = {
|
|
755
757
|
grant_type: 'urn:ietf:params:oauth:grant-type:saml2-bearer',
|
|
@@ -828,9 +830,9 @@ class ApiClient {
|
|
|
828
830
|
}
|
|
829
831
|
var encodedData = Buffer.from(clientId + ':' + clientSecret).toString('base64');
|
|
830
832
|
var request = this._formAuthRequest(encodedData,
|
|
831
|
-
{ grant_type: 'authorization_code'
|
|
832
|
-
|
|
833
|
-
|
|
833
|
+
{ grant_type: 'authorization_code',
|
|
834
|
+
code: authCode,
|
|
835
|
+
redirect_uri: redirectUri });
|
|
834
836
|
request.proxy = this.proxy;
|
|
835
837
|
var bodyParam = {
|
|
836
838
|
grant_type: 'authorization_code',
|
|
@@ -856,7 +858,7 @@ class ApiClient {
|
|
|
856
858
|
return;
|
|
857
859
|
}
|
|
858
860
|
var encodedData = Buffer.from(clientId + ':' + clientSecret).toString('base64');
|
|
859
|
-
var request = this._formAuthRequest(encodedData, { grant_type: 'refresh_token'
|
|
861
|
+
var request = this._formAuthRequest(encodedData, { grant_type: 'refresh_token' , refresh_token: refreshToken });
|
|
860
862
|
request.proxy = this.proxy;
|
|
861
863
|
var bodyParam = {
|
|
862
864
|
grant_type: 'refresh_token',
|
|
@@ -933,8 +935,9 @@ class ApiClient {
|
|
|
933
935
|
/**
|
|
934
936
|
* @description Utility function to create the request for auth requests
|
|
935
937
|
* @param {string} encodedData - Base64 encoded client and clientSecret pair
|
|
938
|
+
* @param {object} data - data to url form encode
|
|
936
939
|
*/
|
|
937
|
-
_formAuthRequest(encodedData) {
|
|
940
|
+
_formAuthRequest(encodedData, data) {
|
|
938
941
|
var request = axios__default["default"]({
|
|
939
942
|
method: `POST`,
|
|
940
943
|
url: `https://login.${this.config.environment}/oauth/token`,
|
|
@@ -942,7 +945,7 @@ class ApiClient {
|
|
|
942
945
|
'Authorization': 'Basic ' + encodedData,
|
|
943
946
|
'Content-Type': 'application/x-www-form-urlencoded'
|
|
944
947
|
},
|
|
945
|
-
data:
|
|
948
|
+
data: qs__default["default"].stringify(data)
|
|
946
949
|
});
|
|
947
950
|
|
|
948
951
|
return request;
|
|
@@ -1006,7 +1009,7 @@ class ApiClient {
|
|
|
1006
1009
|
}
|
|
1007
1010
|
|
|
1008
1011
|
// Test token
|
|
1009
|
-
this.callApi('/api/v2/tokens/me', 'GET',
|
|
1012
|
+
this.callApi('/api/v2/tokens/me', 'GET',
|
|
1010
1013
|
null, null, null, null, null, ['PureCloud OAuth'], ['application/json'], ['application/json'])
|
|
1011
1014
|
.then(() => {
|
|
1012
1015
|
resolve();
|
|
@@ -1032,7 +1035,7 @@ class ApiClient {
|
|
|
1032
1035
|
const match = hashRegex.exec(h);
|
|
1033
1036
|
if (match) hash[match[1]] = decodeURIComponent(decodeURIComponent(match[2].replace(/\+/g, '%20')));
|
|
1034
1037
|
});
|
|
1035
|
-
|
|
1038
|
+
|
|
1036
1039
|
// Check for error
|
|
1037
1040
|
if (hash.error) {
|
|
1038
1041
|
return hash;
|
|
@@ -1230,7 +1233,7 @@ class ApiClient {
|
|
|
1230
1233
|
/**
|
|
1231
1234
|
* Checks whether the given parameter value represents file-like content.
|
|
1232
1235
|
* @param param The parameter to check.
|
|
1233
|
-
* @returns {Boolean} <code>true</code> if <code>param</code> represents a file.
|
|
1236
|
+
* @returns {Boolean} <code>true</code> if <code>param</code> represents a file.
|
|
1234
1237
|
*/
|
|
1235
1238
|
isFileParam(param) {
|
|
1236
1239
|
// fs.ReadStream in Node.js (but not in runtime like browserify)
|
|
@@ -1477,7 +1480,7 @@ class AlertingApi {
|
|
|
1477
1480
|
/**
|
|
1478
1481
|
* Alerting service.
|
|
1479
1482
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1480
|
-
* @version
|
|
1483
|
+
* @version 141.1.0
|
|
1481
1484
|
*/
|
|
1482
1485
|
|
|
1483
1486
|
/**
|
|
@@ -1791,7 +1794,7 @@ class AnalyticsApi {
|
|
|
1791
1794
|
/**
|
|
1792
1795
|
* Analytics service.
|
|
1793
1796
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1794
|
-
* @version
|
|
1797
|
+
* @version 141.1.0
|
|
1795
1798
|
*/
|
|
1796
1799
|
|
|
1797
1800
|
/**
|
|
@@ -2973,7 +2976,7 @@ class ArchitectApi {
|
|
|
2973
2976
|
/**
|
|
2974
2977
|
* Architect service.
|
|
2975
2978
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2976
|
-
* @version
|
|
2979
|
+
* @version 141.1.0
|
|
2977
2980
|
*/
|
|
2978
2981
|
|
|
2979
2982
|
/**
|
|
@@ -6018,7 +6021,7 @@ class AuditApi {
|
|
|
6018
6021
|
/**
|
|
6019
6022
|
* Audit service.
|
|
6020
6023
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
6021
|
-
* @version
|
|
6024
|
+
* @version 141.1.0
|
|
6022
6025
|
*/
|
|
6023
6026
|
|
|
6024
6027
|
/**
|
|
@@ -6189,7 +6192,7 @@ class AuthorizationApi {
|
|
|
6189
6192
|
/**
|
|
6190
6193
|
* Authorization service.
|
|
6191
6194
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6192
|
-
* @version
|
|
6195
|
+
* @version 141.1.0
|
|
6193
6196
|
*/
|
|
6194
6197
|
|
|
6195
6198
|
/**
|
|
@@ -7372,7 +7375,7 @@ class BillingApi {
|
|
|
7372
7375
|
/**
|
|
7373
7376
|
* Billing service.
|
|
7374
7377
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7375
|
-
* @version
|
|
7378
|
+
* @version 141.1.0
|
|
7376
7379
|
*/
|
|
7377
7380
|
|
|
7378
7381
|
/**
|
|
@@ -7452,7 +7455,7 @@ class ChatApi {
|
|
|
7452
7455
|
/**
|
|
7453
7456
|
* Chat service.
|
|
7454
7457
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7455
|
-
* @version
|
|
7458
|
+
* @version 141.1.0
|
|
7456
7459
|
*/
|
|
7457
7460
|
|
|
7458
7461
|
/**
|
|
@@ -7543,7 +7546,7 @@ class CoachingApi {
|
|
|
7543
7546
|
/**
|
|
7544
7547
|
* Coaching service.
|
|
7545
7548
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7546
|
-
* @version
|
|
7549
|
+
* @version 141.1.0
|
|
7547
7550
|
*/
|
|
7548
7551
|
|
|
7549
7552
|
/**
|
|
@@ -8120,7 +8123,7 @@ class ContentManagementApi {
|
|
|
8120
8123
|
/**
|
|
8121
8124
|
* ContentManagement service.
|
|
8122
8125
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8123
|
-
* @version
|
|
8126
|
+
* @version 141.1.0
|
|
8124
8127
|
*/
|
|
8125
8128
|
|
|
8126
8129
|
/**
|
|
@@ -9260,7 +9263,7 @@ class ConversationsApi {
|
|
|
9260
9263
|
/**
|
|
9261
9264
|
* Conversations service.
|
|
9262
9265
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9263
|
-
* @version
|
|
9266
|
+
* @version 141.1.0
|
|
9264
9267
|
*/
|
|
9265
9268
|
|
|
9266
9269
|
/**
|
|
@@ -14194,7 +14197,7 @@ class DataExtensionsApi {
|
|
|
14194
14197
|
/**
|
|
14195
14198
|
* DataExtensions service.
|
|
14196
14199
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
14197
|
-
* @version
|
|
14200
|
+
* @version 141.1.0
|
|
14198
14201
|
*/
|
|
14199
14202
|
|
|
14200
14203
|
/**
|
|
@@ -14280,7 +14283,7 @@ class ExternalContactsApi {
|
|
|
14280
14283
|
/**
|
|
14281
14284
|
* ExternalContacts service.
|
|
14282
14285
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
14283
|
-
* @version
|
|
14286
|
+
* @version 141.1.0
|
|
14284
14287
|
*/
|
|
14285
14288
|
|
|
14286
14289
|
/**
|
|
@@ -16023,7 +16026,7 @@ class FaxApi {
|
|
|
16023
16026
|
/**
|
|
16024
16027
|
* Fax service.
|
|
16025
16028
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
16026
|
-
* @version
|
|
16029
|
+
* @version 141.1.0
|
|
16027
16030
|
*/
|
|
16028
16031
|
|
|
16029
16032
|
/**
|
|
@@ -16194,7 +16197,7 @@ class FlowsApi {
|
|
|
16194
16197
|
/**
|
|
16195
16198
|
* Flows service.
|
|
16196
16199
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
16197
|
-
* @version
|
|
16200
|
+
* @version 141.1.0
|
|
16198
16201
|
*/
|
|
16199
16202
|
|
|
16200
16203
|
/**
|
|
@@ -16265,7 +16268,7 @@ class GamificationApi {
|
|
|
16265
16268
|
/**
|
|
16266
16269
|
* Gamification service.
|
|
16267
16270
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
16268
|
-
* @version
|
|
16271
|
+
* @version 141.1.0
|
|
16269
16272
|
*/
|
|
16270
16273
|
|
|
16271
16274
|
/**
|
|
@@ -16888,6 +16891,157 @@ class GamificationApi {
|
|
|
16888
16891
|
);
|
|
16889
16892
|
}
|
|
16890
16893
|
|
|
16894
|
+
/**
|
|
16895
|
+
* Average performance values trends by metric of a user
|
|
16896
|
+
*
|
|
16897
|
+
* @param {String} profileId performanceProfileId
|
|
16898
|
+
* @param {String} metricId metricId
|
|
16899
|
+
* @param {String} userId
|
|
16900
|
+
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
16901
|
+
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
16902
|
+
* @param {Object} opts Optional parameters
|
|
16903
|
+
* @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
|
|
16904
|
+
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
16905
|
+
*/
|
|
16906
|
+
getGamificationScorecardsProfileMetricUserValuesTrends(profileId, metricId, userId, startWorkday, endWorkday, opts) {
|
|
16907
|
+
opts = opts || {};
|
|
16908
|
+
|
|
16909
|
+
// verify the required parameter 'profileId' is set
|
|
16910
|
+
if (profileId === undefined || profileId === null) {
|
|
16911
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
16912
|
+
}
|
|
16913
|
+
// verify the required parameter 'metricId' is set
|
|
16914
|
+
if (metricId === undefined || metricId === null) {
|
|
16915
|
+
throw 'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
16916
|
+
}
|
|
16917
|
+
// verify the required parameter 'userId' is set
|
|
16918
|
+
if (userId === undefined || userId === null) {
|
|
16919
|
+
throw 'Missing the required parameter "userId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
16920
|
+
}
|
|
16921
|
+
// verify the required parameter 'startWorkday' is set
|
|
16922
|
+
if (startWorkday === undefined || startWorkday === null) {
|
|
16923
|
+
throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
16924
|
+
}
|
|
16925
|
+
// verify the required parameter 'endWorkday' is set
|
|
16926
|
+
if (endWorkday === undefined || endWorkday === null) {
|
|
16927
|
+
throw 'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
16928
|
+
}
|
|
16929
|
+
|
|
16930
|
+
return this.apiClient.callApi(
|
|
16931
|
+
'/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/{userId}/values/trends',
|
|
16932
|
+
'GET',
|
|
16933
|
+
{ 'profileId': profileId,'metricId': metricId,'userId': userId },
|
|
16934
|
+
{ 'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
16935
|
+
{ },
|
|
16936
|
+
{ },
|
|
16937
|
+
null,
|
|
16938
|
+
['PureCloud OAuth'],
|
|
16939
|
+
['application/json'],
|
|
16940
|
+
['application/json']
|
|
16941
|
+
);
|
|
16942
|
+
}
|
|
16943
|
+
|
|
16944
|
+
/**
|
|
16945
|
+
* Average performance values trends by metric of a division or a performance profile
|
|
16946
|
+
*
|
|
16947
|
+
* @param {String} profileId performanceProfileId
|
|
16948
|
+
* @param {String} metricId metricId
|
|
16949
|
+
* @param {Object} filterType Filter type for the query request.
|
|
16950
|
+
* @param {String} filterId ID for the filter type. For example, division Id
|
|
16951
|
+
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
16952
|
+
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
16953
|
+
* @param {Object} opts Optional parameters
|
|
16954
|
+
* @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
|
|
16955
|
+
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
16956
|
+
*/
|
|
16957
|
+
getGamificationScorecardsProfileMetricUsersValuesTrends(profileId, metricId, filterType, filterId, startWorkday, endWorkday, opts) {
|
|
16958
|
+
opts = opts || {};
|
|
16959
|
+
|
|
16960
|
+
// verify the required parameter 'profileId' is set
|
|
16961
|
+
if (profileId === undefined || profileId === null) {
|
|
16962
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
16963
|
+
}
|
|
16964
|
+
// verify the required parameter 'metricId' is set
|
|
16965
|
+
if (metricId === undefined || metricId === null) {
|
|
16966
|
+
throw 'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
16967
|
+
}
|
|
16968
|
+
// verify the required parameter 'filterType' is set
|
|
16969
|
+
if (filterType === undefined || filterType === null) {
|
|
16970
|
+
throw 'Missing the required parameter "filterType" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
16971
|
+
}
|
|
16972
|
+
// verify the required parameter 'filterId' is set
|
|
16973
|
+
if (filterId === undefined || filterId === null) {
|
|
16974
|
+
throw 'Missing the required parameter "filterId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
16975
|
+
}
|
|
16976
|
+
// verify the required parameter 'startWorkday' is set
|
|
16977
|
+
if (startWorkday === undefined || startWorkday === null) {
|
|
16978
|
+
throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
16979
|
+
}
|
|
16980
|
+
// verify the required parameter 'endWorkday' is set
|
|
16981
|
+
if (endWorkday === undefined || endWorkday === null) {
|
|
16982
|
+
throw 'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
16983
|
+
}
|
|
16984
|
+
|
|
16985
|
+
return this.apiClient.callApi(
|
|
16986
|
+
'/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/values/trends',
|
|
16987
|
+
'GET',
|
|
16988
|
+
{ 'profileId': profileId,'metricId': metricId },
|
|
16989
|
+
{ 'filterType': filterType,'filterId': filterId,'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
16990
|
+
{ },
|
|
16991
|
+
{ },
|
|
16992
|
+
null,
|
|
16993
|
+
['PureCloud OAuth'],
|
|
16994
|
+
['application/json'],
|
|
16995
|
+
['application/json']
|
|
16996
|
+
);
|
|
16997
|
+
}
|
|
16998
|
+
|
|
16999
|
+
/**
|
|
17000
|
+
* Average performance values trends by metric of the requesting user
|
|
17001
|
+
*
|
|
17002
|
+
* @param {String} profileId performanceProfileId
|
|
17003
|
+
* @param {String} metricId metricId
|
|
17004
|
+
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
17005
|
+
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
17006
|
+
* @param {Object} opts Optional parameters
|
|
17007
|
+
* @param {Object} opts.filterType Filter type for the query request. If not set, returns the values trends of the requesting user
|
|
17008
|
+
* @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
|
|
17009
|
+
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
17010
|
+
*/
|
|
17011
|
+
getGamificationScorecardsProfileMetricValuesTrends(profileId, metricId, startWorkday, endWorkday, opts) {
|
|
17012
|
+
opts = opts || {};
|
|
17013
|
+
|
|
17014
|
+
// verify the required parameter 'profileId' is set
|
|
17015
|
+
if (profileId === undefined || profileId === null) {
|
|
17016
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
17017
|
+
}
|
|
17018
|
+
// verify the required parameter 'metricId' is set
|
|
17019
|
+
if (metricId === undefined || metricId === null) {
|
|
17020
|
+
throw 'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
17021
|
+
}
|
|
17022
|
+
// verify the required parameter 'startWorkday' is set
|
|
17023
|
+
if (startWorkday === undefined || startWorkday === null) {
|
|
17024
|
+
throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
17025
|
+
}
|
|
17026
|
+
// verify the required parameter 'endWorkday' is set
|
|
17027
|
+
if (endWorkday === undefined || endWorkday === null) {
|
|
17028
|
+
throw 'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
17029
|
+
}
|
|
17030
|
+
|
|
17031
|
+
return this.apiClient.callApi(
|
|
17032
|
+
'/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/values/trends',
|
|
17033
|
+
'GET',
|
|
17034
|
+
{ 'profileId': profileId,'metricId': metricId },
|
|
17035
|
+
{ 'filterType': opts['filterType'],'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
17036
|
+
{ },
|
|
17037
|
+
{ },
|
|
17038
|
+
null,
|
|
17039
|
+
['PureCloud OAuth'],
|
|
17040
|
+
['application/json'],
|
|
17041
|
+
['application/json']
|
|
17042
|
+
);
|
|
17043
|
+
}
|
|
17044
|
+
|
|
16891
17045
|
/**
|
|
16892
17046
|
* Workday performance metrics for a user
|
|
16893
17047
|
*
|
|
@@ -17696,7 +17850,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
17696
17850
|
/**
|
|
17697
17851
|
* GeneralDataProtectionRegulation service.
|
|
17698
17852
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
17699
|
-
* @version
|
|
17853
|
+
* @version 141.1.0
|
|
17700
17854
|
*/
|
|
17701
17855
|
|
|
17702
17856
|
/**
|
|
@@ -17826,7 +17980,7 @@ class GeolocationApi {
|
|
|
17826
17980
|
/**
|
|
17827
17981
|
* Geolocation service.
|
|
17828
17982
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
17829
|
-
* @version
|
|
17983
|
+
* @version 141.1.0
|
|
17830
17984
|
*/
|
|
17831
17985
|
|
|
17832
17986
|
/**
|
|
@@ -17957,7 +18111,7 @@ class GreetingsApi {
|
|
|
17957
18111
|
/**
|
|
17958
18112
|
* Greetings service.
|
|
17959
18113
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
17960
|
-
* @version
|
|
18114
|
+
* @version 141.1.0
|
|
17961
18115
|
*/
|
|
17962
18116
|
|
|
17963
18117
|
/**
|
|
@@ -18412,7 +18566,7 @@ class GroupsApi {
|
|
|
18412
18566
|
/**
|
|
18413
18567
|
* Groups service.
|
|
18414
18568
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
18415
|
-
* @version
|
|
18569
|
+
* @version 141.1.0
|
|
18416
18570
|
*/
|
|
18417
18571
|
|
|
18418
18572
|
/**
|
|
@@ -18817,7 +18971,7 @@ class IdentityProviderApi {
|
|
|
18817
18971
|
/**
|
|
18818
18972
|
* IdentityProvider service.
|
|
18819
18973
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
18820
|
-
* @version
|
|
18974
|
+
* @version 141.1.0
|
|
18821
18975
|
*/
|
|
18822
18976
|
|
|
18823
18977
|
/**
|
|
@@ -19573,7 +19727,7 @@ class IntegrationsApi {
|
|
|
19573
19727
|
/**
|
|
19574
19728
|
* Integrations service.
|
|
19575
19729
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
19576
|
-
* @version
|
|
19730
|
+
* @version 141.1.0
|
|
19577
19731
|
*/
|
|
19578
19732
|
|
|
19579
19733
|
/**
|
|
@@ -21250,7 +21404,7 @@ class JourneyApi {
|
|
|
21250
21404
|
/**
|
|
21251
21405
|
* Journey service.
|
|
21252
21406
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
21253
|
-
* @version
|
|
21407
|
+
* @version 141.1.0
|
|
21254
21408
|
*/
|
|
21255
21409
|
|
|
21256
21410
|
/**
|
|
@@ -21961,7 +22115,7 @@ class KnowledgeApi {
|
|
|
21961
22115
|
/**
|
|
21962
22116
|
* Knowledge service.
|
|
21963
22117
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
21964
|
-
* @version
|
|
22118
|
+
* @version 141.1.0
|
|
21965
22119
|
*/
|
|
21966
22120
|
|
|
21967
22121
|
/**
|
|
@@ -22861,7 +23015,7 @@ class LanguageUnderstandingApi {
|
|
|
22861
23015
|
/**
|
|
22862
23016
|
* LanguageUnderstanding service.
|
|
22863
23017
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
22864
|
-
* @version
|
|
23018
|
+
* @version 141.1.0
|
|
22865
23019
|
*/
|
|
22866
23020
|
|
|
22867
23021
|
/**
|
|
@@ -23765,7 +23919,7 @@ class LanguagesApi {
|
|
|
23765
23919
|
/**
|
|
23766
23920
|
* Languages service.
|
|
23767
23921
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
23768
|
-
* @version
|
|
23922
|
+
* @version 141.1.0
|
|
23769
23923
|
*/
|
|
23770
23924
|
|
|
23771
23925
|
/**
|
|
@@ -24033,7 +24187,7 @@ class LearningApi {
|
|
|
24033
24187
|
/**
|
|
24034
24188
|
* Learning service.
|
|
24035
24189
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
24036
|
-
* @version
|
|
24190
|
+
* @version 141.1.0
|
|
24037
24191
|
*/
|
|
24038
24192
|
|
|
24039
24193
|
/**
|
|
@@ -24352,6 +24506,40 @@ class LearningApi {
|
|
|
24352
24506
|
);
|
|
24353
24507
|
}
|
|
24354
24508
|
|
|
24509
|
+
/**
|
|
24510
|
+
* Get all learning modules of an organization including assignments for a specific user
|
|
24511
|
+
*
|
|
24512
|
+
* @param {Array.<String>} userIds The IDs of the users to include
|
|
24513
|
+
* @param {Object} opts Optional parameters
|
|
24514
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
24515
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
24516
|
+
* @param {String} opts.searchTerm Search Term (searches by name and description)
|
|
24517
|
+
* @param {Object} opts.overdue Specifies if only modules with overdue/not overdue (overdue is True or False) assignments are returned. If overdue is Any or omitted, both are returned and can including modules that are unassigned. (default to Any)
|
|
24518
|
+
* @param {Array.<String>} opts.assignmentStates Specifies the assignment states to return.
|
|
24519
|
+
* @param {Array.<String>} opts.expand Fields to expand in response(case insensitive)
|
|
24520
|
+
*/
|
|
24521
|
+
getLearningModulesAssignments(userIds, opts) {
|
|
24522
|
+
opts = opts || {};
|
|
24523
|
+
|
|
24524
|
+
// verify the required parameter 'userIds' is set
|
|
24525
|
+
if (userIds === undefined || userIds === null) {
|
|
24526
|
+
throw 'Missing the required parameter "userIds" when calling getLearningModulesAssignments';
|
|
24527
|
+
}
|
|
24528
|
+
|
|
24529
|
+
return this.apiClient.callApi(
|
|
24530
|
+
'/api/v2/learning/modules/assignments',
|
|
24531
|
+
'GET',
|
|
24532
|
+
{ },
|
|
24533
|
+
{ 'userIds': this.apiClient.buildCollectionParam(userIds, 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'searchTerm': opts['searchTerm'],'overdue': opts['overdue'],'assignmentStates': this.apiClient.buildCollectionParam(opts['assignmentStates'], 'multi'),'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
24534
|
+
{ },
|
|
24535
|
+
{ },
|
|
24536
|
+
null,
|
|
24537
|
+
['PureCloud OAuth'],
|
|
24538
|
+
['application/json'],
|
|
24539
|
+
['application/json']
|
|
24540
|
+
);
|
|
24541
|
+
}
|
|
24542
|
+
|
|
24355
24543
|
/**
|
|
24356
24544
|
* Update Learning Assignment
|
|
24357
24545
|
*
|
|
@@ -24734,7 +24922,7 @@ class LicenseApi {
|
|
|
24734
24922
|
/**
|
|
24735
24923
|
* License service.
|
|
24736
24924
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
24737
|
-
* @version
|
|
24925
|
+
* @version 141.1.0
|
|
24738
24926
|
*/
|
|
24739
24927
|
|
|
24740
24928
|
/**
|
|
@@ -24972,7 +25160,7 @@ class LocationsApi {
|
|
|
24972
25160
|
/**
|
|
24973
25161
|
* Locations service.
|
|
24974
25162
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
24975
|
-
* @version
|
|
25163
|
+
* @version 141.1.0
|
|
24976
25164
|
*/
|
|
24977
25165
|
|
|
24978
25166
|
/**
|
|
@@ -25208,7 +25396,7 @@ class MessagingApi {
|
|
|
25208
25396
|
/**
|
|
25209
25397
|
* Messaging service.
|
|
25210
25398
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
25211
|
-
* @version
|
|
25399
|
+
* @version 141.1.0
|
|
25212
25400
|
*/
|
|
25213
25401
|
|
|
25214
25402
|
/**
|
|
@@ -25359,7 +25547,7 @@ class MobileDevicesApi {
|
|
|
25359
25547
|
/**
|
|
25360
25548
|
* MobileDevices service.
|
|
25361
25549
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
25362
|
-
* @version
|
|
25550
|
+
* @version 141.1.0
|
|
25363
25551
|
*/
|
|
25364
25552
|
|
|
25365
25553
|
/**
|
|
@@ -25510,7 +25698,7 @@ class NotificationsApi {
|
|
|
25510
25698
|
/**
|
|
25511
25699
|
* Notifications service.
|
|
25512
25700
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
25513
|
-
* @version
|
|
25701
|
+
* @version 141.1.0
|
|
25514
25702
|
*/
|
|
25515
25703
|
|
|
25516
25704
|
/**
|
|
@@ -25735,7 +25923,7 @@ class OAuthApi {
|
|
|
25735
25923
|
/**
|
|
25736
25924
|
* OAuth service.
|
|
25737
25925
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
25738
|
-
* @version
|
|
25926
|
+
* @version 141.1.0
|
|
25739
25927
|
*/
|
|
25740
25928
|
|
|
25741
25929
|
/**
|
|
@@ -26101,7 +26289,7 @@ class ObjectsApi {
|
|
|
26101
26289
|
/**
|
|
26102
26290
|
* Objects service.
|
|
26103
26291
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
26104
|
-
* @version
|
|
26292
|
+
* @version 141.1.0
|
|
26105
26293
|
*/
|
|
26106
26294
|
|
|
26107
26295
|
/**
|
|
@@ -26372,7 +26560,7 @@ class OrganizationApi {
|
|
|
26372
26560
|
/**
|
|
26373
26561
|
* Organization service.
|
|
26374
26562
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
26375
|
-
* @version
|
|
26563
|
+
* @version 141.1.0
|
|
26376
26564
|
*/
|
|
26377
26565
|
|
|
26378
26566
|
/**
|
|
@@ -26775,7 +26963,7 @@ class OrganizationAuthorizationApi {
|
|
|
26775
26963
|
/**
|
|
26776
26964
|
* OrganizationAuthorization service.
|
|
26777
26965
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
26778
|
-
* @version
|
|
26966
|
+
* @version 141.1.0
|
|
26779
26967
|
*/
|
|
26780
26968
|
|
|
26781
26969
|
/**
|
|
@@ -27700,7 +27888,7 @@ class OutboundApi {
|
|
|
27700
27888
|
/**
|
|
27701
27889
|
* Outbound service.
|
|
27702
27890
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
27703
|
-
* @version
|
|
27891
|
+
* @version 141.1.0
|
|
27704
27892
|
*/
|
|
27705
27893
|
|
|
27706
27894
|
/**
|
|
@@ -30955,7 +31143,7 @@ class PresenceApi {
|
|
|
30955
31143
|
/**
|
|
30956
31144
|
* Presence service.
|
|
30957
31145
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
30958
|
-
* @version
|
|
31146
|
+
* @version 141.1.0
|
|
30959
31147
|
*/
|
|
30960
31148
|
|
|
30961
31149
|
/**
|
|
@@ -31277,7 +31465,7 @@ class QualityApi {
|
|
|
31277
31465
|
/**
|
|
31278
31466
|
* Quality service.
|
|
31279
31467
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
31280
|
-
* @version
|
|
31468
|
+
* @version 141.1.0
|
|
31281
31469
|
*/
|
|
31282
31470
|
|
|
31283
31471
|
/**
|
|
@@ -32855,7 +33043,7 @@ class RecordingApi {
|
|
|
32855
33043
|
/**
|
|
32856
33044
|
* Recording service.
|
|
32857
33045
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
32858
|
-
* @version
|
|
33046
|
+
* @version 141.1.0
|
|
32859
33047
|
*/
|
|
32860
33048
|
|
|
32861
33049
|
/**
|
|
@@ -34508,7 +34696,7 @@ class ResponseManagementApi {
|
|
|
34508
34696
|
/**
|
|
34509
34697
|
* ResponseManagement service.
|
|
34510
34698
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
34511
|
-
* @version
|
|
34699
|
+
* @version 141.1.0
|
|
34512
34700
|
*/
|
|
34513
34701
|
|
|
34514
34702
|
/**
|
|
@@ -34992,7 +35180,7 @@ class RoutingApi {
|
|
|
34992
35180
|
/**
|
|
34993
35181
|
* Routing service.
|
|
34994
35182
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
34995
|
-
* @version
|
|
35183
|
+
* @version 141.1.0
|
|
34996
35184
|
*/
|
|
34997
35185
|
|
|
34998
35186
|
/**
|
|
@@ -36102,6 +36290,8 @@ class RoutingApi {
|
|
|
36102
36290
|
* @param {String} opts.name Filter by queue name
|
|
36103
36291
|
* @param {Array.<String>} opts.id Filter by queue ID(s)
|
|
36104
36292
|
* @param {Array.<String>} opts.divisionId Filter by queue division ID(s)
|
|
36293
|
+
* @param {Array.<String>} opts.peerId Filter by queue peer ID(s)
|
|
36294
|
+
* @param {Boolean} opts.hasPeer Filter by queues associated with peer
|
|
36105
36295
|
*/
|
|
36106
36296
|
getRoutingQueues(opts) {
|
|
36107
36297
|
opts = opts || {};
|
|
@@ -36111,7 +36301,7 @@ class RoutingApi {
|
|
|
36111
36301
|
'/api/v2/routing/queues',
|
|
36112
36302
|
'GET',
|
|
36113
36303
|
{ },
|
|
36114
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
|
|
36304
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'peerId': this.apiClient.buildCollectionParam(opts['peerId'], 'multi'),'hasPeer': opts['hasPeer'] },
|
|
36115
36305
|
{ },
|
|
36116
36306
|
{ },
|
|
36117
36307
|
null,
|
|
@@ -37911,7 +38101,7 @@ class SCIMApi {
|
|
|
37911
38101
|
/**
|
|
37912
38102
|
* SCIM service.
|
|
37913
38103
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
37914
|
-
* @version
|
|
38104
|
+
* @version 141.1.0
|
|
37915
38105
|
*/
|
|
37916
38106
|
|
|
37917
38107
|
/**
|
|
@@ -38788,7 +38978,7 @@ class ScriptsApi {
|
|
|
38788
38978
|
/**
|
|
38789
38979
|
* Scripts service.
|
|
38790
38980
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
38791
|
-
* @version
|
|
38981
|
+
* @version 141.1.0
|
|
38792
38982
|
*/
|
|
38793
38983
|
|
|
38794
38984
|
/**
|
|
@@ -39207,7 +39397,7 @@ class SearchApi {
|
|
|
39207
39397
|
/**
|
|
39208
39398
|
* Search service.
|
|
39209
39399
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
39210
|
-
* @version
|
|
39400
|
+
* @version 141.1.0
|
|
39211
39401
|
*/
|
|
39212
39402
|
|
|
39213
39403
|
/**
|
|
@@ -39686,6 +39876,31 @@ class SearchApi {
|
|
|
39686
39876
|
);
|
|
39687
39877
|
}
|
|
39688
39878
|
|
|
39879
|
+
/**
|
|
39880
|
+
* Search resources.
|
|
39881
|
+
*
|
|
39882
|
+
* @param {Object} body Search request options
|
|
39883
|
+
*/
|
|
39884
|
+
postTeamsSearch(body) {
|
|
39885
|
+
// verify the required parameter 'body' is set
|
|
39886
|
+
if (body === undefined || body === null) {
|
|
39887
|
+
throw 'Missing the required parameter "body" when calling postTeamsSearch';
|
|
39888
|
+
}
|
|
39889
|
+
|
|
39890
|
+
return this.apiClient.callApi(
|
|
39891
|
+
'/api/v2/teams/search',
|
|
39892
|
+
'POST',
|
|
39893
|
+
{ },
|
|
39894
|
+
{ },
|
|
39895
|
+
{ },
|
|
39896
|
+
{ },
|
|
39897
|
+
body,
|
|
39898
|
+
['PureCloud OAuth'],
|
|
39899
|
+
['application/json'],
|
|
39900
|
+
['application/json']
|
|
39901
|
+
);
|
|
39902
|
+
}
|
|
39903
|
+
|
|
39689
39904
|
/**
|
|
39690
39905
|
* Search users
|
|
39691
39906
|
*
|
|
@@ -39742,7 +39957,7 @@ class SpeechTextAnalyticsApi {
|
|
|
39742
39957
|
/**
|
|
39743
39958
|
* SpeechTextAnalytics service.
|
|
39744
39959
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
39745
|
-
* @version
|
|
39960
|
+
* @version 141.1.0
|
|
39746
39961
|
*/
|
|
39747
39962
|
|
|
39748
39963
|
/**
|
|
@@ -40595,7 +40810,7 @@ class StationsApi {
|
|
|
40595
40810
|
/**
|
|
40596
40811
|
* Stations service.
|
|
40597
40812
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
40598
|
-
* @version
|
|
40813
|
+
* @version 141.1.0
|
|
40599
40814
|
*/
|
|
40600
40815
|
|
|
40601
40816
|
/**
|
|
@@ -40742,7 +40957,7 @@ class SuggestApi {
|
|
|
40742
40957
|
/**
|
|
40743
40958
|
* Suggest service.
|
|
40744
40959
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
40745
|
-
* @version
|
|
40960
|
+
* @version 141.1.0
|
|
40746
40961
|
*/
|
|
40747
40962
|
|
|
40748
40963
|
/**
|
|
@@ -40877,11 +41092,190 @@ class SuggestApi {
|
|
|
40877
41092
|
|
|
40878
41093
|
}
|
|
40879
41094
|
|
|
41095
|
+
class TeamsApi {
|
|
41096
|
+
/**
|
|
41097
|
+
* Teams service.
|
|
41098
|
+
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
41099
|
+
* @version 141.1.0
|
|
41100
|
+
*/
|
|
41101
|
+
|
|
41102
|
+
/**
|
|
41103
|
+
* Constructs a new TeamsApi.
|
|
41104
|
+
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
41105
|
+
* @class
|
|
41106
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
41107
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
41108
|
+
*/
|
|
41109
|
+
constructor(apiClient) {
|
|
41110
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
41111
|
+
}
|
|
41112
|
+
|
|
41113
|
+
|
|
41114
|
+
/**
|
|
41115
|
+
* Delete team
|
|
41116
|
+
*
|
|
41117
|
+
* @param {String} teamId Team ID
|
|
41118
|
+
*/
|
|
41119
|
+
deleteTeam(teamId) {
|
|
41120
|
+
// verify the required parameter 'teamId' is set
|
|
41121
|
+
if (teamId === undefined || teamId === null) {
|
|
41122
|
+
throw 'Missing the required parameter "teamId" when calling deleteTeam';
|
|
41123
|
+
}
|
|
41124
|
+
|
|
41125
|
+
return this.apiClient.callApi(
|
|
41126
|
+
'/api/v2/teams/{teamId}',
|
|
41127
|
+
'DELETE',
|
|
41128
|
+
{ 'teamId': teamId },
|
|
41129
|
+
{ },
|
|
41130
|
+
{ },
|
|
41131
|
+
{ },
|
|
41132
|
+
null,
|
|
41133
|
+
['PureCloud OAuth'],
|
|
41134
|
+
['application/json'],
|
|
41135
|
+
['application/json']
|
|
41136
|
+
);
|
|
41137
|
+
}
|
|
41138
|
+
|
|
41139
|
+
/**
|
|
41140
|
+
* Get team
|
|
41141
|
+
*
|
|
41142
|
+
* @param {String} teamId Team ID
|
|
41143
|
+
*/
|
|
41144
|
+
getTeam(teamId) {
|
|
41145
|
+
// verify the required parameter 'teamId' is set
|
|
41146
|
+
if (teamId === undefined || teamId === null) {
|
|
41147
|
+
throw 'Missing the required parameter "teamId" when calling getTeam';
|
|
41148
|
+
}
|
|
41149
|
+
|
|
41150
|
+
return this.apiClient.callApi(
|
|
41151
|
+
'/api/v2/teams/{teamId}',
|
|
41152
|
+
'GET',
|
|
41153
|
+
{ 'teamId': teamId },
|
|
41154
|
+
{ },
|
|
41155
|
+
{ },
|
|
41156
|
+
{ },
|
|
41157
|
+
null,
|
|
41158
|
+
['PureCloud OAuth'],
|
|
41159
|
+
['application/json'],
|
|
41160
|
+
['application/json']
|
|
41161
|
+
);
|
|
41162
|
+
}
|
|
41163
|
+
|
|
41164
|
+
/**
|
|
41165
|
+
* Get Team listing
|
|
41166
|
+
*
|
|
41167
|
+
* @param {Object} opts Optional parameters
|
|
41168
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
41169
|
+
* @param {String} opts.name Return only teams whose names start with this value (case-insensitive matching)
|
|
41170
|
+
* @param {String} opts.after The cursor that points to the next item in the complete list of teams
|
|
41171
|
+
* @param {String} opts.before The cursor that points to the previous item in the complete list of teams
|
|
41172
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
41173
|
+
*/
|
|
41174
|
+
getTeams(opts) {
|
|
41175
|
+
opts = opts || {};
|
|
41176
|
+
|
|
41177
|
+
|
|
41178
|
+
return this.apiClient.callApi(
|
|
41179
|
+
'/api/v2/teams',
|
|
41180
|
+
'GET',
|
|
41181
|
+
{ },
|
|
41182
|
+
{ 'pageSize': opts['pageSize'],'name': opts['name'],'after': opts['after'],'before': opts['before'],'expand': opts['expand'] },
|
|
41183
|
+
{ },
|
|
41184
|
+
{ },
|
|
41185
|
+
null,
|
|
41186
|
+
['PureCloud OAuth'],
|
|
41187
|
+
['application/json'],
|
|
41188
|
+
['application/json']
|
|
41189
|
+
);
|
|
41190
|
+
}
|
|
41191
|
+
|
|
41192
|
+
/**
|
|
41193
|
+
* Update team
|
|
41194
|
+
*
|
|
41195
|
+
* @param {String} teamId Team ID
|
|
41196
|
+
* @param {Object} body Team
|
|
41197
|
+
*/
|
|
41198
|
+
patchTeam(teamId, body) {
|
|
41199
|
+
// verify the required parameter 'teamId' is set
|
|
41200
|
+
if (teamId === undefined || teamId === null) {
|
|
41201
|
+
throw 'Missing the required parameter "teamId" when calling patchTeam';
|
|
41202
|
+
}
|
|
41203
|
+
// verify the required parameter 'body' is set
|
|
41204
|
+
if (body === undefined || body === null) {
|
|
41205
|
+
throw 'Missing the required parameter "body" when calling patchTeam';
|
|
41206
|
+
}
|
|
41207
|
+
|
|
41208
|
+
return this.apiClient.callApi(
|
|
41209
|
+
'/api/v2/teams/{teamId}',
|
|
41210
|
+
'PATCH',
|
|
41211
|
+
{ 'teamId': teamId },
|
|
41212
|
+
{ },
|
|
41213
|
+
{ },
|
|
41214
|
+
{ },
|
|
41215
|
+
body,
|
|
41216
|
+
['PureCloud OAuth'],
|
|
41217
|
+
['application/json'],
|
|
41218
|
+
['application/json']
|
|
41219
|
+
);
|
|
41220
|
+
}
|
|
41221
|
+
|
|
41222
|
+
/**
|
|
41223
|
+
* Create a team
|
|
41224
|
+
*
|
|
41225
|
+
* @param {Object} body Team
|
|
41226
|
+
*/
|
|
41227
|
+
postTeams(body) {
|
|
41228
|
+
// verify the required parameter 'body' is set
|
|
41229
|
+
if (body === undefined || body === null) {
|
|
41230
|
+
throw 'Missing the required parameter "body" when calling postTeams';
|
|
41231
|
+
}
|
|
41232
|
+
|
|
41233
|
+
return this.apiClient.callApi(
|
|
41234
|
+
'/api/v2/teams',
|
|
41235
|
+
'POST',
|
|
41236
|
+
{ },
|
|
41237
|
+
{ },
|
|
41238
|
+
{ },
|
|
41239
|
+
{ },
|
|
41240
|
+
body,
|
|
41241
|
+
['PureCloud OAuth'],
|
|
41242
|
+
['application/json'],
|
|
41243
|
+
['application/json']
|
|
41244
|
+
);
|
|
41245
|
+
}
|
|
41246
|
+
|
|
41247
|
+
/**
|
|
41248
|
+
* Search resources.
|
|
41249
|
+
*
|
|
41250
|
+
* @param {Object} body Search request options
|
|
41251
|
+
*/
|
|
41252
|
+
postTeamsSearch(body) {
|
|
41253
|
+
// verify the required parameter 'body' is set
|
|
41254
|
+
if (body === undefined || body === null) {
|
|
41255
|
+
throw 'Missing the required parameter "body" when calling postTeamsSearch';
|
|
41256
|
+
}
|
|
41257
|
+
|
|
41258
|
+
return this.apiClient.callApi(
|
|
41259
|
+
'/api/v2/teams/search',
|
|
41260
|
+
'POST',
|
|
41261
|
+
{ },
|
|
41262
|
+
{ },
|
|
41263
|
+
{ },
|
|
41264
|
+
{ },
|
|
41265
|
+
body,
|
|
41266
|
+
['PureCloud OAuth'],
|
|
41267
|
+
['application/json'],
|
|
41268
|
+
['application/json']
|
|
41269
|
+
);
|
|
41270
|
+
}
|
|
41271
|
+
|
|
41272
|
+
}
|
|
41273
|
+
|
|
40880
41274
|
class TelephonyApi {
|
|
40881
41275
|
/**
|
|
40882
41276
|
* Telephony service.
|
|
40883
41277
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
40884
|
-
* @version
|
|
41278
|
+
* @version 141.1.0
|
|
40885
41279
|
*/
|
|
40886
41280
|
|
|
40887
41281
|
/**
|
|
@@ -40989,7 +41383,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
40989
41383
|
/**
|
|
40990
41384
|
* TelephonyProvidersEdge service.
|
|
40991
41385
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
40992
|
-
* @version
|
|
41386
|
+
* @version 141.1.0
|
|
40993
41387
|
*/
|
|
40994
41388
|
|
|
40995
41389
|
/**
|
|
@@ -44622,7 +45016,7 @@ class TextbotsApi {
|
|
|
44622
45016
|
/**
|
|
44623
45017
|
* Textbots service.
|
|
44624
45018
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
44625
|
-
* @version
|
|
45019
|
+
* @version 141.1.0
|
|
44626
45020
|
*/
|
|
44627
45021
|
|
|
44628
45022
|
/**
|
|
@@ -44750,7 +45144,7 @@ class TokensApi {
|
|
|
44750
45144
|
/**
|
|
44751
45145
|
* Tokens service.
|
|
44752
45146
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
44753
|
-
* @version
|
|
45147
|
+
* @version 141.1.0
|
|
44754
45148
|
*/
|
|
44755
45149
|
|
|
44756
45150
|
/**
|
|
@@ -44856,7 +45250,7 @@ class UploadsApi {
|
|
|
44856
45250
|
/**
|
|
44857
45251
|
* Uploads service.
|
|
44858
45252
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
44859
|
-
* @version
|
|
45253
|
+
* @version 141.1.0
|
|
44860
45254
|
*/
|
|
44861
45255
|
|
|
44862
45256
|
/**
|
|
@@ -45007,7 +45401,7 @@ class UsageApi {
|
|
|
45007
45401
|
/**
|
|
45008
45402
|
* Usage service.
|
|
45009
45403
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
45010
|
-
* @version
|
|
45404
|
+
* @version 141.1.0
|
|
45011
45405
|
*/
|
|
45012
45406
|
|
|
45013
45407
|
/**
|
|
@@ -45078,7 +45472,7 @@ class UserRecordingsApi {
|
|
|
45078
45472
|
/**
|
|
45079
45473
|
* UserRecordings service.
|
|
45080
45474
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
45081
|
-
* @version
|
|
45475
|
+
* @version 141.1.0
|
|
45082
45476
|
*/
|
|
45083
45477
|
|
|
45084
45478
|
/**
|
|
@@ -45262,7 +45656,7 @@ class UsersApi {
|
|
|
45262
45656
|
/**
|
|
45263
45657
|
* Users service.
|
|
45264
45658
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
45265
|
-
* @version
|
|
45659
|
+
* @version 141.1.0
|
|
45266
45660
|
*/
|
|
45267
45661
|
|
|
45268
45662
|
/**
|
|
@@ -47564,7 +47958,7 @@ class UtilitiesApi {
|
|
|
47564
47958
|
/**
|
|
47565
47959
|
* Utilities service.
|
|
47566
47960
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
47567
|
-
* @version
|
|
47961
|
+
* @version 141.1.0
|
|
47568
47962
|
*/
|
|
47569
47963
|
|
|
47570
47964
|
/**
|
|
@@ -47675,7 +48069,7 @@ class VoicemailApi {
|
|
|
47675
48069
|
/**
|
|
47676
48070
|
* Voicemail service.
|
|
47677
48071
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
47678
|
-
* @version
|
|
48072
|
+
* @version 141.1.0
|
|
47679
48073
|
*/
|
|
47680
48074
|
|
|
47681
48075
|
/**
|
|
@@ -48342,7 +48736,7 @@ class WebChatApi {
|
|
|
48342
48736
|
/**
|
|
48343
48737
|
* WebChat service.
|
|
48344
48738
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
48345
|
-
* @version
|
|
48739
|
+
* @version 141.1.0
|
|
48346
48740
|
*/
|
|
48347
48741
|
|
|
48348
48742
|
/**
|
|
@@ -48886,7 +49280,7 @@ class WebDeploymentsApi {
|
|
|
48886
49280
|
/**
|
|
48887
49281
|
* WebDeployments service.
|
|
48888
49282
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
48889
|
-
* @version
|
|
49283
|
+
* @version 141.1.0
|
|
48890
49284
|
*/
|
|
48891
49285
|
|
|
48892
49286
|
/**
|
|
@@ -49241,7 +49635,7 @@ class WebMessagingApi {
|
|
|
49241
49635
|
/**
|
|
49242
49636
|
* WebMessaging service.
|
|
49243
49637
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
49244
|
-
* @version
|
|
49638
|
+
* @version 141.1.0
|
|
49245
49639
|
*/
|
|
49246
49640
|
|
|
49247
49641
|
/**
|
|
@@ -49287,7 +49681,7 @@ class WidgetsApi {
|
|
|
49287
49681
|
/**
|
|
49288
49682
|
* Widgets service.
|
|
49289
49683
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
49290
|
-
* @version
|
|
49684
|
+
* @version 141.1.0
|
|
49291
49685
|
*/
|
|
49292
49686
|
|
|
49293
49687
|
/**
|
|
@@ -49433,7 +49827,7 @@ class WorkforceManagementApi {
|
|
|
49433
49827
|
/**
|
|
49434
49828
|
* WorkforceManagement service.
|
|
49435
49829
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
49436
|
-
* @version
|
|
49830
|
+
* @version 141.1.0
|
|
49437
49831
|
*/
|
|
49438
49832
|
|
|
49439
49833
|
/**
|
|
@@ -49853,6 +50247,31 @@ class WorkforceManagementApi {
|
|
|
49853
50247
|
);
|
|
49854
50248
|
}
|
|
49855
50249
|
|
|
50250
|
+
/**
|
|
50251
|
+
* Query the status of a historical adherence request operation. Only the user who started the operation can query the status
|
|
50252
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
50253
|
+
* @param {String} jobId jobId
|
|
50254
|
+
*/
|
|
50255
|
+
getWorkforcemanagementAdherenceHistoricalJob(jobId) {
|
|
50256
|
+
// verify the required parameter 'jobId' is set
|
|
50257
|
+
if (jobId === undefined || jobId === null) {
|
|
50258
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAdherenceHistoricalJob';
|
|
50259
|
+
}
|
|
50260
|
+
|
|
50261
|
+
return this.apiClient.callApi(
|
|
50262
|
+
'/api/v2/workforcemanagement/adherence/historical/jobs/{jobId}',
|
|
50263
|
+
'GET',
|
|
50264
|
+
{ 'jobId': jobId },
|
|
50265
|
+
{ },
|
|
50266
|
+
{ },
|
|
50267
|
+
{ },
|
|
50268
|
+
null,
|
|
50269
|
+
['PureCloud OAuth'],
|
|
50270
|
+
['application/json'],
|
|
50271
|
+
['application/json']
|
|
50272
|
+
);
|
|
50273
|
+
}
|
|
50274
|
+
|
|
49856
50275
|
/**
|
|
49857
50276
|
* Get status of the modeling job
|
|
49858
50277
|
*
|
|
@@ -53684,7 +54103,7 @@ class WorkforceManagementApi {
|
|
|
53684
54103
|
* </pre>
|
|
53685
54104
|
* </p>
|
|
53686
54105
|
* @module purecloud-platform-client-v2/index
|
|
53687
|
-
* @version
|
|
54106
|
+
* @version 141.1.0
|
|
53688
54107
|
*/
|
|
53689
54108
|
class platformClient {
|
|
53690
54109
|
constructor() {
|
|
@@ -53933,6 +54352,11 @@ class platformClient {
|
|
|
53933
54352
|
* @property {module:purecloud-platform-client-v2/api/SuggestApi}
|
|
53934
54353
|
*/
|
|
53935
54354
|
this.SuggestApi = SuggestApi;
|
|
54355
|
+
/**
|
|
54356
|
+
* The TeamsApi service constructor.
|
|
54357
|
+
* @property {module:purecloud-platform-client-v2/api/TeamsApi}
|
|
54358
|
+
*/
|
|
54359
|
+
this.TeamsApi = TeamsApi;
|
|
53936
54360
|
/**
|
|
53937
54361
|
* The TelephonyApi service constructor.
|
|
53938
54362
|
* @property {module:purecloud-platform-client-v2/api/TelephonyApi}
|