purecloud-platform-client-v2 138.0.1 → 140.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/node/purecloud-platform-client-v2.js +537 -161
- package/dist/web-amd/purecloud-platform-client-v2.js +537 -162
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +537 -161
- package/dist/web-cjs/purecloud-platform-client-v2.js +2631 -199
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +783 -224
- 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 +15 -15
- 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 +271 -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 +28 -27
- 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 +5 -5
- 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 +111 -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 +2 -2
- 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 +16 -24
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +15 -15
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
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 140.0.1
|
|
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 140.0.1
|
|
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 140.0.1
|
|
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 140.0.1
|
|
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 140.0.1
|
|
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 140.0.1
|
|
8063
8066
|
*/
|
|
8064
8067
|
|
|
8065
8068
|
/**
|
|
@@ -8664,18 +8667,18 @@ class AuthorizationApi {
|
|
|
8664
8667
|
/**
|
|
8665
8668
|
* Returns a listing of roles and permissions for a user.
|
|
8666
8669
|
*
|
|
8667
|
-
* @param {String}
|
|
8670
|
+
* @param {String} subjectId User ID
|
|
8668
8671
|
*/
|
|
8669
|
-
getUserRoles(
|
|
8670
|
-
// verify the required parameter '
|
|
8671
|
-
if (
|
|
8672
|
-
throw 'Missing the required parameter "
|
|
8672
|
+
getUserRoles(subjectId) {
|
|
8673
|
+
// verify the required parameter 'subjectId' is set
|
|
8674
|
+
if (subjectId === undefined || subjectId === null) {
|
|
8675
|
+
throw 'Missing the required parameter "subjectId" when calling getUserRoles';
|
|
8673
8676
|
}
|
|
8674
8677
|
|
|
8675
8678
|
return this.apiClient.callApi(
|
|
8676
|
-
'/api/v2/users/{
|
|
8679
|
+
'/api/v2/users/{subjectId}/roles',
|
|
8677
8680
|
'GET',
|
|
8678
|
-
{ '
|
|
8681
|
+
{ 'subjectId': subjectId },
|
|
8679
8682
|
{ },
|
|
8680
8683
|
{ },
|
|
8681
8684
|
{ },
|
|
@@ -9209,13 +9212,13 @@ class AuthorizationApi {
|
|
|
9209
9212
|
/**
|
|
9210
9213
|
* Sets the user's roles
|
|
9211
9214
|
*
|
|
9212
|
-
* @param {String}
|
|
9215
|
+
* @param {String} subjectId User ID
|
|
9213
9216
|
* @param {Array.<String>} body List of roles
|
|
9214
9217
|
*/
|
|
9215
|
-
putUserRoles(
|
|
9216
|
-
// verify the required parameter '
|
|
9217
|
-
if (
|
|
9218
|
-
throw 'Missing the required parameter "
|
|
9218
|
+
putUserRoles(subjectId, body) {
|
|
9219
|
+
// verify the required parameter 'subjectId' is set
|
|
9220
|
+
if (subjectId === undefined || subjectId === null) {
|
|
9221
|
+
throw 'Missing the required parameter "subjectId" when calling putUserRoles';
|
|
9219
9222
|
}
|
|
9220
9223
|
// verify the required parameter 'body' is set
|
|
9221
9224
|
if (body === undefined || body === null) {
|
|
@@ -9223,9 +9226,9 @@ class AuthorizationApi {
|
|
|
9223
9226
|
}
|
|
9224
9227
|
|
|
9225
9228
|
return this.apiClient.callApi(
|
|
9226
|
-
'/api/v2/users/{
|
|
9229
|
+
'/api/v2/users/{subjectId}/roles',
|
|
9227
9230
|
'PUT',
|
|
9228
|
-
{ '
|
|
9231
|
+
{ 'subjectId': subjectId },
|
|
9229
9232
|
{ },
|
|
9230
9233
|
{ },
|
|
9231
9234
|
{ },
|
|
@@ -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 140.0.1
|
|
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 140.0.1
|
|
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 140.0.1
|
|
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 140.0.1
|
|
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 140.0.1
|
|
11134
11137
|
*/
|
|
11135
11138
|
|
|
11136
11139
|
/**
|
|
@@ -15678,6 +15681,126 @@ class ConversationsApi {
|
|
|
15678
15681
|
);
|
|
15679
15682
|
}
|
|
15680
15683
|
|
|
15684
|
+
/**
|
|
15685
|
+
* Update a conversation by setting its recording state
|
|
15686
|
+
*
|
|
15687
|
+
* @param {String} conversationId conversationId
|
|
15688
|
+
* @param {Object} body SetRecordingState
|
|
15689
|
+
*/
|
|
15690
|
+
putConversationsCallRecordingstate(conversationId, body) {
|
|
15691
|
+
// verify the required parameter 'conversationId' is set
|
|
15692
|
+
if (conversationId === undefined || conversationId === null) {
|
|
15693
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationsCallRecordingstate';
|
|
15694
|
+
}
|
|
15695
|
+
// verify the required parameter 'body' is set
|
|
15696
|
+
if (body === undefined || body === null) {
|
|
15697
|
+
throw 'Missing the required parameter "body" when calling putConversationsCallRecordingstate';
|
|
15698
|
+
}
|
|
15699
|
+
|
|
15700
|
+
return this.apiClient.callApi(
|
|
15701
|
+
'/api/v2/conversations/calls/{conversationId}/recordingstate',
|
|
15702
|
+
'PUT',
|
|
15703
|
+
{ 'conversationId': conversationId },
|
|
15704
|
+
{ },
|
|
15705
|
+
{ },
|
|
15706
|
+
{ },
|
|
15707
|
+
body,
|
|
15708
|
+
['PureCloud OAuth'],
|
|
15709
|
+
['application/json'],
|
|
15710
|
+
['application/json']
|
|
15711
|
+
);
|
|
15712
|
+
}
|
|
15713
|
+
|
|
15714
|
+
/**
|
|
15715
|
+
* Update a conversation by setting its recording state
|
|
15716
|
+
*
|
|
15717
|
+
* @param {String} conversationId conversationId
|
|
15718
|
+
* @param {Object} body SetRecordingState
|
|
15719
|
+
*/
|
|
15720
|
+
putConversationsCallbackRecordingstate(conversationId, body) {
|
|
15721
|
+
// verify the required parameter 'conversationId' is set
|
|
15722
|
+
if (conversationId === undefined || conversationId === null) {
|
|
15723
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationsCallbackRecordingstate';
|
|
15724
|
+
}
|
|
15725
|
+
// verify the required parameter 'body' is set
|
|
15726
|
+
if (body === undefined || body === null) {
|
|
15727
|
+
throw 'Missing the required parameter "body" when calling putConversationsCallbackRecordingstate';
|
|
15728
|
+
}
|
|
15729
|
+
|
|
15730
|
+
return this.apiClient.callApi(
|
|
15731
|
+
'/api/v2/conversations/callbacks/{conversationId}/recordingstate',
|
|
15732
|
+
'PUT',
|
|
15733
|
+
{ 'conversationId': conversationId },
|
|
15734
|
+
{ },
|
|
15735
|
+
{ },
|
|
15736
|
+
{ },
|
|
15737
|
+
body,
|
|
15738
|
+
['PureCloud OAuth'],
|
|
15739
|
+
['application/json'],
|
|
15740
|
+
['application/json']
|
|
15741
|
+
);
|
|
15742
|
+
}
|
|
15743
|
+
|
|
15744
|
+
/**
|
|
15745
|
+
* Update a conversation by setting its recording state
|
|
15746
|
+
*
|
|
15747
|
+
* @param {String} conversationId conversationId
|
|
15748
|
+
* @param {Object} body SetRecordingState
|
|
15749
|
+
*/
|
|
15750
|
+
putConversationsChatRecordingstate(conversationId, body) {
|
|
15751
|
+
// verify the required parameter 'conversationId' is set
|
|
15752
|
+
if (conversationId === undefined || conversationId === null) {
|
|
15753
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationsChatRecordingstate';
|
|
15754
|
+
}
|
|
15755
|
+
// verify the required parameter 'body' is set
|
|
15756
|
+
if (body === undefined || body === null) {
|
|
15757
|
+
throw 'Missing the required parameter "body" when calling putConversationsChatRecordingstate';
|
|
15758
|
+
}
|
|
15759
|
+
|
|
15760
|
+
return this.apiClient.callApi(
|
|
15761
|
+
'/api/v2/conversations/chats/{conversationId}/recordingstate',
|
|
15762
|
+
'PUT',
|
|
15763
|
+
{ 'conversationId': conversationId },
|
|
15764
|
+
{ },
|
|
15765
|
+
{ },
|
|
15766
|
+
{ },
|
|
15767
|
+
body,
|
|
15768
|
+
['PureCloud OAuth'],
|
|
15769
|
+
['application/json'],
|
|
15770
|
+
['application/json']
|
|
15771
|
+
);
|
|
15772
|
+
}
|
|
15773
|
+
|
|
15774
|
+
/**
|
|
15775
|
+
* Update a conversation by setting its recording state
|
|
15776
|
+
*
|
|
15777
|
+
* @param {String} conversationId conversationId
|
|
15778
|
+
* @param {Object} body SetRecordingState
|
|
15779
|
+
*/
|
|
15780
|
+
putConversationsCobrowsesessionRecordingstate(conversationId, body) {
|
|
15781
|
+
// verify the required parameter 'conversationId' is set
|
|
15782
|
+
if (conversationId === undefined || conversationId === null) {
|
|
15783
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationsCobrowsesessionRecordingstate';
|
|
15784
|
+
}
|
|
15785
|
+
// verify the required parameter 'body' is set
|
|
15786
|
+
if (body === undefined || body === null) {
|
|
15787
|
+
throw 'Missing the required parameter "body" when calling putConversationsCobrowsesessionRecordingstate';
|
|
15788
|
+
}
|
|
15789
|
+
|
|
15790
|
+
return this.apiClient.callApi(
|
|
15791
|
+
'/api/v2/conversations/cobrowsesessions/{conversationId}/recordingstate',
|
|
15792
|
+
'PUT',
|
|
15793
|
+
{ 'conversationId': conversationId },
|
|
15794
|
+
{ },
|
|
15795
|
+
{ },
|
|
15796
|
+
{ },
|
|
15797
|
+
body,
|
|
15798
|
+
['PureCloud OAuth'],
|
|
15799
|
+
['application/json'],
|
|
15800
|
+
['application/json']
|
|
15801
|
+
);
|
|
15802
|
+
}
|
|
15803
|
+
|
|
15681
15804
|
/**
|
|
15682
15805
|
* Update conversation draft reply
|
|
15683
15806
|
*
|
|
@@ -15708,6 +15831,66 @@ class ConversationsApi {
|
|
|
15708
15831
|
);
|
|
15709
15832
|
}
|
|
15710
15833
|
|
|
15834
|
+
/**
|
|
15835
|
+
* Update a conversation by setting its recording state
|
|
15836
|
+
*
|
|
15837
|
+
* @param {String} conversationId conversationId
|
|
15838
|
+
* @param {Object} body SetRecordingState
|
|
15839
|
+
*/
|
|
15840
|
+
putConversationsEmailRecordingstate(conversationId, body) {
|
|
15841
|
+
// verify the required parameter 'conversationId' is set
|
|
15842
|
+
if (conversationId === undefined || conversationId === null) {
|
|
15843
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationsEmailRecordingstate';
|
|
15844
|
+
}
|
|
15845
|
+
// verify the required parameter 'body' is set
|
|
15846
|
+
if (body === undefined || body === null) {
|
|
15847
|
+
throw 'Missing the required parameter "body" when calling putConversationsEmailRecordingstate';
|
|
15848
|
+
}
|
|
15849
|
+
|
|
15850
|
+
return this.apiClient.callApi(
|
|
15851
|
+
'/api/v2/conversations/emails/{conversationId}/recordingstate',
|
|
15852
|
+
'PUT',
|
|
15853
|
+
{ 'conversationId': conversationId },
|
|
15854
|
+
{ },
|
|
15855
|
+
{ },
|
|
15856
|
+
{ },
|
|
15857
|
+
body,
|
|
15858
|
+
['PureCloud OAuth'],
|
|
15859
|
+
['application/json'],
|
|
15860
|
+
['application/json']
|
|
15861
|
+
);
|
|
15862
|
+
}
|
|
15863
|
+
|
|
15864
|
+
/**
|
|
15865
|
+
* Update a conversation by setting its recording state
|
|
15866
|
+
*
|
|
15867
|
+
* @param {String} conversationId conversationId
|
|
15868
|
+
* @param {Object} body SetRecordingState
|
|
15869
|
+
*/
|
|
15870
|
+
putConversationsMessageRecordingstate(conversationId, body) {
|
|
15871
|
+
// verify the required parameter 'conversationId' is set
|
|
15872
|
+
if (conversationId === undefined || conversationId === null) {
|
|
15873
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationsMessageRecordingstate';
|
|
15874
|
+
}
|
|
15875
|
+
// verify the required parameter 'body' is set
|
|
15876
|
+
if (body === undefined || body === null) {
|
|
15877
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessageRecordingstate';
|
|
15878
|
+
}
|
|
15879
|
+
|
|
15880
|
+
return this.apiClient.callApi(
|
|
15881
|
+
'/api/v2/conversations/messages/{conversationId}/recordingstate',
|
|
15882
|
+
'PUT',
|
|
15883
|
+
{ 'conversationId': conversationId },
|
|
15884
|
+
{ },
|
|
15885
|
+
{ },
|
|
15886
|
+
{ },
|
|
15887
|
+
body,
|
|
15888
|
+
['PureCloud OAuth'],
|
|
15889
|
+
['application/json'],
|
|
15890
|
+
['application/json']
|
|
15891
|
+
);
|
|
15892
|
+
}
|
|
15893
|
+
|
|
15711
15894
|
/**
|
|
15712
15895
|
* Update a LINE messenger integration
|
|
15713
15896
|
*
|
|
@@ -15788,13 +15971,103 @@ class ConversationsApi {
|
|
|
15788
15971
|
);
|
|
15789
15972
|
}
|
|
15790
15973
|
|
|
15974
|
+
/**
|
|
15975
|
+
* Update a conversation by setting its recording state
|
|
15976
|
+
*
|
|
15977
|
+
* @param {String} conversationId conversationId
|
|
15978
|
+
* @param {Object} body SetRecordingState
|
|
15979
|
+
*/
|
|
15980
|
+
putConversationsScreenshareRecordingstate(conversationId, body) {
|
|
15981
|
+
// verify the required parameter 'conversationId' is set
|
|
15982
|
+
if (conversationId === undefined || conversationId === null) {
|
|
15983
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationsScreenshareRecordingstate';
|
|
15984
|
+
}
|
|
15985
|
+
// verify the required parameter 'body' is set
|
|
15986
|
+
if (body === undefined || body === null) {
|
|
15987
|
+
throw 'Missing the required parameter "body" when calling putConversationsScreenshareRecordingstate';
|
|
15988
|
+
}
|
|
15989
|
+
|
|
15990
|
+
return this.apiClient.callApi(
|
|
15991
|
+
'/api/v2/conversations/screenshares/{conversationId}/recordingstate',
|
|
15992
|
+
'PUT',
|
|
15993
|
+
{ 'conversationId': conversationId },
|
|
15994
|
+
{ },
|
|
15995
|
+
{ },
|
|
15996
|
+
{ },
|
|
15997
|
+
body,
|
|
15998
|
+
['PureCloud OAuth'],
|
|
15999
|
+
['application/json'],
|
|
16000
|
+
['application/json']
|
|
16001
|
+
);
|
|
16002
|
+
}
|
|
16003
|
+
|
|
16004
|
+
/**
|
|
16005
|
+
* Update a conversation by setting its recording state
|
|
16006
|
+
*
|
|
16007
|
+
* @param {String} conversationId conversationId
|
|
16008
|
+
* @param {Object} body SetRecordingState
|
|
16009
|
+
*/
|
|
16010
|
+
putConversationsSocialRecordingstate(conversationId, body) {
|
|
16011
|
+
// verify the required parameter 'conversationId' is set
|
|
16012
|
+
if (conversationId === undefined || conversationId === null) {
|
|
16013
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationsSocialRecordingstate';
|
|
16014
|
+
}
|
|
16015
|
+
// verify the required parameter 'body' is set
|
|
16016
|
+
if (body === undefined || body === null) {
|
|
16017
|
+
throw 'Missing the required parameter "body" when calling putConversationsSocialRecordingstate';
|
|
16018
|
+
}
|
|
16019
|
+
|
|
16020
|
+
return this.apiClient.callApi(
|
|
16021
|
+
'/api/v2/conversations/socials/{conversationId}/recordingstate',
|
|
16022
|
+
'PUT',
|
|
16023
|
+
{ 'conversationId': conversationId },
|
|
16024
|
+
{ },
|
|
16025
|
+
{ },
|
|
16026
|
+
{ },
|
|
16027
|
+
body,
|
|
16028
|
+
['PureCloud OAuth'],
|
|
16029
|
+
['application/json'],
|
|
16030
|
+
['application/json']
|
|
16031
|
+
);
|
|
16032
|
+
}
|
|
16033
|
+
|
|
16034
|
+
/**
|
|
16035
|
+
* Update a conversation by setting its recording state
|
|
16036
|
+
*
|
|
16037
|
+
* @param {String} conversationId conversationId
|
|
16038
|
+
* @param {Object} body SetRecordingState
|
|
16039
|
+
*/
|
|
16040
|
+
putConversationsVideoRecordingstate(conversationId, body) {
|
|
16041
|
+
// verify the required parameter 'conversationId' is set
|
|
16042
|
+
if (conversationId === undefined || conversationId === null) {
|
|
16043
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationsVideoRecordingstate';
|
|
16044
|
+
}
|
|
16045
|
+
// verify the required parameter 'body' is set
|
|
16046
|
+
if (body === undefined || body === null) {
|
|
16047
|
+
throw 'Missing the required parameter "body" when calling putConversationsVideoRecordingstate';
|
|
16048
|
+
}
|
|
16049
|
+
|
|
16050
|
+
return this.apiClient.callApi(
|
|
16051
|
+
'/api/v2/conversations/videos/{conversationId}/recordingstate',
|
|
16052
|
+
'PUT',
|
|
16053
|
+
{ 'conversationId': conversationId },
|
|
16054
|
+
{ },
|
|
16055
|
+
{ },
|
|
16056
|
+
{ },
|
|
16057
|
+
body,
|
|
16058
|
+
['PureCloud OAuth'],
|
|
16059
|
+
['application/json'],
|
|
16060
|
+
['application/json']
|
|
16061
|
+
);
|
|
16062
|
+
}
|
|
16063
|
+
|
|
15791
16064
|
}
|
|
15792
16065
|
|
|
15793
16066
|
class DataExtensionsApi {
|
|
15794
16067
|
/**
|
|
15795
16068
|
* DataExtensions service.
|
|
15796
16069
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
15797
|
-
* @version
|
|
16070
|
+
* @version 140.0.1
|
|
15798
16071
|
*/
|
|
15799
16072
|
|
|
15800
16073
|
/**
|
|
@@ -15880,7 +16153,7 @@ class ExternalContactsApi {
|
|
|
15880
16153
|
/**
|
|
15881
16154
|
* ExternalContacts service.
|
|
15882
16155
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
15883
|
-
* @version
|
|
16156
|
+
* @version 140.0.1
|
|
15884
16157
|
*/
|
|
15885
16158
|
|
|
15886
16159
|
/**
|
|
@@ -17623,7 +17896,7 @@ class FaxApi {
|
|
|
17623
17896
|
/**
|
|
17624
17897
|
* Fax service.
|
|
17625
17898
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
17626
|
-
* @version
|
|
17899
|
+
* @version 140.0.1
|
|
17627
17900
|
*/
|
|
17628
17901
|
|
|
17629
17902
|
/**
|
|
@@ -17794,7 +18067,7 @@ class FlowsApi {
|
|
|
17794
18067
|
/**
|
|
17795
18068
|
* Flows service.
|
|
17796
18069
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
17797
|
-
* @version
|
|
18070
|
+
* @version 140.0.1
|
|
17798
18071
|
*/
|
|
17799
18072
|
|
|
17800
18073
|
/**
|
|
@@ -17865,7 +18138,7 @@ class GamificationApi {
|
|
|
17865
18138
|
/**
|
|
17866
18139
|
* Gamification service.
|
|
17867
18140
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
17868
|
-
* @version
|
|
18141
|
+
* @version 140.0.1
|
|
17869
18142
|
*/
|
|
17870
18143
|
|
|
17871
18144
|
/**
|
|
@@ -18010,7 +18283,7 @@ class GamificationApi {
|
|
|
18010
18283
|
|
|
18011
18284
|
/**
|
|
18012
18285
|
* Gamified metric by id
|
|
18013
|
-
*
|
|
18286
|
+
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
|
|
18014
18287
|
* @param {String} metricId metric Id
|
|
18015
18288
|
* @param {Object} opts Optional parameters
|
|
18016
18289
|
* @param {String} opts.workday The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
@@ -18085,7 +18358,7 @@ class GamificationApi {
|
|
|
18085
18358
|
|
|
18086
18359
|
/**
|
|
18087
18360
|
* All gamified metrics for a given profile
|
|
18088
|
-
*
|
|
18361
|
+
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
|
|
18089
18362
|
* @param {Object} opts Optional parameters
|
|
18090
18363
|
* @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
|
|
18091
18364
|
* @param {String} opts.workday The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
@@ -18136,18 +18409,18 @@ class GamificationApi {
|
|
|
18136
18409
|
/**
|
|
18137
18410
|
* Members of a given performance profile
|
|
18138
18411
|
*
|
|
18139
|
-
* @param {String}
|
|
18412
|
+
* @param {String} profileId Profile Id
|
|
18140
18413
|
*/
|
|
18141
|
-
getGamificationProfileMembers(
|
|
18142
|
-
// verify the required parameter '
|
|
18143
|
-
if (
|
|
18144
|
-
throw 'Missing the required parameter "
|
|
18414
|
+
getGamificationProfileMembers(profileId) {
|
|
18415
|
+
// verify the required parameter 'profileId' is set
|
|
18416
|
+
if (profileId === undefined || profileId === null) {
|
|
18417
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationProfileMembers';
|
|
18145
18418
|
}
|
|
18146
18419
|
|
|
18147
18420
|
return this.apiClient.callApi(
|
|
18148
|
-
'/api/v2/gamification/profiles/{
|
|
18421
|
+
'/api/v2/gamification/profiles/{profileId}/members',
|
|
18149
18422
|
'GET',
|
|
18150
|
-
{ '
|
|
18423
|
+
{ 'profileId': profileId },
|
|
18151
18424
|
{ },
|
|
18152
18425
|
{ },
|
|
18153
18426
|
{ },
|
|
@@ -18199,6 +18472,7 @@ class GamificationApi {
|
|
|
18199
18472
|
* @param {Object} opts Optional parameters
|
|
18200
18473
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
18201
18474
|
* @param {String} opts.workday The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
18475
|
+
* @param {String} opts.metricIds List of metric ids to filter the response (Optional, comma-separated).
|
|
18202
18476
|
*/
|
|
18203
18477
|
getGamificationProfileMetrics(profileId, opts) {
|
|
18204
18478
|
opts = opts || {};
|
|
@@ -18212,7 +18486,7 @@ class GamificationApi {
|
|
|
18212
18486
|
'/api/v2/gamification/profiles/{profileId}/metrics',
|
|
18213
18487
|
'GET',
|
|
18214
18488
|
{ 'profileId': profileId },
|
|
18215
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'workday': opts['workday'] },
|
|
18489
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'workday': opts['workday'],'metricIds': opts['metricIds'] },
|
|
18216
18490
|
{ },
|
|
18217
18491
|
{ },
|
|
18218
18492
|
null,
|
|
@@ -18939,7 +19213,7 @@ class GamificationApi {
|
|
|
18939
19213
|
|
|
18940
19214
|
/**
|
|
18941
19215
|
* Creates a gamified metric with a given metric definition and metric objective
|
|
18942
|
-
*
|
|
19216
|
+
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
|
|
18943
19217
|
* @param {Object} body Metric
|
|
18944
19218
|
*/
|
|
18945
19219
|
postGamificationMetrics(body) {
|
|
@@ -19015,13 +19289,13 @@ class GamificationApi {
|
|
|
19015
19289
|
/**
|
|
19016
19290
|
* Assign members to a given performance profile
|
|
19017
19291
|
*
|
|
19018
|
-
* @param {String}
|
|
19292
|
+
* @param {String} profileId Profile Id
|
|
19019
19293
|
* @param {Object} body assignUsers
|
|
19020
19294
|
*/
|
|
19021
|
-
postGamificationProfileMembers(
|
|
19022
|
-
// verify the required parameter '
|
|
19023
|
-
if (
|
|
19024
|
-
throw 'Missing the required parameter "
|
|
19295
|
+
postGamificationProfileMembers(profileId, body) {
|
|
19296
|
+
// verify the required parameter 'profileId' is set
|
|
19297
|
+
if (profileId === undefined || profileId === null) {
|
|
19298
|
+
throw 'Missing the required parameter "profileId" when calling postGamificationProfileMembers';
|
|
19025
19299
|
}
|
|
19026
19300
|
// verify the required parameter 'body' is set
|
|
19027
19301
|
if (body === undefined || body === null) {
|
|
@@ -19029,9 +19303,9 @@ class GamificationApi {
|
|
|
19029
19303
|
}
|
|
19030
19304
|
|
|
19031
19305
|
return this.apiClient.callApi(
|
|
19032
|
-
'/api/v2/gamification/profiles/{
|
|
19306
|
+
'/api/v2/gamification/profiles/{profileId}/members',
|
|
19033
19307
|
'POST',
|
|
19034
|
-
{ '
|
|
19308
|
+
{ 'profileId': profileId },
|
|
19035
19309
|
{ },
|
|
19036
19310
|
{ },
|
|
19037
19311
|
{ },
|
|
@@ -19045,13 +19319,13 @@ class GamificationApi {
|
|
|
19045
19319
|
/**
|
|
19046
19320
|
* Validate member assignment
|
|
19047
19321
|
*
|
|
19048
|
-
* @param {String}
|
|
19322
|
+
* @param {String} profileId Profile Id
|
|
19049
19323
|
* @param {Object} body memberAssignments
|
|
19050
19324
|
*/
|
|
19051
|
-
postGamificationProfileMembersValidate(
|
|
19052
|
-
// verify the required parameter '
|
|
19053
|
-
if (
|
|
19054
|
-
throw 'Missing the required parameter "
|
|
19325
|
+
postGamificationProfileMembersValidate(profileId, body) {
|
|
19326
|
+
// verify the required parameter 'profileId' is set
|
|
19327
|
+
if (profileId === undefined || profileId === null) {
|
|
19328
|
+
throw 'Missing the required parameter "profileId" when calling postGamificationProfileMembersValidate';
|
|
19055
19329
|
}
|
|
19056
19330
|
// verify the required parameter 'body' is set
|
|
19057
19331
|
if (body === undefined || body === null) {
|
|
@@ -19059,9 +19333,9 @@ class GamificationApi {
|
|
|
19059
19333
|
}
|
|
19060
19334
|
|
|
19061
19335
|
return this.apiClient.callApi(
|
|
19062
|
-
'/api/v2/gamification/profiles/{
|
|
19336
|
+
'/api/v2/gamification/profiles/{profileId}/members/validate',
|
|
19063
19337
|
'POST',
|
|
19064
|
-
{ '
|
|
19338
|
+
{ 'profileId': profileId },
|
|
19065
19339
|
{ },
|
|
19066
19340
|
{ },
|
|
19067
19341
|
{ },
|
|
@@ -19168,7 +19442,7 @@ class GamificationApi {
|
|
|
19168
19442
|
|
|
19169
19443
|
/**
|
|
19170
19444
|
* Updates a metric
|
|
19171
|
-
*
|
|
19445
|
+
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
|
|
19172
19446
|
* @param {String} metricId metric Id
|
|
19173
19447
|
* @param {Object} body Metric
|
|
19174
19448
|
* @param {Object} opts Optional parameters
|
|
@@ -19295,7 +19569,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
19295
19569
|
/**
|
|
19296
19570
|
* GeneralDataProtectionRegulation service.
|
|
19297
19571
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
19298
|
-
* @version
|
|
19572
|
+
* @version 140.0.1
|
|
19299
19573
|
*/
|
|
19300
19574
|
|
|
19301
19575
|
/**
|
|
@@ -19425,7 +19699,7 @@ class GeolocationApi {
|
|
|
19425
19699
|
/**
|
|
19426
19700
|
* Geolocation service.
|
|
19427
19701
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
19428
|
-
* @version
|
|
19702
|
+
* @version 140.0.1
|
|
19429
19703
|
*/
|
|
19430
19704
|
|
|
19431
19705
|
/**
|
|
@@ -19556,7 +19830,7 @@ class GreetingsApi {
|
|
|
19556
19830
|
/**
|
|
19557
19831
|
* Greetings service.
|
|
19558
19832
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
19559
|
-
* @version
|
|
19833
|
+
* @version 140.0.1
|
|
19560
19834
|
*/
|
|
19561
19835
|
|
|
19562
19836
|
/**
|
|
@@ -20011,7 +20285,7 @@ class GroupsApi {
|
|
|
20011
20285
|
/**
|
|
20012
20286
|
* Groups service.
|
|
20013
20287
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
20014
|
-
* @version
|
|
20288
|
+
* @version 140.0.1
|
|
20015
20289
|
*/
|
|
20016
20290
|
|
|
20017
20291
|
/**
|
|
@@ -20416,7 +20690,7 @@ class IdentityProviderApi {
|
|
|
20416
20690
|
/**
|
|
20417
20691
|
* IdentityProvider service.
|
|
20418
20692
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
20419
|
-
* @version
|
|
20693
|
+
* @version 140.0.1
|
|
20420
20694
|
*/
|
|
20421
20695
|
|
|
20422
20696
|
/**
|
|
@@ -21172,7 +21446,7 @@ class IntegrationsApi {
|
|
|
21172
21446
|
/**
|
|
21173
21447
|
* Integrations service.
|
|
21174
21448
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
21175
|
-
* @version
|
|
21449
|
+
* @version 140.0.1
|
|
21176
21450
|
*/
|
|
21177
21451
|
|
|
21178
21452
|
/**
|
|
@@ -22849,7 +23123,7 @@ class JourneyApi {
|
|
|
22849
23123
|
/**
|
|
22850
23124
|
* Journey service.
|
|
22851
23125
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
22852
|
-
* @version
|
|
23126
|
+
* @version 140.0.1
|
|
22853
23127
|
*/
|
|
22854
23128
|
|
|
22855
23129
|
/**
|
|
@@ -23560,7 +23834,7 @@ class KnowledgeApi {
|
|
|
23560
23834
|
/**
|
|
23561
23835
|
* Knowledge service.
|
|
23562
23836
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
23563
|
-
* @version
|
|
23837
|
+
* @version 140.0.1
|
|
23564
23838
|
*/
|
|
23565
23839
|
|
|
23566
23840
|
/**
|
|
@@ -23738,7 +24012,7 @@ class KnowledgeApi {
|
|
|
23738
24012
|
* @param {Object} opts Optional parameters
|
|
23739
24013
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
23740
24014
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23741
|
-
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
24015
|
+
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
23742
24016
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23743
24017
|
* @param {String} opts.name Filter to return the categories that starts with the given category name.
|
|
23744
24018
|
*/
|
|
@@ -23846,7 +24120,7 @@ class KnowledgeApi {
|
|
|
23846
24120
|
* @param {Object} opts Optional parameters
|
|
23847
24121
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
23848
24122
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23849
|
-
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
24123
|
+
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
23850
24124
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23851
24125
|
* @param {String} opts.categories Filter by categories ids, comma separated values expected.
|
|
23852
24126
|
* @param {String} opts.title Filter by document title.
|
|
@@ -23958,7 +24232,7 @@ class KnowledgeApi {
|
|
|
23958
24232
|
* @param {Object} opts Optional parameters
|
|
23959
24233
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
23960
24234
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23961
|
-
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
24235
|
+
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
23962
24236
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23963
24237
|
* @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
|
|
23964
24238
|
*/
|
|
@@ -23994,7 +24268,7 @@ class KnowledgeApi {
|
|
|
23994
24268
|
* @param {Object} opts Optional parameters
|
|
23995
24269
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
23996
24270
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
23997
|
-
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
24271
|
+
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
23998
24272
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
23999
24273
|
* @param {String} opts.name Filter by Name.
|
|
24000
24274
|
* @param {Object} opts.coreLanguage Filter by core language.
|
|
@@ -24460,7 +24734,7 @@ class LanguageUnderstandingApi {
|
|
|
24460
24734
|
/**
|
|
24461
24735
|
* LanguageUnderstanding service.
|
|
24462
24736
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
24463
|
-
* @version
|
|
24737
|
+
* @version 140.0.1
|
|
24464
24738
|
*/
|
|
24465
24739
|
|
|
24466
24740
|
/**
|
|
@@ -25364,7 +25638,7 @@ class LanguagesApi {
|
|
|
25364
25638
|
/**
|
|
25365
25639
|
* Languages service.
|
|
25366
25640
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
25367
|
-
* @version
|
|
25641
|
+
* @version 140.0.1
|
|
25368
25642
|
*/
|
|
25369
25643
|
|
|
25370
25644
|
/**
|
|
@@ -25632,7 +25906,7 @@ class LearningApi {
|
|
|
25632
25906
|
/**
|
|
25633
25907
|
* Learning service.
|
|
25634
25908
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
25635
|
-
* @version
|
|
25909
|
+
* @version 140.0.1
|
|
25636
25910
|
*/
|
|
25637
25911
|
|
|
25638
25912
|
/**
|
|
@@ -25830,6 +26104,36 @@ class LearningApi {
|
|
|
25830
26104
|
);
|
|
25831
26105
|
}
|
|
25832
26106
|
|
|
26107
|
+
/**
|
|
26108
|
+
* Get a specific Learning Module job status
|
|
26109
|
+
*
|
|
26110
|
+
* @param {String} moduleId The ID of the learning module
|
|
26111
|
+
* @param {String} jobId The ID of the learning module job
|
|
26112
|
+
*/
|
|
26113
|
+
getLearningModuleJob(moduleId, jobId) {
|
|
26114
|
+
// verify the required parameter 'moduleId' is set
|
|
26115
|
+
if (moduleId === undefined || moduleId === null) {
|
|
26116
|
+
throw 'Missing the required parameter "moduleId" when calling getLearningModuleJob';
|
|
26117
|
+
}
|
|
26118
|
+
// verify the required parameter 'jobId' is set
|
|
26119
|
+
if (jobId === undefined || jobId === null) {
|
|
26120
|
+
throw 'Missing the required parameter "jobId" when calling getLearningModuleJob';
|
|
26121
|
+
}
|
|
26122
|
+
|
|
26123
|
+
return this.apiClient.callApi(
|
|
26124
|
+
'/api/v2/learning/modules/{moduleId}/jobs/{jobId}',
|
|
26125
|
+
'GET',
|
|
26126
|
+
{ 'moduleId': moduleId,'jobId': jobId },
|
|
26127
|
+
{ },
|
|
26128
|
+
{ },
|
|
26129
|
+
{ },
|
|
26130
|
+
null,
|
|
26131
|
+
['PureCloud OAuth'],
|
|
26132
|
+
['application/json'],
|
|
26133
|
+
['application/json']
|
|
26134
|
+
);
|
|
26135
|
+
}
|
|
26136
|
+
|
|
25833
26137
|
/**
|
|
25834
26138
|
* Get a learning module rule
|
|
25835
26139
|
*
|
|
@@ -25975,6 +26279,56 @@ class LearningApi {
|
|
|
25975
26279
|
);
|
|
25976
26280
|
}
|
|
25977
26281
|
|
|
26282
|
+
/**
|
|
26283
|
+
* Reassign Learning Assignment
|
|
26284
|
+
* This will reassign the state of the assignment to Assigned and update the assignment to the latest version of the module
|
|
26285
|
+
* @param {String} assignmentId The Learning Assignment ID
|
|
26286
|
+
*/
|
|
26287
|
+
postLearningAssignmentReassign(assignmentId) {
|
|
26288
|
+
// verify the required parameter 'assignmentId' is set
|
|
26289
|
+
if (assignmentId === undefined || assignmentId === null) {
|
|
26290
|
+
throw 'Missing the required parameter "assignmentId" when calling postLearningAssignmentReassign';
|
|
26291
|
+
}
|
|
26292
|
+
|
|
26293
|
+
return this.apiClient.callApi(
|
|
26294
|
+
'/api/v2/learning/assignments/{assignmentId}/reassign',
|
|
26295
|
+
'POST',
|
|
26296
|
+
{ 'assignmentId': assignmentId },
|
|
26297
|
+
{ },
|
|
26298
|
+
{ },
|
|
26299
|
+
{ },
|
|
26300
|
+
null,
|
|
26301
|
+
['PureCloud OAuth'],
|
|
26302
|
+
['application/json'],
|
|
26303
|
+
['application/json']
|
|
26304
|
+
);
|
|
26305
|
+
}
|
|
26306
|
+
|
|
26307
|
+
/**
|
|
26308
|
+
* Reset Learning Assignment
|
|
26309
|
+
* This will reset the state of the assignment to Assigned and remove the version of Learning module associated with the assignment
|
|
26310
|
+
* @param {String} assignmentId The Learning Assignment ID
|
|
26311
|
+
*/
|
|
26312
|
+
postLearningAssignmentReset(assignmentId) {
|
|
26313
|
+
// verify the required parameter 'assignmentId' is set
|
|
26314
|
+
if (assignmentId === undefined || assignmentId === null) {
|
|
26315
|
+
throw 'Missing the required parameter "assignmentId" when calling postLearningAssignmentReset';
|
|
26316
|
+
}
|
|
26317
|
+
|
|
26318
|
+
return this.apiClient.callApi(
|
|
26319
|
+
'/api/v2/learning/assignments/{assignmentId}/reset',
|
|
26320
|
+
'POST',
|
|
26321
|
+
{ 'assignmentId': assignmentId },
|
|
26322
|
+
{ },
|
|
26323
|
+
{ },
|
|
26324
|
+
{ },
|
|
26325
|
+
null,
|
|
26326
|
+
['PureCloud OAuth'],
|
|
26327
|
+
['application/json'],
|
|
26328
|
+
['application/json']
|
|
26329
|
+
);
|
|
26330
|
+
}
|
|
26331
|
+
|
|
25978
26332
|
/**
|
|
25979
26333
|
* Create Learning Assignment
|
|
25980
26334
|
*
|
|
@@ -26072,6 +26426,36 @@ class LearningApi {
|
|
|
26072
26426
|
);
|
|
26073
26427
|
}
|
|
26074
26428
|
|
|
26429
|
+
/**
|
|
26430
|
+
* Starts a specified operation on learning module
|
|
26431
|
+
* This will initiate operation specified in the request body for a learning module
|
|
26432
|
+
* @param {String} moduleId The ID of the learning module
|
|
26433
|
+
* @param {Object} body The learning module job request
|
|
26434
|
+
*/
|
|
26435
|
+
postLearningModuleJobs(moduleId, body) {
|
|
26436
|
+
// verify the required parameter 'moduleId' is set
|
|
26437
|
+
if (moduleId === undefined || moduleId === null) {
|
|
26438
|
+
throw 'Missing the required parameter "moduleId" when calling postLearningModuleJobs';
|
|
26439
|
+
}
|
|
26440
|
+
// verify the required parameter 'body' is set
|
|
26441
|
+
if (body === undefined || body === null) {
|
|
26442
|
+
throw 'Missing the required parameter "body" when calling postLearningModuleJobs';
|
|
26443
|
+
}
|
|
26444
|
+
|
|
26445
|
+
return this.apiClient.callApi(
|
|
26446
|
+
'/api/v2/learning/modules/{moduleId}/jobs',
|
|
26447
|
+
'POST',
|
|
26448
|
+
{ 'moduleId': moduleId },
|
|
26449
|
+
{ },
|
|
26450
|
+
{ },
|
|
26451
|
+
{ },
|
|
26452
|
+
body,
|
|
26453
|
+
['PureCloud OAuth'],
|
|
26454
|
+
['application/json'],
|
|
26455
|
+
['application/json']
|
|
26456
|
+
);
|
|
26457
|
+
}
|
|
26458
|
+
|
|
26075
26459
|
/**
|
|
26076
26460
|
* Publish a Learning module
|
|
26077
26461
|
*
|
|
@@ -26223,7 +26607,7 @@ class LicenseApi {
|
|
|
26223
26607
|
/**
|
|
26224
26608
|
* License service.
|
|
26225
26609
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
26226
|
-
* @version
|
|
26610
|
+
* @version 140.0.1
|
|
26227
26611
|
*/
|
|
26228
26612
|
|
|
26229
26613
|
/**
|
|
@@ -26461,7 +26845,7 @@ class LocationsApi {
|
|
|
26461
26845
|
/**
|
|
26462
26846
|
* Locations service.
|
|
26463
26847
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
26464
|
-
* @version
|
|
26848
|
+
* @version 140.0.1
|
|
26465
26849
|
*/
|
|
26466
26850
|
|
|
26467
26851
|
/**
|
|
@@ -26697,7 +27081,7 @@ class MessagingApi {
|
|
|
26697
27081
|
/**
|
|
26698
27082
|
* Messaging service.
|
|
26699
27083
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
26700
|
-
* @version
|
|
27084
|
+
* @version 140.0.1
|
|
26701
27085
|
*/
|
|
26702
27086
|
|
|
26703
27087
|
/**
|
|
@@ -26848,7 +27232,7 @@ class MobileDevicesApi {
|
|
|
26848
27232
|
/**
|
|
26849
27233
|
* MobileDevices service.
|
|
26850
27234
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
26851
|
-
* @version
|
|
27235
|
+
* @version 140.0.1
|
|
26852
27236
|
*/
|
|
26853
27237
|
|
|
26854
27238
|
/**
|
|
@@ -26999,7 +27383,7 @@ class NotificationsApi {
|
|
|
26999
27383
|
/**
|
|
27000
27384
|
* Notifications service.
|
|
27001
27385
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
27002
|
-
* @version
|
|
27386
|
+
* @version 140.0.1
|
|
27003
27387
|
*/
|
|
27004
27388
|
|
|
27005
27389
|
/**
|
|
@@ -27224,7 +27608,7 @@ class OAuthApi {
|
|
|
27224
27608
|
/**
|
|
27225
27609
|
* OAuth service.
|
|
27226
27610
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
27227
|
-
* @version
|
|
27611
|
+
* @version 140.0.1
|
|
27228
27612
|
*/
|
|
27229
27613
|
|
|
27230
27614
|
/**
|
|
@@ -27590,7 +27974,7 @@ class ObjectsApi {
|
|
|
27590
27974
|
/**
|
|
27591
27975
|
* Objects service.
|
|
27592
27976
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
27593
|
-
* @version
|
|
27977
|
+
* @version 140.0.1
|
|
27594
27978
|
*/
|
|
27595
27979
|
|
|
27596
27980
|
/**
|
|
@@ -27861,7 +28245,7 @@ class OrganizationApi {
|
|
|
27861
28245
|
/**
|
|
27862
28246
|
* Organization service.
|
|
27863
28247
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
27864
|
-
* @version
|
|
28248
|
+
* @version 140.0.1
|
|
27865
28249
|
*/
|
|
27866
28250
|
|
|
27867
28251
|
/**
|
|
@@ -28264,7 +28648,7 @@ class OrganizationAuthorizationApi {
|
|
|
28264
28648
|
/**
|
|
28265
28649
|
* OrganizationAuthorization service.
|
|
28266
28650
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
28267
|
-
* @version
|
|
28651
|
+
* @version 140.0.1
|
|
28268
28652
|
*/
|
|
28269
28653
|
|
|
28270
28654
|
/**
|
|
@@ -29189,7 +29573,7 @@ class OutboundApi {
|
|
|
29189
29573
|
/**
|
|
29190
29574
|
* Outbound service.
|
|
29191
29575
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
29192
|
-
* @version
|
|
29576
|
+
* @version 140.0.1
|
|
29193
29577
|
*/
|
|
29194
29578
|
|
|
29195
29579
|
/**
|
|
@@ -32444,7 +32828,7 @@ class PresenceApi {
|
|
|
32444
32828
|
/**
|
|
32445
32829
|
* Presence service.
|
|
32446
32830
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
32447
|
-
* @version
|
|
32831
|
+
* @version 140.0.1
|
|
32448
32832
|
*/
|
|
32449
32833
|
|
|
32450
32834
|
/**
|
|
@@ -32766,7 +33150,7 @@ class QualityApi {
|
|
|
32766
33150
|
/**
|
|
32767
33151
|
* Quality service.
|
|
32768
33152
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
32769
|
-
* @version
|
|
33153
|
+
* @version 140.0.1
|
|
32770
33154
|
*/
|
|
32771
33155
|
|
|
32772
33156
|
/**
|
|
@@ -33524,7 +33908,7 @@ class QualityApi {
|
|
|
33524
33908
|
/**
|
|
33525
33909
|
* Retrieve a list of the latest form versions by context ids
|
|
33526
33910
|
*
|
|
33527
|
-
* @param {Array.<String>} contextId A comma-delimited list of valid survey form context ids
|
|
33911
|
+
* @param {Array.<String>} contextId A comma-delimited list of valid survey form context ids. The maximum number of ids allowed in this list is 100.
|
|
33528
33912
|
* @param {Object} opts Optional parameters
|
|
33529
33913
|
* @param {Boolean} opts.published If true, the latest published version will be included. If false, only the unpublished version will be included. (default to true)
|
|
33530
33914
|
*/
|
|
@@ -34344,7 +34728,7 @@ class RecordingApi {
|
|
|
34344
34728
|
/**
|
|
34345
34729
|
* Recording service.
|
|
34346
34730
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
34347
|
-
* @version
|
|
34731
|
+
* @version 140.0.1
|
|
34348
34732
|
*/
|
|
34349
34733
|
|
|
34350
34734
|
/**
|
|
@@ -35997,7 +36381,7 @@ class ResponseManagementApi {
|
|
|
35997
36381
|
/**
|
|
35998
36382
|
* ResponseManagement service.
|
|
35999
36383
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
36000
|
-
* @version
|
|
36384
|
+
* @version 140.0.1
|
|
36001
36385
|
*/
|
|
36002
36386
|
|
|
36003
36387
|
/**
|
|
@@ -36481,7 +36865,7 @@ class RoutingApi {
|
|
|
36481
36865
|
/**
|
|
36482
36866
|
* Routing service.
|
|
36483
36867
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
36484
|
-
* @version
|
|
36868
|
+
* @version 140.0.1
|
|
36485
36869
|
*/
|
|
36486
36870
|
|
|
36487
36871
|
/**
|
|
@@ -36794,12 +37178,8 @@ class RoutingApi {
|
|
|
36794
37178
|
* Delete a phone number provisioned for SMS.
|
|
36795
37179
|
*
|
|
36796
37180
|
* @param {String} addressId Address ID
|
|
36797
|
-
* @param {Object} opts Optional parameters
|
|
36798
|
-
* @param {Boolean} opts.async Delete a phone number for SMS in an asynchronous manner. If the async parameter value is true, this initiates the deletion of a provisioned phone number. (default to false)
|
|
36799
37181
|
*/
|
|
36800
|
-
deleteRoutingSmsPhonenumber(addressId
|
|
36801
|
-
opts = opts || {};
|
|
36802
|
-
|
|
37182
|
+
deleteRoutingSmsPhonenumber(addressId) {
|
|
36803
37183
|
// verify the required parameter 'addressId' is set
|
|
36804
37184
|
if (addressId === undefined || addressId === null) {
|
|
36805
37185
|
throw 'Missing the required parameter "addressId" when calling deleteRoutingSmsPhonenumber';
|
|
@@ -36809,7 +37189,7 @@ class RoutingApi {
|
|
|
36809
37189
|
'/api/v2/routing/sms/phonenumbers/{addressId}',
|
|
36810
37190
|
'DELETE',
|
|
36811
37191
|
{ 'addressId': addressId },
|
|
36812
|
-
{
|
|
37192
|
+
{ },
|
|
36813
37193
|
{ },
|
|
36814
37194
|
{ },
|
|
36815
37195
|
null,
|
|
@@ -36980,7 +37360,7 @@ class RoutingApi {
|
|
|
36980
37360
|
* @param {Object} opts Optional parameters
|
|
36981
37361
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
36982
37362
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
36983
|
-
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
37363
|
+
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
36984
37364
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
36985
37365
|
* @param {Array.<String>} opts.queueId Queue ID(s) to filter assessments by.
|
|
36986
37366
|
*/
|
|
@@ -37291,7 +37671,7 @@ class RoutingApi {
|
|
|
37291
37671
|
* @param {Object} opts Optional parameters
|
|
37292
37672
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
37293
37673
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
37294
|
-
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
37674
|
+
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
37295
37675
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
37296
37676
|
* @param {Array.<String>} opts.queueId Comma-separated list of queue Ids to filter by.
|
|
37297
37677
|
*/
|
|
@@ -37314,16 +37694,20 @@ class RoutingApi {
|
|
|
37314
37694
|
}
|
|
37315
37695
|
|
|
37316
37696
|
/**
|
|
37317
|
-
* Get a list of Key Performance Indicators
|
|
37697
|
+
* Get a list of Key Performance Indicators
|
|
37318
37698
|
*
|
|
37699
|
+
* @param {Object} opts Optional parameters
|
|
37700
|
+
* @param {Object} opts.kpiGroup The Group of Key Performance Indicators to return
|
|
37319
37701
|
*/
|
|
37320
|
-
getRoutingPredictorsKeyperformanceindicators() {
|
|
37702
|
+
getRoutingPredictorsKeyperformanceindicators(opts) {
|
|
37703
|
+
opts = opts || {};
|
|
37704
|
+
|
|
37321
37705
|
|
|
37322
37706
|
return this.apiClient.callApi(
|
|
37323
37707
|
'/api/v2/routing/predictors/keyperformanceindicators',
|
|
37324
37708
|
'GET',
|
|
37325
37709
|
{ },
|
|
37326
|
-
{
|
|
37710
|
+
{ 'kpiGroup': opts['kpiGroup'] },
|
|
37327
37711
|
{ },
|
|
37328
37712
|
{ },
|
|
37329
37713
|
null,
|
|
@@ -38963,12 +39347,8 @@ class RoutingApi {
|
|
|
38963
39347
|
* Provision a phone number for SMS
|
|
38964
39348
|
*
|
|
38965
39349
|
* @param {Object} body SmsPhoneNumber
|
|
38966
|
-
* @param {Object} opts Optional parameters
|
|
38967
|
-
* @param {Boolean} opts.async Provision a new phone number for SMS in an asynchronous manner. If the async parameter value is true, this initiates the provisioning of a new phone number. Check the phoneNumber's provisioningStatus for completion of this request. (default to false)
|
|
38968
39350
|
*/
|
|
38969
|
-
postRoutingSmsPhonenumbers(body
|
|
38970
|
-
opts = opts || {};
|
|
38971
|
-
|
|
39351
|
+
postRoutingSmsPhonenumbers(body) {
|
|
38972
39352
|
// verify the required parameter 'body' is set
|
|
38973
39353
|
if (body === undefined || body === null) {
|
|
38974
39354
|
throw 'Missing the required parameter "body" when calling postRoutingSmsPhonenumbers';
|
|
@@ -38978,7 +39358,7 @@ class RoutingApi {
|
|
|
38978
39358
|
'/api/v2/routing/sms/phonenumbers',
|
|
38979
39359
|
'POST',
|
|
38980
39360
|
{ },
|
|
38981
|
-
{
|
|
39361
|
+
{ },
|
|
38982
39362
|
{ },
|
|
38983
39363
|
{ },
|
|
38984
39364
|
body,
|
|
@@ -39223,12 +39603,8 @@ class RoutingApi {
|
|
|
39223
39603
|
*
|
|
39224
39604
|
* @param {String} addressId Address ID
|
|
39225
39605
|
* @param {Object} body SmsPhoneNumber
|
|
39226
|
-
* @param {Object} opts Optional parameters
|
|
39227
|
-
* @param {Boolean} opts.async Update an existing phone number for SMS in an asynchronous manner. If the async parameter value is true, this initiates the update of a provisioned phone number. Check the phoneNumber's provisioningStatus for the progress of this request. (default to false)
|
|
39228
39606
|
*/
|
|
39229
|
-
putRoutingSmsPhonenumber(addressId, body
|
|
39230
|
-
opts = opts || {};
|
|
39231
|
-
|
|
39607
|
+
putRoutingSmsPhonenumber(addressId, body) {
|
|
39232
39608
|
// verify the required parameter 'addressId' is set
|
|
39233
39609
|
if (addressId === undefined || addressId === null) {
|
|
39234
39610
|
throw 'Missing the required parameter "addressId" when calling putRoutingSmsPhonenumber';
|
|
@@ -39242,7 +39618,7 @@ class RoutingApi {
|
|
|
39242
39618
|
'/api/v2/routing/sms/phonenumbers/{addressId}',
|
|
39243
39619
|
'PUT',
|
|
39244
39620
|
{ 'addressId': addressId },
|
|
39245
|
-
{
|
|
39621
|
+
{ },
|
|
39246
39622
|
{ },
|
|
39247
39623
|
{ },
|
|
39248
39624
|
body,
|
|
@@ -39408,7 +39784,7 @@ class SCIMApi {
|
|
|
39408
39784
|
/**
|
|
39409
39785
|
* SCIM service.
|
|
39410
39786
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
39411
|
-
* @version
|
|
39787
|
+
* @version 140.0.1
|
|
39412
39788
|
*/
|
|
39413
39789
|
|
|
39414
39790
|
/**
|
|
@@ -40285,7 +40661,7 @@ class ScriptsApi {
|
|
|
40285
40661
|
/**
|
|
40286
40662
|
* Scripts service.
|
|
40287
40663
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
40288
|
-
* @version
|
|
40664
|
+
* @version 140.0.1
|
|
40289
40665
|
*/
|
|
40290
40666
|
|
|
40291
40667
|
/**
|
|
@@ -40704,7 +41080,7 @@ class SearchApi {
|
|
|
40704
41080
|
/**
|
|
40705
41081
|
* Search service.
|
|
40706
41082
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
40707
|
-
* @version
|
|
41083
|
+
* @version 140.0.1
|
|
40708
41084
|
*/
|
|
40709
41085
|
|
|
40710
41086
|
/**
|
|
@@ -41239,7 +41615,7 @@ class SpeechTextAnalyticsApi {
|
|
|
41239
41615
|
/**
|
|
41240
41616
|
* SpeechTextAnalytics service.
|
|
41241
41617
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
41242
|
-
* @version
|
|
41618
|
+
* @version 140.0.1
|
|
41243
41619
|
*/
|
|
41244
41620
|
|
|
41245
41621
|
/**
|
|
@@ -42092,7 +42468,7 @@ class StationsApi {
|
|
|
42092
42468
|
/**
|
|
42093
42469
|
* Stations service.
|
|
42094
42470
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
42095
|
-
* @version
|
|
42471
|
+
* @version 140.0.1
|
|
42096
42472
|
*/
|
|
42097
42473
|
|
|
42098
42474
|
/**
|
|
@@ -42239,7 +42615,7 @@ class SuggestApi {
|
|
|
42239
42615
|
/**
|
|
42240
42616
|
* Suggest service.
|
|
42241
42617
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
42242
|
-
* @version
|
|
42618
|
+
* @version 140.0.1
|
|
42243
42619
|
*/
|
|
42244
42620
|
|
|
42245
42621
|
/**
|
|
@@ -42378,7 +42754,7 @@ class TelephonyApi {
|
|
|
42378
42754
|
/**
|
|
42379
42755
|
* Telephony service.
|
|
42380
42756
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
42381
|
-
* @version
|
|
42757
|
+
* @version 140.0.1
|
|
42382
42758
|
*/
|
|
42383
42759
|
|
|
42384
42760
|
/**
|
|
@@ -42486,7 +42862,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
42486
42862
|
/**
|
|
42487
42863
|
* TelephonyProvidersEdge service.
|
|
42488
42864
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
42489
|
-
* @version
|
|
42865
|
+
* @version 140.0.1
|
|
42490
42866
|
*/
|
|
42491
42867
|
|
|
42492
42868
|
/**
|
|
@@ -46119,7 +46495,7 @@ class TextbotsApi {
|
|
|
46119
46495
|
/**
|
|
46120
46496
|
* Textbots service.
|
|
46121
46497
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
46122
|
-
* @version
|
|
46498
|
+
* @version 140.0.1
|
|
46123
46499
|
*/
|
|
46124
46500
|
|
|
46125
46501
|
/**
|
|
@@ -46247,7 +46623,7 @@ class TokensApi {
|
|
|
46247
46623
|
/**
|
|
46248
46624
|
* Tokens service.
|
|
46249
46625
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
46250
|
-
* @version
|
|
46626
|
+
* @version 140.0.1
|
|
46251
46627
|
*/
|
|
46252
46628
|
|
|
46253
46629
|
/**
|
|
@@ -46353,7 +46729,7 @@ class UploadsApi {
|
|
|
46353
46729
|
/**
|
|
46354
46730
|
* Uploads service.
|
|
46355
46731
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
46356
|
-
* @version
|
|
46732
|
+
* @version 140.0.1
|
|
46357
46733
|
*/
|
|
46358
46734
|
|
|
46359
46735
|
/**
|
|
@@ -46504,7 +46880,7 @@ class UsageApi {
|
|
|
46504
46880
|
/**
|
|
46505
46881
|
* Usage service.
|
|
46506
46882
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
46507
|
-
* @version
|
|
46883
|
+
* @version 140.0.1
|
|
46508
46884
|
*/
|
|
46509
46885
|
|
|
46510
46886
|
/**
|
|
@@ -46575,7 +46951,7 @@ class UserRecordingsApi {
|
|
|
46575
46951
|
/**
|
|
46576
46952
|
* UserRecordings service.
|
|
46577
46953
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
46578
|
-
* @version
|
|
46954
|
+
* @version 140.0.1
|
|
46579
46955
|
*/
|
|
46580
46956
|
|
|
46581
46957
|
/**
|
|
@@ -46759,7 +47135,7 @@ class UsersApi {
|
|
|
46759
47135
|
/**
|
|
46760
47136
|
* Users service.
|
|
46761
47137
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
46762
|
-
* @version
|
|
47138
|
+
* @version 140.0.1
|
|
46763
47139
|
*/
|
|
46764
47140
|
|
|
46765
47141
|
/**
|
|
@@ -47579,18 +47955,18 @@ class UsersApi {
|
|
|
47579
47955
|
/**
|
|
47580
47956
|
* Returns a listing of roles and permissions for a user.
|
|
47581
47957
|
*
|
|
47582
|
-
* @param {String}
|
|
47958
|
+
* @param {String} subjectId User ID
|
|
47583
47959
|
*/
|
|
47584
|
-
getUserRoles(
|
|
47585
|
-
// verify the required parameter '
|
|
47586
|
-
if (
|
|
47587
|
-
throw 'Missing the required parameter "
|
|
47960
|
+
getUserRoles(subjectId) {
|
|
47961
|
+
// verify the required parameter 'subjectId' is set
|
|
47962
|
+
if (subjectId === undefined || subjectId === null) {
|
|
47963
|
+
throw 'Missing the required parameter "subjectId" when calling getUserRoles';
|
|
47588
47964
|
}
|
|
47589
47965
|
|
|
47590
47966
|
return this.apiClient.callApi(
|
|
47591
|
-
'/api/v2/users/{
|
|
47967
|
+
'/api/v2/users/{subjectId}/roles',
|
|
47592
47968
|
'GET',
|
|
47593
|
-
{ '
|
|
47969
|
+
{ 'subjectId': subjectId },
|
|
47594
47970
|
{ },
|
|
47595
47971
|
{ },
|
|
47596
47972
|
{ },
|
|
@@ -48843,13 +49219,13 @@ class UsersApi {
|
|
|
48843
49219
|
/**
|
|
48844
49220
|
* Sets the user's roles
|
|
48845
49221
|
*
|
|
48846
|
-
* @param {String}
|
|
49222
|
+
* @param {String} subjectId User ID
|
|
48847
49223
|
* @param {Array.<String>} body List of roles
|
|
48848
49224
|
*/
|
|
48849
|
-
putUserRoles(
|
|
48850
|
-
// verify the required parameter '
|
|
48851
|
-
if (
|
|
48852
|
-
throw 'Missing the required parameter "
|
|
49225
|
+
putUserRoles(subjectId, body) {
|
|
49226
|
+
// verify the required parameter 'subjectId' is set
|
|
49227
|
+
if (subjectId === undefined || subjectId === null) {
|
|
49228
|
+
throw 'Missing the required parameter "subjectId" when calling putUserRoles';
|
|
48853
49229
|
}
|
|
48854
49230
|
// verify the required parameter 'body' is set
|
|
48855
49231
|
if (body === undefined || body === null) {
|
|
@@ -48857,9 +49233,9 @@ class UsersApi {
|
|
|
48857
49233
|
}
|
|
48858
49234
|
|
|
48859
49235
|
return this.apiClient.callApi(
|
|
48860
|
-
'/api/v2/users/{
|
|
49236
|
+
'/api/v2/users/{subjectId}/roles',
|
|
48861
49237
|
'PUT',
|
|
48862
|
-
{ '
|
|
49238
|
+
{ 'subjectId': subjectId },
|
|
48863
49239
|
{ },
|
|
48864
49240
|
{ },
|
|
48865
49241
|
{ },
|
|
@@ -49061,7 +49437,7 @@ class UtilitiesApi {
|
|
|
49061
49437
|
/**
|
|
49062
49438
|
* Utilities service.
|
|
49063
49439
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
49064
|
-
* @version
|
|
49440
|
+
* @version 140.0.1
|
|
49065
49441
|
*/
|
|
49066
49442
|
|
|
49067
49443
|
/**
|
|
@@ -49172,7 +49548,7 @@ class VoicemailApi {
|
|
|
49172
49548
|
/**
|
|
49173
49549
|
* Voicemail service.
|
|
49174
49550
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
49175
|
-
* @version
|
|
49551
|
+
* @version 140.0.1
|
|
49176
49552
|
*/
|
|
49177
49553
|
|
|
49178
49554
|
/**
|
|
@@ -49839,7 +50215,7 @@ class WebChatApi {
|
|
|
49839
50215
|
/**
|
|
49840
50216
|
* WebChat service.
|
|
49841
50217
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
49842
|
-
* @version
|
|
50218
|
+
* @version 140.0.1
|
|
49843
50219
|
*/
|
|
49844
50220
|
|
|
49845
50221
|
/**
|
|
@@ -50383,7 +50759,7 @@ class WebDeploymentsApi {
|
|
|
50383
50759
|
/**
|
|
50384
50760
|
* WebDeployments service.
|
|
50385
50761
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
50386
|
-
* @version
|
|
50762
|
+
* @version 140.0.1
|
|
50387
50763
|
*/
|
|
50388
50764
|
|
|
50389
50765
|
/**
|
|
@@ -50738,7 +51114,7 @@ class WebMessagingApi {
|
|
|
50738
51114
|
/**
|
|
50739
51115
|
* WebMessaging service.
|
|
50740
51116
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
50741
|
-
* @version
|
|
51117
|
+
* @version 140.0.1
|
|
50742
51118
|
*/
|
|
50743
51119
|
|
|
50744
51120
|
/**
|
|
@@ -50784,7 +51160,7 @@ class WidgetsApi {
|
|
|
50784
51160
|
/**
|
|
50785
51161
|
* Widgets service.
|
|
50786
51162
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
50787
|
-
* @version
|
|
51163
|
+
* @version 140.0.1
|
|
50788
51164
|
*/
|
|
50789
51165
|
|
|
50790
51166
|
/**
|
|
@@ -50930,7 +51306,7 @@ class WorkforceManagementApi {
|
|
|
50930
51306
|
/**
|
|
50931
51307
|
* WorkforceManagement service.
|
|
50932
51308
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
50933
|
-
* @version
|
|
51309
|
+
* @version 140.0.1
|
|
50934
51310
|
*/
|
|
50935
51311
|
|
|
50936
51312
|
/**
|
|
@@ -55181,7 +55557,7 @@ class WorkforceManagementApi {
|
|
|
55181
55557
|
* </pre>
|
|
55182
55558
|
* </p>
|
|
55183
55559
|
* @module purecloud-platform-client-v2/index
|
|
55184
|
-
* @version
|
|
55560
|
+
* @version 140.0.1
|
|
55185
55561
|
*/
|
|
55186
55562
|
class platformClient {
|
|
55187
55563
|
constructor() {
|