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
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -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',
|
|
@@ -2276,7 +2278,7 @@ class Configuration {
|
|
|
2276
2278
|
|
|
2277
2279
|
/**
|
|
2278
2280
|
* @module purecloud-platform-client-v2/ApiClient
|
|
2279
|
-
* @version
|
|
2281
|
+
* @version 141.1.0
|
|
2280
2282
|
*/
|
|
2281
2283
|
class ApiClient {
|
|
2282
2284
|
/**
|
|
@@ -2311,7 +2313,7 @@ class ApiClient {
|
|
|
2311
2313
|
|
|
2312
2314
|
/**
|
|
2313
2315
|
* Enumeration of collection format separator strategies.
|
|
2314
|
-
* @enum {String}
|
|
2316
|
+
* @enum {String}
|
|
2315
2317
|
* @readonly
|
|
2316
2318
|
*/
|
|
2317
2319
|
this.CollectionFormatEnum = {
|
|
@@ -2458,7 +2460,7 @@ class ApiClient {
|
|
|
2458
2460
|
// Load current auth data
|
|
2459
2461
|
const tempState = this.authData.state;
|
|
2460
2462
|
this.authData = localStorage.getItem(`${this.settingsPrefix}_auth_data`);
|
|
2461
|
-
if (!this.authData)
|
|
2463
|
+
if (!this.authData)
|
|
2462
2464
|
this.authData = {};
|
|
2463
2465
|
else
|
|
2464
2466
|
this.authData = JSON.parse(this.authData);
|
|
@@ -2478,7 +2480,7 @@ class ApiClient {
|
|
|
2478
2480
|
* @description Initiates the implicit grant login flow. Will attempt to load the token from local storage, if enabled.
|
|
2479
2481
|
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
2480
2482
|
* @param {string} redirectUri - The redirect URI of the OAuth Implicit Grant client
|
|
2481
|
-
* @param {object} opts - (optional) Additional options
|
|
2483
|
+
* @param {object} opts - (optional) Additional options
|
|
2482
2484
|
* @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.
|
|
2483
2485
|
* @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.
|
|
2484
2486
|
* @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.
|
|
@@ -2624,9 +2626,9 @@ class ApiClient {
|
|
|
2624
2626
|
}
|
|
2625
2627
|
var encodedData = Buffer.from(clientId + ':' + clientSecret).toString('base64');
|
|
2626
2628
|
var request = this._formAuthRequest(encodedData,
|
|
2627
|
-
{ grant_type: 'urn:ietf:params:oauth:grant-type:saml2-bearer'
|
|
2628
|
-
|
|
2629
|
-
|
|
2629
|
+
{ grant_type: 'urn:ietf:params:oauth:grant-type:saml2-bearer',
|
|
2630
|
+
orgName: orgName,
|
|
2631
|
+
assertion: assertion });
|
|
2630
2632
|
request.proxy = this.proxy;
|
|
2631
2633
|
var bodyParam = {
|
|
2632
2634
|
grant_type: 'urn:ietf:params:oauth:grant-type:saml2-bearer',
|
|
@@ -2705,9 +2707,9 @@ class ApiClient {
|
|
|
2705
2707
|
}
|
|
2706
2708
|
var encodedData = Buffer.from(clientId + ':' + clientSecret).toString('base64');
|
|
2707
2709
|
var request = this._formAuthRequest(encodedData,
|
|
2708
|
-
{ grant_type: 'authorization_code'
|
|
2709
|
-
|
|
2710
|
-
|
|
2710
|
+
{ grant_type: 'authorization_code',
|
|
2711
|
+
code: authCode,
|
|
2712
|
+
redirect_uri: redirectUri });
|
|
2711
2713
|
request.proxy = this.proxy;
|
|
2712
2714
|
var bodyParam = {
|
|
2713
2715
|
grant_type: 'authorization_code',
|
|
@@ -2733,7 +2735,7 @@ class ApiClient {
|
|
|
2733
2735
|
return;
|
|
2734
2736
|
}
|
|
2735
2737
|
var encodedData = Buffer.from(clientId + ':' + clientSecret).toString('base64');
|
|
2736
|
-
var request = this._formAuthRequest(encodedData, { grant_type: 'refresh_token'
|
|
2738
|
+
var request = this._formAuthRequest(encodedData, { grant_type: 'refresh_token' , refresh_token: refreshToken });
|
|
2737
2739
|
request.proxy = this.proxy;
|
|
2738
2740
|
var bodyParam = {
|
|
2739
2741
|
grant_type: 'refresh_token',
|
|
@@ -2810,8 +2812,9 @@ class ApiClient {
|
|
|
2810
2812
|
/**
|
|
2811
2813
|
* @description Utility function to create the request for auth requests
|
|
2812
2814
|
* @param {string} encodedData - Base64 encoded client and clientSecret pair
|
|
2815
|
+
* @param {object} data - data to url form encode
|
|
2813
2816
|
*/
|
|
2814
|
-
_formAuthRequest(encodedData) {
|
|
2817
|
+
_formAuthRequest(encodedData, data) {
|
|
2815
2818
|
var request = axios__default["default"]({
|
|
2816
2819
|
method: `POST`,
|
|
2817
2820
|
url: `https://login.${this.config.environment}/oauth/token`,
|
|
@@ -2819,7 +2822,7 @@ class ApiClient {
|
|
|
2819
2822
|
'Authorization': 'Basic ' + encodedData,
|
|
2820
2823
|
'Content-Type': 'application/x-www-form-urlencoded'
|
|
2821
2824
|
},
|
|
2822
|
-
data:
|
|
2825
|
+
data: qs__default["default"].stringify(data)
|
|
2823
2826
|
});
|
|
2824
2827
|
|
|
2825
2828
|
return request;
|
|
@@ -2883,7 +2886,7 @@ class ApiClient {
|
|
|
2883
2886
|
}
|
|
2884
2887
|
|
|
2885
2888
|
// Test token
|
|
2886
|
-
this.callApi('/api/v2/tokens/me', 'GET',
|
|
2889
|
+
this.callApi('/api/v2/tokens/me', 'GET',
|
|
2887
2890
|
null, null, null, null, null, ['PureCloud OAuth'], ['application/json'], ['application/json'])
|
|
2888
2891
|
.then(() => {
|
|
2889
2892
|
resolve();
|
|
@@ -2909,7 +2912,7 @@ class ApiClient {
|
|
|
2909
2912
|
const match = hashRegex.exec(h);
|
|
2910
2913
|
if (match) hash[match[1]] = decodeURIComponent(decodeURIComponent(match[2].replace(/\+/g, '%20')));
|
|
2911
2914
|
});
|
|
2912
|
-
|
|
2915
|
+
|
|
2913
2916
|
// Check for error
|
|
2914
2917
|
if (hash.error) {
|
|
2915
2918
|
return hash;
|
|
@@ -3107,7 +3110,7 @@ class ApiClient {
|
|
|
3107
3110
|
/**
|
|
3108
3111
|
* Checks whether the given parameter value represents file-like content.
|
|
3109
3112
|
* @param param The parameter to check.
|
|
3110
|
-
* @returns {Boolean} <code>true</code> if <code>param</code> represents a file.
|
|
3113
|
+
* @returns {Boolean} <code>true</code> if <code>param</code> represents a file.
|
|
3111
3114
|
*/
|
|
3112
3115
|
isFileParam(param) {
|
|
3113
3116
|
// Buffer in Node.js
|
|
@@ -3347,7 +3350,7 @@ class AlertingApi {
|
|
|
3347
3350
|
/**
|
|
3348
3351
|
* Alerting service.
|
|
3349
3352
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3350
|
-
* @version
|
|
3353
|
+
* @version 141.1.0
|
|
3351
3354
|
*/
|
|
3352
3355
|
|
|
3353
3356
|
/**
|
|
@@ -3661,7 +3664,7 @@ class AnalyticsApi {
|
|
|
3661
3664
|
/**
|
|
3662
3665
|
* Analytics service.
|
|
3663
3666
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3664
|
-
* @version
|
|
3667
|
+
* @version 141.1.0
|
|
3665
3668
|
*/
|
|
3666
3669
|
|
|
3667
3670
|
/**
|
|
@@ -4843,7 +4846,7 @@ class ArchitectApi {
|
|
|
4843
4846
|
/**
|
|
4844
4847
|
* Architect service.
|
|
4845
4848
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4846
|
-
* @version
|
|
4849
|
+
* @version 141.1.0
|
|
4847
4850
|
*/
|
|
4848
4851
|
|
|
4849
4852
|
/**
|
|
@@ -7888,7 +7891,7 @@ class AuditApi {
|
|
|
7888
7891
|
/**
|
|
7889
7892
|
* Audit service.
|
|
7890
7893
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
7891
|
-
* @version
|
|
7894
|
+
* @version 141.1.0
|
|
7892
7895
|
*/
|
|
7893
7896
|
|
|
7894
7897
|
/**
|
|
@@ -8059,7 +8062,7 @@ class AuthorizationApi {
|
|
|
8059
8062
|
/**
|
|
8060
8063
|
* Authorization service.
|
|
8061
8064
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8062
|
-
* @version
|
|
8065
|
+
* @version 141.1.0
|
|
8063
8066
|
*/
|
|
8064
8067
|
|
|
8065
8068
|
/**
|
|
@@ -9242,7 +9245,7 @@ class BillingApi {
|
|
|
9242
9245
|
/**
|
|
9243
9246
|
* Billing service.
|
|
9244
9247
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9245
|
-
* @version
|
|
9248
|
+
* @version 141.1.0
|
|
9246
9249
|
*/
|
|
9247
9250
|
|
|
9248
9251
|
/**
|
|
@@ -9322,7 +9325,7 @@ class ChatApi {
|
|
|
9322
9325
|
/**
|
|
9323
9326
|
* Chat service.
|
|
9324
9327
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
9325
|
-
* @version
|
|
9328
|
+
* @version 141.1.0
|
|
9326
9329
|
*/
|
|
9327
9330
|
|
|
9328
9331
|
/**
|
|
@@ -9413,7 +9416,7 @@ class CoachingApi {
|
|
|
9413
9416
|
/**
|
|
9414
9417
|
* Coaching service.
|
|
9415
9418
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9416
|
-
* @version
|
|
9419
|
+
* @version 141.1.0
|
|
9417
9420
|
*/
|
|
9418
9421
|
|
|
9419
9422
|
/**
|
|
@@ -9990,7 +9993,7 @@ class ContentManagementApi {
|
|
|
9990
9993
|
/**
|
|
9991
9994
|
* ContentManagement service.
|
|
9992
9995
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
9993
|
-
* @version
|
|
9996
|
+
* @version 141.1.0
|
|
9994
9997
|
*/
|
|
9995
9998
|
|
|
9996
9999
|
/**
|
|
@@ -11130,7 +11133,7 @@ class ConversationsApi {
|
|
|
11130
11133
|
/**
|
|
11131
11134
|
* Conversations service.
|
|
11132
11135
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
11133
|
-
* @version
|
|
11136
|
+
* @version 141.1.0
|
|
11134
11137
|
*/
|
|
11135
11138
|
|
|
11136
11139
|
/**
|
|
@@ -16064,7 +16067,7 @@ class DataExtensionsApi {
|
|
|
16064
16067
|
/**
|
|
16065
16068
|
* DataExtensions service.
|
|
16066
16069
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
16067
|
-
* @version
|
|
16070
|
+
* @version 141.1.0
|
|
16068
16071
|
*/
|
|
16069
16072
|
|
|
16070
16073
|
/**
|
|
@@ -16150,7 +16153,7 @@ class ExternalContactsApi {
|
|
|
16150
16153
|
/**
|
|
16151
16154
|
* ExternalContacts service.
|
|
16152
16155
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
16153
|
-
* @version
|
|
16156
|
+
* @version 141.1.0
|
|
16154
16157
|
*/
|
|
16155
16158
|
|
|
16156
16159
|
/**
|
|
@@ -17893,7 +17896,7 @@ class FaxApi {
|
|
|
17893
17896
|
/**
|
|
17894
17897
|
* Fax service.
|
|
17895
17898
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
17896
|
-
* @version
|
|
17899
|
+
* @version 141.1.0
|
|
17897
17900
|
*/
|
|
17898
17901
|
|
|
17899
17902
|
/**
|
|
@@ -18064,7 +18067,7 @@ class FlowsApi {
|
|
|
18064
18067
|
/**
|
|
18065
18068
|
* Flows service.
|
|
18066
18069
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
18067
|
-
* @version
|
|
18070
|
+
* @version 141.1.0
|
|
18068
18071
|
*/
|
|
18069
18072
|
|
|
18070
18073
|
/**
|
|
@@ -18135,7 +18138,7 @@ class GamificationApi {
|
|
|
18135
18138
|
/**
|
|
18136
18139
|
* Gamification service.
|
|
18137
18140
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
18138
|
-
* @version
|
|
18141
|
+
* @version 141.1.0
|
|
18139
18142
|
*/
|
|
18140
18143
|
|
|
18141
18144
|
/**
|
|
@@ -18758,6 +18761,157 @@ class GamificationApi {
|
|
|
18758
18761
|
);
|
|
18759
18762
|
}
|
|
18760
18763
|
|
|
18764
|
+
/**
|
|
18765
|
+
* Average performance values trends by metric of a user
|
|
18766
|
+
*
|
|
18767
|
+
* @param {String} profileId performanceProfileId
|
|
18768
|
+
* @param {String} metricId metricId
|
|
18769
|
+
* @param {String} userId
|
|
18770
|
+
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18771
|
+
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18772
|
+
* @param {Object} opts Optional parameters
|
|
18773
|
+
* @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
|
|
18774
|
+
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
18775
|
+
*/
|
|
18776
|
+
getGamificationScorecardsProfileMetricUserValuesTrends(profileId, metricId, userId, startWorkday, endWorkday, opts) {
|
|
18777
|
+
opts = opts || {};
|
|
18778
|
+
|
|
18779
|
+
// verify the required parameter 'profileId' is set
|
|
18780
|
+
if (profileId === undefined || profileId === null) {
|
|
18781
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
18782
|
+
}
|
|
18783
|
+
// verify the required parameter 'metricId' is set
|
|
18784
|
+
if (metricId === undefined || metricId === null) {
|
|
18785
|
+
throw 'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
18786
|
+
}
|
|
18787
|
+
// verify the required parameter 'userId' is set
|
|
18788
|
+
if (userId === undefined || userId === null) {
|
|
18789
|
+
throw 'Missing the required parameter "userId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
18790
|
+
}
|
|
18791
|
+
// verify the required parameter 'startWorkday' is set
|
|
18792
|
+
if (startWorkday === undefined || startWorkday === null) {
|
|
18793
|
+
throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
18794
|
+
}
|
|
18795
|
+
// verify the required parameter 'endWorkday' is set
|
|
18796
|
+
if (endWorkday === undefined || endWorkday === null) {
|
|
18797
|
+
throw 'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
18798
|
+
}
|
|
18799
|
+
|
|
18800
|
+
return this.apiClient.callApi(
|
|
18801
|
+
'/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/{userId}/values/trends',
|
|
18802
|
+
'GET',
|
|
18803
|
+
{ 'profileId': profileId,'metricId': metricId,'userId': userId },
|
|
18804
|
+
{ 'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
18805
|
+
{ },
|
|
18806
|
+
{ },
|
|
18807
|
+
null,
|
|
18808
|
+
['PureCloud OAuth'],
|
|
18809
|
+
['application/json'],
|
|
18810
|
+
['application/json']
|
|
18811
|
+
);
|
|
18812
|
+
}
|
|
18813
|
+
|
|
18814
|
+
/**
|
|
18815
|
+
* Average performance values trends by metric of a division or a performance profile
|
|
18816
|
+
*
|
|
18817
|
+
* @param {String} profileId performanceProfileId
|
|
18818
|
+
* @param {String} metricId metricId
|
|
18819
|
+
* @param {Object} filterType Filter type for the query request.
|
|
18820
|
+
* @param {String} filterId ID for the filter type. For example, division Id
|
|
18821
|
+
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18822
|
+
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18823
|
+
* @param {Object} opts Optional parameters
|
|
18824
|
+
* @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
|
|
18825
|
+
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
18826
|
+
*/
|
|
18827
|
+
getGamificationScorecardsProfileMetricUsersValuesTrends(profileId, metricId, filterType, filterId, startWorkday, endWorkday, opts) {
|
|
18828
|
+
opts = opts || {};
|
|
18829
|
+
|
|
18830
|
+
// verify the required parameter 'profileId' is set
|
|
18831
|
+
if (profileId === undefined || profileId === null) {
|
|
18832
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
18833
|
+
}
|
|
18834
|
+
// verify the required parameter 'metricId' is set
|
|
18835
|
+
if (metricId === undefined || metricId === null) {
|
|
18836
|
+
throw 'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
18837
|
+
}
|
|
18838
|
+
// verify the required parameter 'filterType' is set
|
|
18839
|
+
if (filterType === undefined || filterType === null) {
|
|
18840
|
+
throw 'Missing the required parameter "filterType" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
18841
|
+
}
|
|
18842
|
+
// verify the required parameter 'filterId' is set
|
|
18843
|
+
if (filterId === undefined || filterId === null) {
|
|
18844
|
+
throw 'Missing the required parameter "filterId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
18845
|
+
}
|
|
18846
|
+
// verify the required parameter 'startWorkday' is set
|
|
18847
|
+
if (startWorkday === undefined || startWorkday === null) {
|
|
18848
|
+
throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
18849
|
+
}
|
|
18850
|
+
// verify the required parameter 'endWorkday' is set
|
|
18851
|
+
if (endWorkday === undefined || endWorkday === null) {
|
|
18852
|
+
throw 'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
18853
|
+
}
|
|
18854
|
+
|
|
18855
|
+
return this.apiClient.callApi(
|
|
18856
|
+
'/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/values/trends',
|
|
18857
|
+
'GET',
|
|
18858
|
+
{ 'profileId': profileId,'metricId': metricId },
|
|
18859
|
+
{ 'filterType': filterType,'filterId': filterId,'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
18860
|
+
{ },
|
|
18861
|
+
{ },
|
|
18862
|
+
null,
|
|
18863
|
+
['PureCloud OAuth'],
|
|
18864
|
+
['application/json'],
|
|
18865
|
+
['application/json']
|
|
18866
|
+
);
|
|
18867
|
+
}
|
|
18868
|
+
|
|
18869
|
+
/**
|
|
18870
|
+
* Average performance values trends by metric of the requesting user
|
|
18871
|
+
*
|
|
18872
|
+
* @param {String} profileId performanceProfileId
|
|
18873
|
+
* @param {String} metricId metricId
|
|
18874
|
+
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18875
|
+
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18876
|
+
* @param {Object} opts Optional parameters
|
|
18877
|
+
* @param {Object} opts.filterType Filter type for the query request. If not set, returns the values trends of the requesting user
|
|
18878
|
+
* @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
|
|
18879
|
+
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
18880
|
+
*/
|
|
18881
|
+
getGamificationScorecardsProfileMetricValuesTrends(profileId, metricId, startWorkday, endWorkday, opts) {
|
|
18882
|
+
opts = opts || {};
|
|
18883
|
+
|
|
18884
|
+
// verify the required parameter 'profileId' is set
|
|
18885
|
+
if (profileId === undefined || profileId === null) {
|
|
18886
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
18887
|
+
}
|
|
18888
|
+
// verify the required parameter 'metricId' is set
|
|
18889
|
+
if (metricId === undefined || metricId === null) {
|
|
18890
|
+
throw 'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
18891
|
+
}
|
|
18892
|
+
// verify the required parameter 'startWorkday' is set
|
|
18893
|
+
if (startWorkday === undefined || startWorkday === null) {
|
|
18894
|
+
throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
18895
|
+
}
|
|
18896
|
+
// verify the required parameter 'endWorkday' is set
|
|
18897
|
+
if (endWorkday === undefined || endWorkday === null) {
|
|
18898
|
+
throw 'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
18899
|
+
}
|
|
18900
|
+
|
|
18901
|
+
return this.apiClient.callApi(
|
|
18902
|
+
'/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/values/trends',
|
|
18903
|
+
'GET',
|
|
18904
|
+
{ 'profileId': profileId,'metricId': metricId },
|
|
18905
|
+
{ 'filterType': opts['filterType'],'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
18906
|
+
{ },
|
|
18907
|
+
{ },
|
|
18908
|
+
null,
|
|
18909
|
+
['PureCloud OAuth'],
|
|
18910
|
+
['application/json'],
|
|
18911
|
+
['application/json']
|
|
18912
|
+
);
|
|
18913
|
+
}
|
|
18914
|
+
|
|
18761
18915
|
/**
|
|
18762
18916
|
* Workday performance metrics for a user
|
|
18763
18917
|
*
|
|
@@ -19566,7 +19720,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
19566
19720
|
/**
|
|
19567
19721
|
* GeneralDataProtectionRegulation service.
|
|
19568
19722
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
19569
|
-
* @version
|
|
19723
|
+
* @version 141.1.0
|
|
19570
19724
|
*/
|
|
19571
19725
|
|
|
19572
19726
|
/**
|
|
@@ -19696,7 +19850,7 @@ class GeolocationApi {
|
|
|
19696
19850
|
/**
|
|
19697
19851
|
* Geolocation service.
|
|
19698
19852
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
19699
|
-
* @version
|
|
19853
|
+
* @version 141.1.0
|
|
19700
19854
|
*/
|
|
19701
19855
|
|
|
19702
19856
|
/**
|
|
@@ -19827,7 +19981,7 @@ class GreetingsApi {
|
|
|
19827
19981
|
/**
|
|
19828
19982
|
* Greetings service.
|
|
19829
19983
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
19830
|
-
* @version
|
|
19984
|
+
* @version 141.1.0
|
|
19831
19985
|
*/
|
|
19832
19986
|
|
|
19833
19987
|
/**
|
|
@@ -20282,7 +20436,7 @@ class GroupsApi {
|
|
|
20282
20436
|
/**
|
|
20283
20437
|
* Groups service.
|
|
20284
20438
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
20285
|
-
* @version
|
|
20439
|
+
* @version 141.1.0
|
|
20286
20440
|
*/
|
|
20287
20441
|
|
|
20288
20442
|
/**
|
|
@@ -20687,7 +20841,7 @@ class IdentityProviderApi {
|
|
|
20687
20841
|
/**
|
|
20688
20842
|
* IdentityProvider service.
|
|
20689
20843
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
20690
|
-
* @version
|
|
20844
|
+
* @version 141.1.0
|
|
20691
20845
|
*/
|
|
20692
20846
|
|
|
20693
20847
|
/**
|
|
@@ -21443,7 +21597,7 @@ class IntegrationsApi {
|
|
|
21443
21597
|
/**
|
|
21444
21598
|
* Integrations service.
|
|
21445
21599
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
21446
|
-
* @version
|
|
21600
|
+
* @version 141.1.0
|
|
21447
21601
|
*/
|
|
21448
21602
|
|
|
21449
21603
|
/**
|
|
@@ -23120,7 +23274,7 @@ class JourneyApi {
|
|
|
23120
23274
|
/**
|
|
23121
23275
|
* Journey service.
|
|
23122
23276
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
23123
|
-
* @version
|
|
23277
|
+
* @version 141.1.0
|
|
23124
23278
|
*/
|
|
23125
23279
|
|
|
23126
23280
|
/**
|
|
@@ -23831,7 +23985,7 @@ class KnowledgeApi {
|
|
|
23831
23985
|
/**
|
|
23832
23986
|
* Knowledge service.
|
|
23833
23987
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
23834
|
-
* @version
|
|
23988
|
+
* @version 141.1.0
|
|
23835
23989
|
*/
|
|
23836
23990
|
|
|
23837
23991
|
/**
|
|
@@ -24731,7 +24885,7 @@ class LanguageUnderstandingApi {
|
|
|
24731
24885
|
/**
|
|
24732
24886
|
* LanguageUnderstanding service.
|
|
24733
24887
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
24734
|
-
* @version
|
|
24888
|
+
* @version 141.1.0
|
|
24735
24889
|
*/
|
|
24736
24890
|
|
|
24737
24891
|
/**
|
|
@@ -25635,7 +25789,7 @@ class LanguagesApi {
|
|
|
25635
25789
|
/**
|
|
25636
25790
|
* Languages service.
|
|
25637
25791
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
25638
|
-
* @version
|
|
25792
|
+
* @version 141.1.0
|
|
25639
25793
|
*/
|
|
25640
25794
|
|
|
25641
25795
|
/**
|
|
@@ -25903,7 +26057,7 @@ class LearningApi {
|
|
|
25903
26057
|
/**
|
|
25904
26058
|
* Learning service.
|
|
25905
26059
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
25906
|
-
* @version
|
|
26060
|
+
* @version 141.1.0
|
|
25907
26061
|
*/
|
|
25908
26062
|
|
|
25909
26063
|
/**
|
|
@@ -26222,6 +26376,40 @@ class LearningApi {
|
|
|
26222
26376
|
);
|
|
26223
26377
|
}
|
|
26224
26378
|
|
|
26379
|
+
/**
|
|
26380
|
+
* Get all learning modules of an organization including assignments for a specific user
|
|
26381
|
+
*
|
|
26382
|
+
* @param {Array.<String>} userIds The IDs of the users to include
|
|
26383
|
+
* @param {Object} opts Optional parameters
|
|
26384
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
26385
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
26386
|
+
* @param {String} opts.searchTerm Search Term (searches by name and description)
|
|
26387
|
+
* @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)
|
|
26388
|
+
* @param {Array.<String>} opts.assignmentStates Specifies the assignment states to return.
|
|
26389
|
+
* @param {Array.<String>} opts.expand Fields to expand in response(case insensitive)
|
|
26390
|
+
*/
|
|
26391
|
+
getLearningModulesAssignments(userIds, opts) {
|
|
26392
|
+
opts = opts || {};
|
|
26393
|
+
|
|
26394
|
+
// verify the required parameter 'userIds' is set
|
|
26395
|
+
if (userIds === undefined || userIds === null) {
|
|
26396
|
+
throw 'Missing the required parameter "userIds" when calling getLearningModulesAssignments';
|
|
26397
|
+
}
|
|
26398
|
+
|
|
26399
|
+
return this.apiClient.callApi(
|
|
26400
|
+
'/api/v2/learning/modules/assignments',
|
|
26401
|
+
'GET',
|
|
26402
|
+
{ },
|
|
26403
|
+
{ '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') },
|
|
26404
|
+
{ },
|
|
26405
|
+
{ },
|
|
26406
|
+
null,
|
|
26407
|
+
['PureCloud OAuth'],
|
|
26408
|
+
['application/json'],
|
|
26409
|
+
['application/json']
|
|
26410
|
+
);
|
|
26411
|
+
}
|
|
26412
|
+
|
|
26225
26413
|
/**
|
|
26226
26414
|
* Update Learning Assignment
|
|
26227
26415
|
*
|
|
@@ -26604,7 +26792,7 @@ class LicenseApi {
|
|
|
26604
26792
|
/**
|
|
26605
26793
|
* License service.
|
|
26606
26794
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
26607
|
-
* @version
|
|
26795
|
+
* @version 141.1.0
|
|
26608
26796
|
*/
|
|
26609
26797
|
|
|
26610
26798
|
/**
|
|
@@ -26842,7 +27030,7 @@ class LocationsApi {
|
|
|
26842
27030
|
/**
|
|
26843
27031
|
* Locations service.
|
|
26844
27032
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
26845
|
-
* @version
|
|
27033
|
+
* @version 141.1.0
|
|
26846
27034
|
*/
|
|
26847
27035
|
|
|
26848
27036
|
/**
|
|
@@ -27078,7 +27266,7 @@ class MessagingApi {
|
|
|
27078
27266
|
/**
|
|
27079
27267
|
* Messaging service.
|
|
27080
27268
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
27081
|
-
* @version
|
|
27269
|
+
* @version 141.1.0
|
|
27082
27270
|
*/
|
|
27083
27271
|
|
|
27084
27272
|
/**
|
|
@@ -27229,7 +27417,7 @@ class MobileDevicesApi {
|
|
|
27229
27417
|
/**
|
|
27230
27418
|
* MobileDevices service.
|
|
27231
27419
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
27232
|
-
* @version
|
|
27420
|
+
* @version 141.1.0
|
|
27233
27421
|
*/
|
|
27234
27422
|
|
|
27235
27423
|
/**
|
|
@@ -27380,7 +27568,7 @@ class NotificationsApi {
|
|
|
27380
27568
|
/**
|
|
27381
27569
|
* Notifications service.
|
|
27382
27570
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
27383
|
-
* @version
|
|
27571
|
+
* @version 141.1.0
|
|
27384
27572
|
*/
|
|
27385
27573
|
|
|
27386
27574
|
/**
|
|
@@ -27605,7 +27793,7 @@ class OAuthApi {
|
|
|
27605
27793
|
/**
|
|
27606
27794
|
* OAuth service.
|
|
27607
27795
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
27608
|
-
* @version
|
|
27796
|
+
* @version 141.1.0
|
|
27609
27797
|
*/
|
|
27610
27798
|
|
|
27611
27799
|
/**
|
|
@@ -27971,7 +28159,7 @@ class ObjectsApi {
|
|
|
27971
28159
|
/**
|
|
27972
28160
|
* Objects service.
|
|
27973
28161
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
27974
|
-
* @version
|
|
28162
|
+
* @version 141.1.0
|
|
27975
28163
|
*/
|
|
27976
28164
|
|
|
27977
28165
|
/**
|
|
@@ -28242,7 +28430,7 @@ class OrganizationApi {
|
|
|
28242
28430
|
/**
|
|
28243
28431
|
* Organization service.
|
|
28244
28432
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
28245
|
-
* @version
|
|
28433
|
+
* @version 141.1.0
|
|
28246
28434
|
*/
|
|
28247
28435
|
|
|
28248
28436
|
/**
|
|
@@ -28645,7 +28833,7 @@ class OrganizationAuthorizationApi {
|
|
|
28645
28833
|
/**
|
|
28646
28834
|
* OrganizationAuthorization service.
|
|
28647
28835
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
28648
|
-
* @version
|
|
28836
|
+
* @version 141.1.0
|
|
28649
28837
|
*/
|
|
28650
28838
|
|
|
28651
28839
|
/**
|
|
@@ -29570,7 +29758,7 @@ class OutboundApi {
|
|
|
29570
29758
|
/**
|
|
29571
29759
|
* Outbound service.
|
|
29572
29760
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
29573
|
-
* @version
|
|
29761
|
+
* @version 141.1.0
|
|
29574
29762
|
*/
|
|
29575
29763
|
|
|
29576
29764
|
/**
|
|
@@ -32825,7 +33013,7 @@ class PresenceApi {
|
|
|
32825
33013
|
/**
|
|
32826
33014
|
* Presence service.
|
|
32827
33015
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
32828
|
-
* @version
|
|
33016
|
+
* @version 141.1.0
|
|
32829
33017
|
*/
|
|
32830
33018
|
|
|
32831
33019
|
/**
|
|
@@ -33147,7 +33335,7 @@ class QualityApi {
|
|
|
33147
33335
|
/**
|
|
33148
33336
|
* Quality service.
|
|
33149
33337
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
33150
|
-
* @version
|
|
33338
|
+
* @version 141.1.0
|
|
33151
33339
|
*/
|
|
33152
33340
|
|
|
33153
33341
|
/**
|
|
@@ -34725,7 +34913,7 @@ class RecordingApi {
|
|
|
34725
34913
|
/**
|
|
34726
34914
|
* Recording service.
|
|
34727
34915
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
34728
|
-
* @version
|
|
34916
|
+
* @version 141.1.0
|
|
34729
34917
|
*/
|
|
34730
34918
|
|
|
34731
34919
|
/**
|
|
@@ -36378,7 +36566,7 @@ class ResponseManagementApi {
|
|
|
36378
36566
|
/**
|
|
36379
36567
|
* ResponseManagement service.
|
|
36380
36568
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
36381
|
-
* @version
|
|
36569
|
+
* @version 141.1.0
|
|
36382
36570
|
*/
|
|
36383
36571
|
|
|
36384
36572
|
/**
|
|
@@ -36862,7 +37050,7 @@ class RoutingApi {
|
|
|
36862
37050
|
/**
|
|
36863
37051
|
* Routing service.
|
|
36864
37052
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
36865
|
-
* @version
|
|
37053
|
+
* @version 141.1.0
|
|
36866
37054
|
*/
|
|
36867
37055
|
|
|
36868
37056
|
/**
|
|
@@ -37972,6 +38160,8 @@ class RoutingApi {
|
|
|
37972
38160
|
* @param {String} opts.name Filter by queue name
|
|
37973
38161
|
* @param {Array.<String>} opts.id Filter by queue ID(s)
|
|
37974
38162
|
* @param {Array.<String>} opts.divisionId Filter by queue division ID(s)
|
|
38163
|
+
* @param {Array.<String>} opts.peerId Filter by queue peer ID(s)
|
|
38164
|
+
* @param {Boolean} opts.hasPeer Filter by queues associated with peer
|
|
37975
38165
|
*/
|
|
37976
38166
|
getRoutingQueues(opts) {
|
|
37977
38167
|
opts = opts || {};
|
|
@@ -37981,7 +38171,7 @@ class RoutingApi {
|
|
|
37981
38171
|
'/api/v2/routing/queues',
|
|
37982
38172
|
'GET',
|
|
37983
38173
|
{ },
|
|
37984
|
-
{ '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') },
|
|
38174
|
+
{ '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'] },
|
|
37985
38175
|
{ },
|
|
37986
38176
|
{ },
|
|
37987
38177
|
null,
|
|
@@ -39781,7 +39971,7 @@ class SCIMApi {
|
|
|
39781
39971
|
/**
|
|
39782
39972
|
* SCIM service.
|
|
39783
39973
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
39784
|
-
* @version
|
|
39974
|
+
* @version 141.1.0
|
|
39785
39975
|
*/
|
|
39786
39976
|
|
|
39787
39977
|
/**
|
|
@@ -40658,7 +40848,7 @@ class ScriptsApi {
|
|
|
40658
40848
|
/**
|
|
40659
40849
|
* Scripts service.
|
|
40660
40850
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
40661
|
-
* @version
|
|
40851
|
+
* @version 141.1.0
|
|
40662
40852
|
*/
|
|
40663
40853
|
|
|
40664
40854
|
/**
|
|
@@ -41077,7 +41267,7 @@ class SearchApi {
|
|
|
41077
41267
|
/**
|
|
41078
41268
|
* Search service.
|
|
41079
41269
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
41080
|
-
* @version
|
|
41270
|
+
* @version 141.1.0
|
|
41081
41271
|
*/
|
|
41082
41272
|
|
|
41083
41273
|
/**
|
|
@@ -41556,6 +41746,31 @@ class SearchApi {
|
|
|
41556
41746
|
);
|
|
41557
41747
|
}
|
|
41558
41748
|
|
|
41749
|
+
/**
|
|
41750
|
+
* Search resources.
|
|
41751
|
+
*
|
|
41752
|
+
* @param {Object} body Search request options
|
|
41753
|
+
*/
|
|
41754
|
+
postTeamsSearch(body) {
|
|
41755
|
+
// verify the required parameter 'body' is set
|
|
41756
|
+
if (body === undefined || body === null) {
|
|
41757
|
+
throw 'Missing the required parameter "body" when calling postTeamsSearch';
|
|
41758
|
+
}
|
|
41759
|
+
|
|
41760
|
+
return this.apiClient.callApi(
|
|
41761
|
+
'/api/v2/teams/search',
|
|
41762
|
+
'POST',
|
|
41763
|
+
{ },
|
|
41764
|
+
{ },
|
|
41765
|
+
{ },
|
|
41766
|
+
{ },
|
|
41767
|
+
body,
|
|
41768
|
+
['PureCloud OAuth'],
|
|
41769
|
+
['application/json'],
|
|
41770
|
+
['application/json']
|
|
41771
|
+
);
|
|
41772
|
+
}
|
|
41773
|
+
|
|
41559
41774
|
/**
|
|
41560
41775
|
* Search users
|
|
41561
41776
|
*
|
|
@@ -41612,7 +41827,7 @@ class SpeechTextAnalyticsApi {
|
|
|
41612
41827
|
/**
|
|
41613
41828
|
* SpeechTextAnalytics service.
|
|
41614
41829
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
41615
|
-
* @version
|
|
41830
|
+
* @version 141.1.0
|
|
41616
41831
|
*/
|
|
41617
41832
|
|
|
41618
41833
|
/**
|
|
@@ -42465,7 +42680,7 @@ class StationsApi {
|
|
|
42465
42680
|
/**
|
|
42466
42681
|
* Stations service.
|
|
42467
42682
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
42468
|
-
* @version
|
|
42683
|
+
* @version 141.1.0
|
|
42469
42684
|
*/
|
|
42470
42685
|
|
|
42471
42686
|
/**
|
|
@@ -42612,7 +42827,7 @@ class SuggestApi {
|
|
|
42612
42827
|
/**
|
|
42613
42828
|
* Suggest service.
|
|
42614
42829
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
42615
|
-
* @version
|
|
42830
|
+
* @version 141.1.0
|
|
42616
42831
|
*/
|
|
42617
42832
|
|
|
42618
42833
|
/**
|
|
@@ -42747,11 +42962,190 @@ class SuggestApi {
|
|
|
42747
42962
|
|
|
42748
42963
|
}
|
|
42749
42964
|
|
|
42965
|
+
class TeamsApi {
|
|
42966
|
+
/**
|
|
42967
|
+
* Teams service.
|
|
42968
|
+
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
42969
|
+
* @version 141.1.0
|
|
42970
|
+
*/
|
|
42971
|
+
|
|
42972
|
+
/**
|
|
42973
|
+
* Constructs a new TeamsApi.
|
|
42974
|
+
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
42975
|
+
* @class
|
|
42976
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
42977
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
42978
|
+
*/
|
|
42979
|
+
constructor(apiClient) {
|
|
42980
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
42981
|
+
}
|
|
42982
|
+
|
|
42983
|
+
|
|
42984
|
+
/**
|
|
42985
|
+
* Delete team
|
|
42986
|
+
*
|
|
42987
|
+
* @param {String} teamId Team ID
|
|
42988
|
+
*/
|
|
42989
|
+
deleteTeam(teamId) {
|
|
42990
|
+
// verify the required parameter 'teamId' is set
|
|
42991
|
+
if (teamId === undefined || teamId === null) {
|
|
42992
|
+
throw 'Missing the required parameter "teamId" when calling deleteTeam';
|
|
42993
|
+
}
|
|
42994
|
+
|
|
42995
|
+
return this.apiClient.callApi(
|
|
42996
|
+
'/api/v2/teams/{teamId}',
|
|
42997
|
+
'DELETE',
|
|
42998
|
+
{ 'teamId': teamId },
|
|
42999
|
+
{ },
|
|
43000
|
+
{ },
|
|
43001
|
+
{ },
|
|
43002
|
+
null,
|
|
43003
|
+
['PureCloud OAuth'],
|
|
43004
|
+
['application/json'],
|
|
43005
|
+
['application/json']
|
|
43006
|
+
);
|
|
43007
|
+
}
|
|
43008
|
+
|
|
43009
|
+
/**
|
|
43010
|
+
* Get team
|
|
43011
|
+
*
|
|
43012
|
+
* @param {String} teamId Team ID
|
|
43013
|
+
*/
|
|
43014
|
+
getTeam(teamId) {
|
|
43015
|
+
// verify the required parameter 'teamId' is set
|
|
43016
|
+
if (teamId === undefined || teamId === null) {
|
|
43017
|
+
throw 'Missing the required parameter "teamId" when calling getTeam';
|
|
43018
|
+
}
|
|
43019
|
+
|
|
43020
|
+
return this.apiClient.callApi(
|
|
43021
|
+
'/api/v2/teams/{teamId}',
|
|
43022
|
+
'GET',
|
|
43023
|
+
{ 'teamId': teamId },
|
|
43024
|
+
{ },
|
|
43025
|
+
{ },
|
|
43026
|
+
{ },
|
|
43027
|
+
null,
|
|
43028
|
+
['PureCloud OAuth'],
|
|
43029
|
+
['application/json'],
|
|
43030
|
+
['application/json']
|
|
43031
|
+
);
|
|
43032
|
+
}
|
|
43033
|
+
|
|
43034
|
+
/**
|
|
43035
|
+
* Get Team listing
|
|
43036
|
+
*
|
|
43037
|
+
* @param {Object} opts Optional parameters
|
|
43038
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
43039
|
+
* @param {String} opts.name Return only teams whose names start with this value (case-insensitive matching)
|
|
43040
|
+
* @param {String} opts.after The cursor that points to the next item in the complete list of teams
|
|
43041
|
+
* @param {String} opts.before The cursor that points to the previous item in the complete list of teams
|
|
43042
|
+
* @param {Object} opts.expand Expand the name on each user
|
|
43043
|
+
*/
|
|
43044
|
+
getTeams(opts) {
|
|
43045
|
+
opts = opts || {};
|
|
43046
|
+
|
|
43047
|
+
|
|
43048
|
+
return this.apiClient.callApi(
|
|
43049
|
+
'/api/v2/teams',
|
|
43050
|
+
'GET',
|
|
43051
|
+
{ },
|
|
43052
|
+
{ 'pageSize': opts['pageSize'],'name': opts['name'],'after': opts['after'],'before': opts['before'],'expand': opts['expand'] },
|
|
43053
|
+
{ },
|
|
43054
|
+
{ },
|
|
43055
|
+
null,
|
|
43056
|
+
['PureCloud OAuth'],
|
|
43057
|
+
['application/json'],
|
|
43058
|
+
['application/json']
|
|
43059
|
+
);
|
|
43060
|
+
}
|
|
43061
|
+
|
|
43062
|
+
/**
|
|
43063
|
+
* Update team
|
|
43064
|
+
*
|
|
43065
|
+
* @param {String} teamId Team ID
|
|
43066
|
+
* @param {Object} body Team
|
|
43067
|
+
*/
|
|
43068
|
+
patchTeam(teamId, body) {
|
|
43069
|
+
// verify the required parameter 'teamId' is set
|
|
43070
|
+
if (teamId === undefined || teamId === null) {
|
|
43071
|
+
throw 'Missing the required parameter "teamId" when calling patchTeam';
|
|
43072
|
+
}
|
|
43073
|
+
// verify the required parameter 'body' is set
|
|
43074
|
+
if (body === undefined || body === null) {
|
|
43075
|
+
throw 'Missing the required parameter "body" when calling patchTeam';
|
|
43076
|
+
}
|
|
43077
|
+
|
|
43078
|
+
return this.apiClient.callApi(
|
|
43079
|
+
'/api/v2/teams/{teamId}',
|
|
43080
|
+
'PATCH',
|
|
43081
|
+
{ 'teamId': teamId },
|
|
43082
|
+
{ },
|
|
43083
|
+
{ },
|
|
43084
|
+
{ },
|
|
43085
|
+
body,
|
|
43086
|
+
['PureCloud OAuth'],
|
|
43087
|
+
['application/json'],
|
|
43088
|
+
['application/json']
|
|
43089
|
+
);
|
|
43090
|
+
}
|
|
43091
|
+
|
|
43092
|
+
/**
|
|
43093
|
+
* Create a team
|
|
43094
|
+
*
|
|
43095
|
+
* @param {Object} body Team
|
|
43096
|
+
*/
|
|
43097
|
+
postTeams(body) {
|
|
43098
|
+
// verify the required parameter 'body' is set
|
|
43099
|
+
if (body === undefined || body === null) {
|
|
43100
|
+
throw 'Missing the required parameter "body" when calling postTeams';
|
|
43101
|
+
}
|
|
43102
|
+
|
|
43103
|
+
return this.apiClient.callApi(
|
|
43104
|
+
'/api/v2/teams',
|
|
43105
|
+
'POST',
|
|
43106
|
+
{ },
|
|
43107
|
+
{ },
|
|
43108
|
+
{ },
|
|
43109
|
+
{ },
|
|
43110
|
+
body,
|
|
43111
|
+
['PureCloud OAuth'],
|
|
43112
|
+
['application/json'],
|
|
43113
|
+
['application/json']
|
|
43114
|
+
);
|
|
43115
|
+
}
|
|
43116
|
+
|
|
43117
|
+
/**
|
|
43118
|
+
* Search resources.
|
|
43119
|
+
*
|
|
43120
|
+
* @param {Object} body Search request options
|
|
43121
|
+
*/
|
|
43122
|
+
postTeamsSearch(body) {
|
|
43123
|
+
// verify the required parameter 'body' is set
|
|
43124
|
+
if (body === undefined || body === null) {
|
|
43125
|
+
throw 'Missing the required parameter "body" when calling postTeamsSearch';
|
|
43126
|
+
}
|
|
43127
|
+
|
|
43128
|
+
return this.apiClient.callApi(
|
|
43129
|
+
'/api/v2/teams/search',
|
|
43130
|
+
'POST',
|
|
43131
|
+
{ },
|
|
43132
|
+
{ },
|
|
43133
|
+
{ },
|
|
43134
|
+
{ },
|
|
43135
|
+
body,
|
|
43136
|
+
['PureCloud OAuth'],
|
|
43137
|
+
['application/json'],
|
|
43138
|
+
['application/json']
|
|
43139
|
+
);
|
|
43140
|
+
}
|
|
43141
|
+
|
|
43142
|
+
}
|
|
43143
|
+
|
|
42750
43144
|
class TelephonyApi {
|
|
42751
43145
|
/**
|
|
42752
43146
|
* Telephony service.
|
|
42753
43147
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
42754
|
-
* @version
|
|
43148
|
+
* @version 141.1.0
|
|
42755
43149
|
*/
|
|
42756
43150
|
|
|
42757
43151
|
/**
|
|
@@ -42859,7 +43253,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
42859
43253
|
/**
|
|
42860
43254
|
* TelephonyProvidersEdge service.
|
|
42861
43255
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
42862
|
-
* @version
|
|
43256
|
+
* @version 141.1.0
|
|
42863
43257
|
*/
|
|
42864
43258
|
|
|
42865
43259
|
/**
|
|
@@ -46492,7 +46886,7 @@ class TextbotsApi {
|
|
|
46492
46886
|
/**
|
|
46493
46887
|
* Textbots service.
|
|
46494
46888
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
46495
|
-
* @version
|
|
46889
|
+
* @version 141.1.0
|
|
46496
46890
|
*/
|
|
46497
46891
|
|
|
46498
46892
|
/**
|
|
@@ -46620,7 +47014,7 @@ class TokensApi {
|
|
|
46620
47014
|
/**
|
|
46621
47015
|
* Tokens service.
|
|
46622
47016
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
46623
|
-
* @version
|
|
47017
|
+
* @version 141.1.0
|
|
46624
47018
|
*/
|
|
46625
47019
|
|
|
46626
47020
|
/**
|
|
@@ -46726,7 +47120,7 @@ class UploadsApi {
|
|
|
46726
47120
|
/**
|
|
46727
47121
|
* Uploads service.
|
|
46728
47122
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
46729
|
-
* @version
|
|
47123
|
+
* @version 141.1.0
|
|
46730
47124
|
*/
|
|
46731
47125
|
|
|
46732
47126
|
/**
|
|
@@ -46877,7 +47271,7 @@ class UsageApi {
|
|
|
46877
47271
|
/**
|
|
46878
47272
|
* Usage service.
|
|
46879
47273
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
46880
|
-
* @version
|
|
47274
|
+
* @version 141.1.0
|
|
46881
47275
|
*/
|
|
46882
47276
|
|
|
46883
47277
|
/**
|
|
@@ -46948,7 +47342,7 @@ class UserRecordingsApi {
|
|
|
46948
47342
|
/**
|
|
46949
47343
|
* UserRecordings service.
|
|
46950
47344
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
46951
|
-
* @version
|
|
47345
|
+
* @version 141.1.0
|
|
46952
47346
|
*/
|
|
46953
47347
|
|
|
46954
47348
|
/**
|
|
@@ -47132,7 +47526,7 @@ class UsersApi {
|
|
|
47132
47526
|
/**
|
|
47133
47527
|
* Users service.
|
|
47134
47528
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
47135
|
-
* @version
|
|
47529
|
+
* @version 141.1.0
|
|
47136
47530
|
*/
|
|
47137
47531
|
|
|
47138
47532
|
/**
|
|
@@ -49434,7 +49828,7 @@ class UtilitiesApi {
|
|
|
49434
49828
|
/**
|
|
49435
49829
|
* Utilities service.
|
|
49436
49830
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
49437
|
-
* @version
|
|
49831
|
+
* @version 141.1.0
|
|
49438
49832
|
*/
|
|
49439
49833
|
|
|
49440
49834
|
/**
|
|
@@ -49545,7 +49939,7 @@ class VoicemailApi {
|
|
|
49545
49939
|
/**
|
|
49546
49940
|
* Voicemail service.
|
|
49547
49941
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
49548
|
-
* @version
|
|
49942
|
+
* @version 141.1.0
|
|
49549
49943
|
*/
|
|
49550
49944
|
|
|
49551
49945
|
/**
|
|
@@ -50212,7 +50606,7 @@ class WebChatApi {
|
|
|
50212
50606
|
/**
|
|
50213
50607
|
* WebChat service.
|
|
50214
50608
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
50215
|
-
* @version
|
|
50609
|
+
* @version 141.1.0
|
|
50216
50610
|
*/
|
|
50217
50611
|
|
|
50218
50612
|
/**
|
|
@@ -50756,7 +51150,7 @@ class WebDeploymentsApi {
|
|
|
50756
51150
|
/**
|
|
50757
51151
|
* WebDeployments service.
|
|
50758
51152
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
50759
|
-
* @version
|
|
51153
|
+
* @version 141.1.0
|
|
50760
51154
|
*/
|
|
50761
51155
|
|
|
50762
51156
|
/**
|
|
@@ -51111,7 +51505,7 @@ class WebMessagingApi {
|
|
|
51111
51505
|
/**
|
|
51112
51506
|
* WebMessaging service.
|
|
51113
51507
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
51114
|
-
* @version
|
|
51508
|
+
* @version 141.1.0
|
|
51115
51509
|
*/
|
|
51116
51510
|
|
|
51117
51511
|
/**
|
|
@@ -51157,7 +51551,7 @@ class WidgetsApi {
|
|
|
51157
51551
|
/**
|
|
51158
51552
|
* Widgets service.
|
|
51159
51553
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
51160
|
-
* @version
|
|
51554
|
+
* @version 141.1.0
|
|
51161
51555
|
*/
|
|
51162
51556
|
|
|
51163
51557
|
/**
|
|
@@ -51303,7 +51697,7 @@ class WorkforceManagementApi {
|
|
|
51303
51697
|
/**
|
|
51304
51698
|
* WorkforceManagement service.
|
|
51305
51699
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
51306
|
-
* @version
|
|
51700
|
+
* @version 141.1.0
|
|
51307
51701
|
*/
|
|
51308
51702
|
|
|
51309
51703
|
/**
|
|
@@ -51723,6 +52117,31 @@ class WorkforceManagementApi {
|
|
|
51723
52117
|
);
|
|
51724
52118
|
}
|
|
51725
52119
|
|
|
52120
|
+
/**
|
|
52121
|
+
* Query the status of a historical adherence request operation. Only the user who started the operation can query the status
|
|
52122
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
52123
|
+
* @param {String} jobId jobId
|
|
52124
|
+
*/
|
|
52125
|
+
getWorkforcemanagementAdherenceHistoricalJob(jobId) {
|
|
52126
|
+
// verify the required parameter 'jobId' is set
|
|
52127
|
+
if (jobId === undefined || jobId === null) {
|
|
52128
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAdherenceHistoricalJob';
|
|
52129
|
+
}
|
|
52130
|
+
|
|
52131
|
+
return this.apiClient.callApi(
|
|
52132
|
+
'/api/v2/workforcemanagement/adherence/historical/jobs/{jobId}',
|
|
52133
|
+
'GET',
|
|
52134
|
+
{ 'jobId': jobId },
|
|
52135
|
+
{ },
|
|
52136
|
+
{ },
|
|
52137
|
+
{ },
|
|
52138
|
+
null,
|
|
52139
|
+
['PureCloud OAuth'],
|
|
52140
|
+
['application/json'],
|
|
52141
|
+
['application/json']
|
|
52142
|
+
);
|
|
52143
|
+
}
|
|
52144
|
+
|
|
51726
52145
|
/**
|
|
51727
52146
|
* Get status of the modeling job
|
|
51728
52147
|
*
|
|
@@ -55554,7 +55973,7 @@ class WorkforceManagementApi {
|
|
|
55554
55973
|
* </pre>
|
|
55555
55974
|
* </p>
|
|
55556
55975
|
* @module purecloud-platform-client-v2/index
|
|
55557
|
-
* @version
|
|
55976
|
+
* @version 141.1.0
|
|
55558
55977
|
*/
|
|
55559
55978
|
class platformClient {
|
|
55560
55979
|
constructor() {
|
|
@@ -55803,6 +56222,11 @@ class platformClient {
|
|
|
55803
56222
|
* @property {module:purecloud-platform-client-v2/api/SuggestApi}
|
|
55804
56223
|
*/
|
|
55805
56224
|
this.SuggestApi = SuggestApi;
|
|
56225
|
+
/**
|
|
56226
|
+
* The TeamsApi service constructor.
|
|
56227
|
+
* @property {module:purecloud-platform-client-v2/api/TeamsApi}
|
|
56228
|
+
*/
|
|
56229
|
+
this.TeamsApi = TeamsApi;
|
|
55806
56230
|
/**
|
|
55807
56231
|
* The TelephonyApi service constructor.
|
|
55808
56232
|
* @property {module:purecloud-platform-client-v2/api/TelephonyApi}
|