purecloud-platform-client-v2 139.0.0 → 141.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/node/purecloud-platform-client-v2.js +420 -116
- package/dist/web-amd/purecloud-platform-client-v2.js +420 -117
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +420 -116
- package/dist/web-cjs/purecloud-platform-client-v2.js +2514 -154
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +499 -207
- 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 +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 +156 -5
- 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 +145 -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 +11 -5
- 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
|
@@ -1,8 +1,9 @@
|
|
|
1
|
-
define(['axios'], (function (axios) { 'use strict';
|
|
1
|
+
define(['axios', 'qs'], (function (axios, qs) { 'use strict';
|
|
2
2
|
|
|
3
3
|
function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
|
|
4
4
|
|
|
5
5
|
var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
|
|
6
|
+
var qs__default = /*#__PURE__*/_interopDefaultLegacy(qs);
|
|
6
7
|
|
|
7
8
|
var PureCloudRegionHosts = {
|
|
8
9
|
us_east_1: 'mypurecloud.com',
|
|
@@ -397,7 +398,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
397
398
|
|
|
398
399
|
/**
|
|
399
400
|
* @module purecloud-platform-client-v2/ApiClient
|
|
400
|
-
* @version
|
|
401
|
+
* @version 141.0.0
|
|
401
402
|
*/
|
|
402
403
|
class ApiClient {
|
|
403
404
|
/**
|
|
@@ -432,7 +433,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
432
433
|
|
|
433
434
|
/**
|
|
434
435
|
* Enumeration of collection format separator strategies.
|
|
435
|
-
* @enum {String}
|
|
436
|
+
* @enum {String}
|
|
436
437
|
* @readonly
|
|
437
438
|
*/
|
|
438
439
|
this.CollectionFormatEnum = {
|
|
@@ -579,7 +580,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
579
580
|
// Load current auth data
|
|
580
581
|
const tempState = this.authData.state;
|
|
581
582
|
this.authData = localStorage.getItem(`${this.settingsPrefix}_auth_data`);
|
|
582
|
-
if (!this.authData)
|
|
583
|
+
if (!this.authData)
|
|
583
584
|
this.authData = {};
|
|
584
585
|
else
|
|
585
586
|
this.authData = JSON.parse(this.authData);
|
|
@@ -599,7 +600,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
599
600
|
* @description Initiates the implicit grant login flow. Will attempt to load the token from local storage, if enabled.
|
|
600
601
|
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
601
602
|
* @param {string} redirectUri - The redirect URI of the OAuth Implicit Grant client
|
|
602
|
-
* @param {object} opts - (optional) Additional options
|
|
603
|
+
* @param {object} opts - (optional) Additional options
|
|
603
604
|
* @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.
|
|
604
605
|
* @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.
|
|
605
606
|
* @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.
|
|
@@ -745,9 +746,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
745
746
|
}
|
|
746
747
|
var encodedData = Buffer.from(clientId + ':' + clientSecret).toString('base64');
|
|
747
748
|
var request = this._formAuthRequest(encodedData,
|
|
748
|
-
{ grant_type: 'urn:ietf:params:oauth:grant-type:saml2-bearer'
|
|
749
|
-
|
|
750
|
-
|
|
749
|
+
{ grant_type: 'urn:ietf:params:oauth:grant-type:saml2-bearer',
|
|
750
|
+
orgName: orgName,
|
|
751
|
+
assertion: assertion });
|
|
751
752
|
request.proxy = this.proxy;
|
|
752
753
|
var bodyParam = {
|
|
753
754
|
grant_type: 'urn:ietf:params:oauth:grant-type:saml2-bearer',
|
|
@@ -826,9 +827,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
826
827
|
}
|
|
827
828
|
var encodedData = Buffer.from(clientId + ':' + clientSecret).toString('base64');
|
|
828
829
|
var request = this._formAuthRequest(encodedData,
|
|
829
|
-
{ grant_type: 'authorization_code'
|
|
830
|
-
|
|
831
|
-
|
|
830
|
+
{ grant_type: 'authorization_code',
|
|
831
|
+
code: authCode,
|
|
832
|
+
redirect_uri: redirectUri });
|
|
832
833
|
request.proxy = this.proxy;
|
|
833
834
|
var bodyParam = {
|
|
834
835
|
grant_type: 'authorization_code',
|
|
@@ -854,7 +855,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
854
855
|
return;
|
|
855
856
|
}
|
|
856
857
|
var encodedData = Buffer.from(clientId + ':' + clientSecret).toString('base64');
|
|
857
|
-
var request = this._formAuthRequest(encodedData, { grant_type: 'refresh_token'
|
|
858
|
+
var request = this._formAuthRequest(encodedData, { grant_type: 'refresh_token' , refresh_token: refreshToken });
|
|
858
859
|
request.proxy = this.proxy;
|
|
859
860
|
var bodyParam = {
|
|
860
861
|
grant_type: 'refresh_token',
|
|
@@ -931,8 +932,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
931
932
|
/**
|
|
932
933
|
* @description Utility function to create the request for auth requests
|
|
933
934
|
* @param {string} encodedData - Base64 encoded client and clientSecret pair
|
|
935
|
+
* @param {object} data - data to url form encode
|
|
934
936
|
*/
|
|
935
|
-
_formAuthRequest(encodedData) {
|
|
937
|
+
_formAuthRequest(encodedData, data) {
|
|
936
938
|
var request = axios__default["default"]({
|
|
937
939
|
method: `POST`,
|
|
938
940
|
url: `https://login.${this.config.environment}/oauth/token`,
|
|
@@ -940,7 +942,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
940
942
|
'Authorization': 'Basic ' + encodedData,
|
|
941
943
|
'Content-Type': 'application/x-www-form-urlencoded'
|
|
942
944
|
},
|
|
943
|
-
data:
|
|
945
|
+
data: qs__default["default"].stringify(data)
|
|
944
946
|
});
|
|
945
947
|
|
|
946
948
|
return request;
|
|
@@ -1004,7 +1006,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1004
1006
|
}
|
|
1005
1007
|
|
|
1006
1008
|
// Test token
|
|
1007
|
-
this.callApi('/api/v2/tokens/me', 'GET',
|
|
1009
|
+
this.callApi('/api/v2/tokens/me', 'GET',
|
|
1008
1010
|
null, null, null, null, null, ['PureCloud OAuth'], ['application/json'], ['application/json'])
|
|
1009
1011
|
.then(() => {
|
|
1010
1012
|
resolve();
|
|
@@ -1030,7 +1032,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1030
1032
|
const match = hashRegex.exec(h);
|
|
1031
1033
|
if (match) hash[match[1]] = decodeURIComponent(decodeURIComponent(match[2].replace(/\+/g, '%20')));
|
|
1032
1034
|
});
|
|
1033
|
-
|
|
1035
|
+
|
|
1034
1036
|
// Check for error
|
|
1035
1037
|
if (hash.error) {
|
|
1036
1038
|
return hash;
|
|
@@ -1228,7 +1230,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1228
1230
|
/**
|
|
1229
1231
|
* Checks whether the given parameter value represents file-like content.
|
|
1230
1232
|
* @param param The parameter to check.
|
|
1231
|
-
* @returns {Boolean} <code>true</code> if <code>param</code> represents a file.
|
|
1233
|
+
* @returns {Boolean} <code>true</code> if <code>param</code> represents a file.
|
|
1232
1234
|
*/
|
|
1233
1235
|
isFileParam(param) {
|
|
1234
1236
|
// fs.ReadStream in Node.js (but not in runtime like browserify)
|
|
@@ -1475,7 +1477,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1475
1477
|
/**
|
|
1476
1478
|
* Alerting service.
|
|
1477
1479
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1478
|
-
* @version
|
|
1480
|
+
* @version 141.0.0
|
|
1479
1481
|
*/
|
|
1480
1482
|
|
|
1481
1483
|
/**
|
|
@@ -1789,7 +1791,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1789
1791
|
/**
|
|
1790
1792
|
* Analytics service.
|
|
1791
1793
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1792
|
-
* @version
|
|
1794
|
+
* @version 141.0.0
|
|
1793
1795
|
*/
|
|
1794
1796
|
|
|
1795
1797
|
/**
|
|
@@ -2971,7 +2973,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2971
2973
|
/**
|
|
2972
2974
|
* Architect service.
|
|
2973
2975
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2974
|
-
* @version
|
|
2976
|
+
* @version 141.0.0
|
|
2975
2977
|
*/
|
|
2976
2978
|
|
|
2977
2979
|
/**
|
|
@@ -6016,7 +6018,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6016
6018
|
/**
|
|
6017
6019
|
* Audit service.
|
|
6018
6020
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
6019
|
-
* @version
|
|
6021
|
+
* @version 141.0.0
|
|
6020
6022
|
*/
|
|
6021
6023
|
|
|
6022
6024
|
/**
|
|
@@ -6187,7 +6189,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6187
6189
|
/**
|
|
6188
6190
|
* Authorization service.
|
|
6189
6191
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6190
|
-
* @version
|
|
6192
|
+
* @version 141.0.0
|
|
6191
6193
|
*/
|
|
6192
6194
|
|
|
6193
6195
|
/**
|
|
@@ -6792,18 +6794,18 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6792
6794
|
/**
|
|
6793
6795
|
* Returns a listing of roles and permissions for a user.
|
|
6794
6796
|
*
|
|
6795
|
-
* @param {String}
|
|
6797
|
+
* @param {String} subjectId User ID
|
|
6796
6798
|
*/
|
|
6797
|
-
getUserRoles(
|
|
6798
|
-
// verify the required parameter '
|
|
6799
|
-
if (
|
|
6800
|
-
throw 'Missing the required parameter "
|
|
6799
|
+
getUserRoles(subjectId) {
|
|
6800
|
+
// verify the required parameter 'subjectId' is set
|
|
6801
|
+
if (subjectId === undefined || subjectId === null) {
|
|
6802
|
+
throw 'Missing the required parameter "subjectId" when calling getUserRoles';
|
|
6801
6803
|
}
|
|
6802
6804
|
|
|
6803
6805
|
return this.apiClient.callApi(
|
|
6804
|
-
'/api/v2/users/{
|
|
6806
|
+
'/api/v2/users/{subjectId}/roles',
|
|
6805
6807
|
'GET',
|
|
6806
|
-
{ '
|
|
6808
|
+
{ 'subjectId': subjectId },
|
|
6807
6809
|
{ },
|
|
6808
6810
|
{ },
|
|
6809
6811
|
{ },
|
|
@@ -7337,13 +7339,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7337
7339
|
/**
|
|
7338
7340
|
* Sets the user's roles
|
|
7339
7341
|
*
|
|
7340
|
-
* @param {String}
|
|
7342
|
+
* @param {String} subjectId User ID
|
|
7341
7343
|
* @param {Array.<String>} body List of roles
|
|
7342
7344
|
*/
|
|
7343
|
-
putUserRoles(
|
|
7344
|
-
// verify the required parameter '
|
|
7345
|
-
if (
|
|
7346
|
-
throw 'Missing the required parameter "
|
|
7345
|
+
putUserRoles(subjectId, body) {
|
|
7346
|
+
// verify the required parameter 'subjectId' is set
|
|
7347
|
+
if (subjectId === undefined || subjectId === null) {
|
|
7348
|
+
throw 'Missing the required parameter "subjectId" when calling putUserRoles';
|
|
7347
7349
|
}
|
|
7348
7350
|
// verify the required parameter 'body' is set
|
|
7349
7351
|
if (body === undefined || body === null) {
|
|
@@ -7351,9 +7353,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7351
7353
|
}
|
|
7352
7354
|
|
|
7353
7355
|
return this.apiClient.callApi(
|
|
7354
|
-
'/api/v2/users/{
|
|
7356
|
+
'/api/v2/users/{subjectId}/roles',
|
|
7355
7357
|
'PUT',
|
|
7356
|
-
{ '
|
|
7358
|
+
{ 'subjectId': subjectId },
|
|
7357
7359
|
{ },
|
|
7358
7360
|
{ },
|
|
7359
7361
|
{ },
|
|
@@ -7370,7 +7372,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7370
7372
|
/**
|
|
7371
7373
|
* Billing service.
|
|
7372
7374
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7373
|
-
* @version
|
|
7375
|
+
* @version 141.0.0
|
|
7374
7376
|
*/
|
|
7375
7377
|
|
|
7376
7378
|
/**
|
|
@@ -7450,7 +7452,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7450
7452
|
/**
|
|
7451
7453
|
* Chat service.
|
|
7452
7454
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7453
|
-
* @version
|
|
7455
|
+
* @version 141.0.0
|
|
7454
7456
|
*/
|
|
7455
7457
|
|
|
7456
7458
|
/**
|
|
@@ -7541,7 +7543,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7541
7543
|
/**
|
|
7542
7544
|
* Coaching service.
|
|
7543
7545
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7544
|
-
* @version
|
|
7546
|
+
* @version 141.0.0
|
|
7545
7547
|
*/
|
|
7546
7548
|
|
|
7547
7549
|
/**
|
|
@@ -8118,7 +8120,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8118
8120
|
/**
|
|
8119
8121
|
* ContentManagement service.
|
|
8120
8122
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8121
|
-
* @version
|
|
8123
|
+
* @version 141.0.0
|
|
8122
8124
|
*/
|
|
8123
8125
|
|
|
8124
8126
|
/**
|
|
@@ -9258,7 +9260,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9258
9260
|
/**
|
|
9259
9261
|
* Conversations service.
|
|
9260
9262
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9261
|
-
* @version
|
|
9263
|
+
* @version 141.0.0
|
|
9262
9264
|
*/
|
|
9263
9265
|
|
|
9264
9266
|
/**
|
|
@@ -14192,7 +14194,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14192
14194
|
/**
|
|
14193
14195
|
* DataExtensions service.
|
|
14194
14196
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
14195
|
-
* @version
|
|
14197
|
+
* @version 141.0.0
|
|
14196
14198
|
*/
|
|
14197
14199
|
|
|
14198
14200
|
/**
|
|
@@ -14278,7 +14280,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14278
14280
|
/**
|
|
14279
14281
|
* ExternalContacts service.
|
|
14280
14282
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
14281
|
-
* @version
|
|
14283
|
+
* @version 141.0.0
|
|
14282
14284
|
*/
|
|
14283
14285
|
|
|
14284
14286
|
/**
|
|
@@ -16021,7 +16023,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16021
16023
|
/**
|
|
16022
16024
|
* Fax service.
|
|
16023
16025
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
16024
|
-
* @version
|
|
16026
|
+
* @version 141.0.0
|
|
16025
16027
|
*/
|
|
16026
16028
|
|
|
16027
16029
|
/**
|
|
@@ -16192,7 +16194,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16192
16194
|
/**
|
|
16193
16195
|
* Flows service.
|
|
16194
16196
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
16195
|
-
* @version
|
|
16197
|
+
* @version 141.0.0
|
|
16196
16198
|
*/
|
|
16197
16199
|
|
|
16198
16200
|
/**
|
|
@@ -16263,7 +16265,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16263
16265
|
/**
|
|
16264
16266
|
* Gamification service.
|
|
16265
16267
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
16266
|
-
* @version
|
|
16268
|
+
* @version 141.0.0
|
|
16267
16269
|
*/
|
|
16268
16270
|
|
|
16269
16271
|
/**
|
|
@@ -16408,7 +16410,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16408
16410
|
|
|
16409
16411
|
/**
|
|
16410
16412
|
* Gamified metric by id
|
|
16411
|
-
*
|
|
16413
|
+
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
|
|
16412
16414
|
* @param {String} metricId metric Id
|
|
16413
16415
|
* @param {Object} opts Optional parameters
|
|
16414
16416
|
* @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
|
|
@@ -16483,7 +16485,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16483
16485
|
|
|
16484
16486
|
/**
|
|
16485
16487
|
* All gamified metrics for a given profile
|
|
16486
|
-
*
|
|
16488
|
+
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
|
|
16487
16489
|
* @param {Object} opts Optional parameters
|
|
16488
16490
|
* @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
|
|
16489
16491
|
* @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
|
|
@@ -16886,6 +16888,157 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16886
16888
|
);
|
|
16887
16889
|
}
|
|
16888
16890
|
|
|
16891
|
+
/**
|
|
16892
|
+
* Average performance values trends by metric of a user
|
|
16893
|
+
*
|
|
16894
|
+
* @param {String} profileId performanceProfileId
|
|
16895
|
+
* @param {String} metricId metricId
|
|
16896
|
+
* @param {String} userId
|
|
16897
|
+
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
16898
|
+
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
16899
|
+
* @param {Object} opts Optional parameters
|
|
16900
|
+
* @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
|
|
16901
|
+
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
16902
|
+
*/
|
|
16903
|
+
getGamificationScorecardsProfileMetricUserValuesTrends(profileId, metricId, userId, startWorkday, endWorkday, opts) {
|
|
16904
|
+
opts = opts || {};
|
|
16905
|
+
|
|
16906
|
+
// verify the required parameter 'profileId' is set
|
|
16907
|
+
if (profileId === undefined || profileId === null) {
|
|
16908
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
16909
|
+
}
|
|
16910
|
+
// verify the required parameter 'metricId' is set
|
|
16911
|
+
if (metricId === undefined || metricId === null) {
|
|
16912
|
+
throw 'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
16913
|
+
}
|
|
16914
|
+
// verify the required parameter 'userId' is set
|
|
16915
|
+
if (userId === undefined || userId === null) {
|
|
16916
|
+
throw 'Missing the required parameter "userId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
16917
|
+
}
|
|
16918
|
+
// verify the required parameter 'startWorkday' is set
|
|
16919
|
+
if (startWorkday === undefined || startWorkday === null) {
|
|
16920
|
+
throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
16921
|
+
}
|
|
16922
|
+
// verify the required parameter 'endWorkday' is set
|
|
16923
|
+
if (endWorkday === undefined || endWorkday === null) {
|
|
16924
|
+
throw 'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
|
|
16925
|
+
}
|
|
16926
|
+
|
|
16927
|
+
return this.apiClient.callApi(
|
|
16928
|
+
'/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/{userId}/values/trends',
|
|
16929
|
+
'GET',
|
|
16930
|
+
{ 'profileId': profileId,'metricId': metricId,'userId': userId },
|
|
16931
|
+
{ 'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
16932
|
+
{ },
|
|
16933
|
+
{ },
|
|
16934
|
+
null,
|
|
16935
|
+
['PureCloud OAuth'],
|
|
16936
|
+
['application/json'],
|
|
16937
|
+
['application/json']
|
|
16938
|
+
);
|
|
16939
|
+
}
|
|
16940
|
+
|
|
16941
|
+
/**
|
|
16942
|
+
* Average performance values trends by metric of a division or a performance profile
|
|
16943
|
+
*
|
|
16944
|
+
* @param {String} profileId performanceProfileId
|
|
16945
|
+
* @param {String} metricId metricId
|
|
16946
|
+
* @param {Object} filterType Filter type for the query request.
|
|
16947
|
+
* @param {String} filterId ID for the filter type. For example, division Id
|
|
16948
|
+
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
16949
|
+
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
16950
|
+
* @param {Object} opts Optional parameters
|
|
16951
|
+
* @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
|
|
16952
|
+
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
16953
|
+
*/
|
|
16954
|
+
getGamificationScorecardsProfileMetricUsersValuesTrends(profileId, metricId, filterType, filterId, startWorkday, endWorkday, opts) {
|
|
16955
|
+
opts = opts || {};
|
|
16956
|
+
|
|
16957
|
+
// verify the required parameter 'profileId' is set
|
|
16958
|
+
if (profileId === undefined || profileId === null) {
|
|
16959
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
16960
|
+
}
|
|
16961
|
+
// verify the required parameter 'metricId' is set
|
|
16962
|
+
if (metricId === undefined || metricId === null) {
|
|
16963
|
+
throw 'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
16964
|
+
}
|
|
16965
|
+
// verify the required parameter 'filterType' is set
|
|
16966
|
+
if (filterType === undefined || filterType === null) {
|
|
16967
|
+
throw 'Missing the required parameter "filterType" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
16968
|
+
}
|
|
16969
|
+
// verify the required parameter 'filterId' is set
|
|
16970
|
+
if (filterId === undefined || filterId === null) {
|
|
16971
|
+
throw 'Missing the required parameter "filterId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
16972
|
+
}
|
|
16973
|
+
// verify the required parameter 'startWorkday' is set
|
|
16974
|
+
if (startWorkday === undefined || startWorkday === null) {
|
|
16975
|
+
throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
16976
|
+
}
|
|
16977
|
+
// verify the required parameter 'endWorkday' is set
|
|
16978
|
+
if (endWorkday === undefined || endWorkday === null) {
|
|
16979
|
+
throw 'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
|
|
16980
|
+
}
|
|
16981
|
+
|
|
16982
|
+
return this.apiClient.callApi(
|
|
16983
|
+
'/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/values/trends',
|
|
16984
|
+
'GET',
|
|
16985
|
+
{ 'profileId': profileId,'metricId': metricId },
|
|
16986
|
+
{ 'filterType': filterType,'filterId': filterId,'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
16987
|
+
{ },
|
|
16988
|
+
{ },
|
|
16989
|
+
null,
|
|
16990
|
+
['PureCloud OAuth'],
|
|
16991
|
+
['application/json'],
|
|
16992
|
+
['application/json']
|
|
16993
|
+
);
|
|
16994
|
+
}
|
|
16995
|
+
|
|
16996
|
+
/**
|
|
16997
|
+
* Average performance values trends by metric of the requesting user
|
|
16998
|
+
*
|
|
16999
|
+
* @param {String} profileId performanceProfileId
|
|
17000
|
+
* @param {String} metricId metricId
|
|
17001
|
+
* @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
17002
|
+
* @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
17003
|
+
* @param {Object} opts Optional parameters
|
|
17004
|
+
* @param {Object} opts.filterType Filter type for the query request. If not set, returns the values trends of the requesting user
|
|
17005
|
+
* @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
|
|
17006
|
+
* @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
|
|
17007
|
+
*/
|
|
17008
|
+
getGamificationScorecardsProfileMetricValuesTrends(profileId, metricId, startWorkday, endWorkday, opts) {
|
|
17009
|
+
opts = opts || {};
|
|
17010
|
+
|
|
17011
|
+
// verify the required parameter 'profileId' is set
|
|
17012
|
+
if (profileId === undefined || profileId === null) {
|
|
17013
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
17014
|
+
}
|
|
17015
|
+
// verify the required parameter 'metricId' is set
|
|
17016
|
+
if (metricId === undefined || metricId === null) {
|
|
17017
|
+
throw 'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
17018
|
+
}
|
|
17019
|
+
// verify the required parameter 'startWorkday' is set
|
|
17020
|
+
if (startWorkday === undefined || startWorkday === null) {
|
|
17021
|
+
throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
17022
|
+
}
|
|
17023
|
+
// verify the required parameter 'endWorkday' is set
|
|
17024
|
+
if (endWorkday === undefined || endWorkday === null) {
|
|
17025
|
+
throw 'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricValuesTrends';
|
|
17026
|
+
}
|
|
17027
|
+
|
|
17028
|
+
return this.apiClient.callApi(
|
|
17029
|
+
'/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/values/trends',
|
|
17030
|
+
'GET',
|
|
17031
|
+
{ 'profileId': profileId,'metricId': metricId },
|
|
17032
|
+
{ 'filterType': opts['filterType'],'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
|
|
17033
|
+
{ },
|
|
17034
|
+
{ },
|
|
17035
|
+
null,
|
|
17036
|
+
['PureCloud OAuth'],
|
|
17037
|
+
['application/json'],
|
|
17038
|
+
['application/json']
|
|
17039
|
+
);
|
|
17040
|
+
}
|
|
17041
|
+
|
|
16889
17042
|
/**
|
|
16890
17043
|
* Workday performance metrics for a user
|
|
16891
17044
|
*
|
|
@@ -17338,7 +17491,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17338
17491
|
|
|
17339
17492
|
/**
|
|
17340
17493
|
* Creates a gamified metric with a given metric definition and metric objective
|
|
17341
|
-
*
|
|
17494
|
+
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
|
|
17342
17495
|
* @param {Object} body Metric
|
|
17343
17496
|
*/
|
|
17344
17497
|
postGamificationMetrics(body) {
|
|
@@ -17567,7 +17720,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17567
17720
|
|
|
17568
17721
|
/**
|
|
17569
17722
|
* Updates a metric
|
|
17570
|
-
*
|
|
17723
|
+
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
|
|
17571
17724
|
* @param {String} metricId metric Id
|
|
17572
17725
|
* @param {Object} body Metric
|
|
17573
17726
|
* @param {Object} opts Optional parameters
|
|
@@ -17694,7 +17847,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17694
17847
|
/**
|
|
17695
17848
|
* GeneralDataProtectionRegulation service.
|
|
17696
17849
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
17697
|
-
* @version
|
|
17850
|
+
* @version 141.0.0
|
|
17698
17851
|
*/
|
|
17699
17852
|
|
|
17700
17853
|
/**
|
|
@@ -17824,7 +17977,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17824
17977
|
/**
|
|
17825
17978
|
* Geolocation service.
|
|
17826
17979
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
17827
|
-
* @version
|
|
17980
|
+
* @version 141.0.0
|
|
17828
17981
|
*/
|
|
17829
17982
|
|
|
17830
17983
|
/**
|
|
@@ -17955,7 +18108,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17955
18108
|
/**
|
|
17956
18109
|
* Greetings service.
|
|
17957
18110
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
17958
|
-
* @version
|
|
18111
|
+
* @version 141.0.0
|
|
17959
18112
|
*/
|
|
17960
18113
|
|
|
17961
18114
|
/**
|
|
@@ -18410,7 +18563,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18410
18563
|
/**
|
|
18411
18564
|
* Groups service.
|
|
18412
18565
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
18413
|
-
* @version
|
|
18566
|
+
* @version 141.0.0
|
|
18414
18567
|
*/
|
|
18415
18568
|
|
|
18416
18569
|
/**
|
|
@@ -18815,7 +18968,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18815
18968
|
/**
|
|
18816
18969
|
* IdentityProvider service.
|
|
18817
18970
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
18818
|
-
* @version
|
|
18971
|
+
* @version 141.0.0
|
|
18819
18972
|
*/
|
|
18820
18973
|
|
|
18821
18974
|
/**
|
|
@@ -19571,7 +19724,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19571
19724
|
/**
|
|
19572
19725
|
* Integrations service.
|
|
19573
19726
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
19574
|
-
* @version
|
|
19727
|
+
* @version 141.0.0
|
|
19575
19728
|
*/
|
|
19576
19729
|
|
|
19577
19730
|
/**
|
|
@@ -21248,7 +21401,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21248
21401
|
/**
|
|
21249
21402
|
* Journey service.
|
|
21250
21403
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
21251
|
-
* @version
|
|
21404
|
+
* @version 141.0.0
|
|
21252
21405
|
*/
|
|
21253
21406
|
|
|
21254
21407
|
/**
|
|
@@ -21959,7 +22112,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21959
22112
|
/**
|
|
21960
22113
|
* Knowledge service.
|
|
21961
22114
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
21962
|
-
* @version
|
|
22115
|
+
* @version 141.0.0
|
|
21963
22116
|
*/
|
|
21964
22117
|
|
|
21965
22118
|
/**
|
|
@@ -22859,7 +23012,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22859
23012
|
/**
|
|
22860
23013
|
* LanguageUnderstanding service.
|
|
22861
23014
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
22862
|
-
* @version
|
|
23015
|
+
* @version 141.0.0
|
|
22863
23016
|
*/
|
|
22864
23017
|
|
|
22865
23018
|
/**
|
|
@@ -23763,7 +23916,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23763
23916
|
/**
|
|
23764
23917
|
* Languages service.
|
|
23765
23918
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
23766
|
-
* @version
|
|
23919
|
+
* @version 141.0.0
|
|
23767
23920
|
*/
|
|
23768
23921
|
|
|
23769
23922
|
/**
|
|
@@ -24031,7 +24184,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24031
24184
|
/**
|
|
24032
24185
|
* Learning service.
|
|
24033
24186
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
24034
|
-
* @version
|
|
24187
|
+
* @version 141.0.0
|
|
24035
24188
|
*/
|
|
24036
24189
|
|
|
24037
24190
|
/**
|
|
@@ -24229,6 +24382,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24229
24382
|
);
|
|
24230
24383
|
}
|
|
24231
24384
|
|
|
24385
|
+
/**
|
|
24386
|
+
* Get a specific Learning Module job status
|
|
24387
|
+
*
|
|
24388
|
+
* @param {String} moduleId The ID of the learning module
|
|
24389
|
+
* @param {String} jobId The ID of the learning module job
|
|
24390
|
+
*/
|
|
24391
|
+
getLearningModuleJob(moduleId, jobId) {
|
|
24392
|
+
// verify the required parameter 'moduleId' is set
|
|
24393
|
+
if (moduleId === undefined || moduleId === null) {
|
|
24394
|
+
throw 'Missing the required parameter "moduleId" when calling getLearningModuleJob';
|
|
24395
|
+
}
|
|
24396
|
+
// verify the required parameter 'jobId' is set
|
|
24397
|
+
if (jobId === undefined || jobId === null) {
|
|
24398
|
+
throw 'Missing the required parameter "jobId" when calling getLearningModuleJob';
|
|
24399
|
+
}
|
|
24400
|
+
|
|
24401
|
+
return this.apiClient.callApi(
|
|
24402
|
+
'/api/v2/learning/modules/{moduleId}/jobs/{jobId}',
|
|
24403
|
+
'GET',
|
|
24404
|
+
{ 'moduleId': moduleId,'jobId': jobId },
|
|
24405
|
+
{ },
|
|
24406
|
+
{ },
|
|
24407
|
+
{ },
|
|
24408
|
+
null,
|
|
24409
|
+
['PureCloud OAuth'],
|
|
24410
|
+
['application/json'],
|
|
24411
|
+
['application/json']
|
|
24412
|
+
);
|
|
24413
|
+
}
|
|
24414
|
+
|
|
24232
24415
|
/**
|
|
24233
24416
|
* Get a learning module rule
|
|
24234
24417
|
*
|
|
@@ -24320,6 +24503,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24320
24503
|
);
|
|
24321
24504
|
}
|
|
24322
24505
|
|
|
24506
|
+
/**
|
|
24507
|
+
* Get all learning modules of an organization including assignments for a specific user
|
|
24508
|
+
*
|
|
24509
|
+
* @param {Array.<String>} userIds The IDs of the users to include
|
|
24510
|
+
* @param {Object} opts Optional parameters
|
|
24511
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
24512
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
24513
|
+
* @param {String} opts.searchTerm Search Term (searches by name and description)
|
|
24514
|
+
* @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)
|
|
24515
|
+
* @param {Array.<String>} opts.assignmentStates Specifies the assignment states to return.
|
|
24516
|
+
* @param {Array.<String>} opts.expand Fields to expand in response(case insensitive)
|
|
24517
|
+
*/
|
|
24518
|
+
getLearningModulesAssignments(userIds, opts) {
|
|
24519
|
+
opts = opts || {};
|
|
24520
|
+
|
|
24521
|
+
// verify the required parameter 'userIds' is set
|
|
24522
|
+
if (userIds === undefined || userIds === null) {
|
|
24523
|
+
throw 'Missing the required parameter "userIds" when calling getLearningModulesAssignments';
|
|
24524
|
+
}
|
|
24525
|
+
|
|
24526
|
+
return this.apiClient.callApi(
|
|
24527
|
+
'/api/v2/learning/modules/assignments',
|
|
24528
|
+
'GET',
|
|
24529
|
+
{ },
|
|
24530
|
+
{ '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') },
|
|
24531
|
+
{ },
|
|
24532
|
+
{ },
|
|
24533
|
+
null,
|
|
24534
|
+
['PureCloud OAuth'],
|
|
24535
|
+
['application/json'],
|
|
24536
|
+
['application/json']
|
|
24537
|
+
);
|
|
24538
|
+
}
|
|
24539
|
+
|
|
24323
24540
|
/**
|
|
24324
24541
|
* Update Learning Assignment
|
|
24325
24542
|
*
|
|
@@ -24374,6 +24591,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24374
24591
|
);
|
|
24375
24592
|
}
|
|
24376
24593
|
|
|
24594
|
+
/**
|
|
24595
|
+
* Reassign Learning Assignment
|
|
24596
|
+
* This will reassign the state of the assignment to Assigned and update the assignment to the latest version of the module
|
|
24597
|
+
* @param {String} assignmentId The Learning Assignment ID
|
|
24598
|
+
*/
|
|
24599
|
+
postLearningAssignmentReassign(assignmentId) {
|
|
24600
|
+
// verify the required parameter 'assignmentId' is set
|
|
24601
|
+
if (assignmentId === undefined || assignmentId === null) {
|
|
24602
|
+
throw 'Missing the required parameter "assignmentId" when calling postLearningAssignmentReassign';
|
|
24603
|
+
}
|
|
24604
|
+
|
|
24605
|
+
return this.apiClient.callApi(
|
|
24606
|
+
'/api/v2/learning/assignments/{assignmentId}/reassign',
|
|
24607
|
+
'POST',
|
|
24608
|
+
{ 'assignmentId': assignmentId },
|
|
24609
|
+
{ },
|
|
24610
|
+
{ },
|
|
24611
|
+
{ },
|
|
24612
|
+
null,
|
|
24613
|
+
['PureCloud OAuth'],
|
|
24614
|
+
['application/json'],
|
|
24615
|
+
['application/json']
|
|
24616
|
+
);
|
|
24617
|
+
}
|
|
24618
|
+
|
|
24619
|
+
/**
|
|
24620
|
+
* Reset Learning Assignment
|
|
24621
|
+
* This will reset the state of the assignment to Assigned and remove the version of Learning module associated with the assignment
|
|
24622
|
+
* @param {String} assignmentId The Learning Assignment ID
|
|
24623
|
+
*/
|
|
24624
|
+
postLearningAssignmentReset(assignmentId) {
|
|
24625
|
+
// verify the required parameter 'assignmentId' is set
|
|
24626
|
+
if (assignmentId === undefined || assignmentId === null) {
|
|
24627
|
+
throw 'Missing the required parameter "assignmentId" when calling postLearningAssignmentReset';
|
|
24628
|
+
}
|
|
24629
|
+
|
|
24630
|
+
return this.apiClient.callApi(
|
|
24631
|
+
'/api/v2/learning/assignments/{assignmentId}/reset',
|
|
24632
|
+
'POST',
|
|
24633
|
+
{ 'assignmentId': assignmentId },
|
|
24634
|
+
{ },
|
|
24635
|
+
{ },
|
|
24636
|
+
{ },
|
|
24637
|
+
null,
|
|
24638
|
+
['PureCloud OAuth'],
|
|
24639
|
+
['application/json'],
|
|
24640
|
+
['application/json']
|
|
24641
|
+
);
|
|
24642
|
+
}
|
|
24643
|
+
|
|
24377
24644
|
/**
|
|
24378
24645
|
* Create Learning Assignment
|
|
24379
24646
|
*
|
|
@@ -24471,6 +24738,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24471
24738
|
);
|
|
24472
24739
|
}
|
|
24473
24740
|
|
|
24741
|
+
/**
|
|
24742
|
+
* Starts a specified operation on learning module
|
|
24743
|
+
* This will initiate operation specified in the request body for a learning module
|
|
24744
|
+
* @param {String} moduleId The ID of the learning module
|
|
24745
|
+
* @param {Object} body The learning module job request
|
|
24746
|
+
*/
|
|
24747
|
+
postLearningModuleJobs(moduleId, body) {
|
|
24748
|
+
// verify the required parameter 'moduleId' is set
|
|
24749
|
+
if (moduleId === undefined || moduleId === null) {
|
|
24750
|
+
throw 'Missing the required parameter "moduleId" when calling postLearningModuleJobs';
|
|
24751
|
+
}
|
|
24752
|
+
// verify the required parameter 'body' is set
|
|
24753
|
+
if (body === undefined || body === null) {
|
|
24754
|
+
throw 'Missing the required parameter "body" when calling postLearningModuleJobs';
|
|
24755
|
+
}
|
|
24756
|
+
|
|
24757
|
+
return this.apiClient.callApi(
|
|
24758
|
+
'/api/v2/learning/modules/{moduleId}/jobs',
|
|
24759
|
+
'POST',
|
|
24760
|
+
{ 'moduleId': moduleId },
|
|
24761
|
+
{ },
|
|
24762
|
+
{ },
|
|
24763
|
+
{ },
|
|
24764
|
+
body,
|
|
24765
|
+
['PureCloud OAuth'],
|
|
24766
|
+
['application/json'],
|
|
24767
|
+
['application/json']
|
|
24768
|
+
);
|
|
24769
|
+
}
|
|
24770
|
+
|
|
24474
24771
|
/**
|
|
24475
24772
|
* Publish a Learning module
|
|
24476
24773
|
*
|
|
@@ -24622,7 +24919,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24622
24919
|
/**
|
|
24623
24920
|
* License service.
|
|
24624
24921
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
24625
|
-
* @version
|
|
24922
|
+
* @version 141.0.0
|
|
24626
24923
|
*/
|
|
24627
24924
|
|
|
24628
24925
|
/**
|
|
@@ -24860,7 +25157,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24860
25157
|
/**
|
|
24861
25158
|
* Locations service.
|
|
24862
25159
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
24863
|
-
* @version
|
|
25160
|
+
* @version 141.0.0
|
|
24864
25161
|
*/
|
|
24865
25162
|
|
|
24866
25163
|
/**
|
|
@@ -25096,7 +25393,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25096
25393
|
/**
|
|
25097
25394
|
* Messaging service.
|
|
25098
25395
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
25099
|
-
* @version
|
|
25396
|
+
* @version 141.0.0
|
|
25100
25397
|
*/
|
|
25101
25398
|
|
|
25102
25399
|
/**
|
|
@@ -25247,7 +25544,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25247
25544
|
/**
|
|
25248
25545
|
* MobileDevices service.
|
|
25249
25546
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
25250
|
-
* @version
|
|
25547
|
+
* @version 141.0.0
|
|
25251
25548
|
*/
|
|
25252
25549
|
|
|
25253
25550
|
/**
|
|
@@ -25398,7 +25695,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25398
25695
|
/**
|
|
25399
25696
|
* Notifications service.
|
|
25400
25697
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
25401
|
-
* @version
|
|
25698
|
+
* @version 141.0.0
|
|
25402
25699
|
*/
|
|
25403
25700
|
|
|
25404
25701
|
/**
|
|
@@ -25623,7 +25920,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25623
25920
|
/**
|
|
25624
25921
|
* OAuth service.
|
|
25625
25922
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
25626
|
-
* @version
|
|
25923
|
+
* @version 141.0.0
|
|
25627
25924
|
*/
|
|
25628
25925
|
|
|
25629
25926
|
/**
|
|
@@ -25989,7 +26286,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25989
26286
|
/**
|
|
25990
26287
|
* Objects service.
|
|
25991
26288
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
25992
|
-
* @version
|
|
26289
|
+
* @version 141.0.0
|
|
25993
26290
|
*/
|
|
25994
26291
|
|
|
25995
26292
|
/**
|
|
@@ -26260,7 +26557,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26260
26557
|
/**
|
|
26261
26558
|
* Organization service.
|
|
26262
26559
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
26263
|
-
* @version
|
|
26560
|
+
* @version 141.0.0
|
|
26264
26561
|
*/
|
|
26265
26562
|
|
|
26266
26563
|
/**
|
|
@@ -26663,7 +26960,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26663
26960
|
/**
|
|
26664
26961
|
* OrganizationAuthorization service.
|
|
26665
26962
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
26666
|
-
* @version
|
|
26963
|
+
* @version 141.0.0
|
|
26667
26964
|
*/
|
|
26668
26965
|
|
|
26669
26966
|
/**
|
|
@@ -27588,7 +27885,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27588
27885
|
/**
|
|
27589
27886
|
* Outbound service.
|
|
27590
27887
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
27591
|
-
* @version
|
|
27888
|
+
* @version 141.0.0
|
|
27592
27889
|
*/
|
|
27593
27890
|
|
|
27594
27891
|
/**
|
|
@@ -30843,7 +31140,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30843
31140
|
/**
|
|
30844
31141
|
* Presence service.
|
|
30845
31142
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
30846
|
-
* @version
|
|
31143
|
+
* @version 141.0.0
|
|
30847
31144
|
*/
|
|
30848
31145
|
|
|
30849
31146
|
/**
|
|
@@ -31165,7 +31462,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31165
31462
|
/**
|
|
31166
31463
|
* Quality service.
|
|
31167
31464
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
31168
|
-
* @version
|
|
31465
|
+
* @version 141.0.0
|
|
31169
31466
|
*/
|
|
31170
31467
|
|
|
31171
31468
|
/**
|
|
@@ -31923,7 +32220,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31923
32220
|
/**
|
|
31924
32221
|
* Retrieve a list of the latest form versions by context ids
|
|
31925
32222
|
*
|
|
31926
|
-
* @param {Array.<String>} contextId A comma-delimited list of valid survey form context ids
|
|
32223
|
+
* @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.
|
|
31927
32224
|
* @param {Object} opts Optional parameters
|
|
31928
32225
|
* @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)
|
|
31929
32226
|
*/
|
|
@@ -32743,7 +33040,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32743
33040
|
/**
|
|
32744
33041
|
* Recording service.
|
|
32745
33042
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
32746
|
-
* @version
|
|
33043
|
+
* @version 141.0.0
|
|
32747
33044
|
*/
|
|
32748
33045
|
|
|
32749
33046
|
/**
|
|
@@ -34396,7 +34693,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34396
34693
|
/**
|
|
34397
34694
|
* ResponseManagement service.
|
|
34398
34695
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
34399
|
-
* @version
|
|
34696
|
+
* @version 141.0.0
|
|
34400
34697
|
*/
|
|
34401
34698
|
|
|
34402
34699
|
/**
|
|
@@ -34880,7 +35177,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34880
35177
|
/**
|
|
34881
35178
|
* Routing service.
|
|
34882
35179
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
34883
|
-
* @version
|
|
35180
|
+
* @version 141.0.0
|
|
34884
35181
|
*/
|
|
34885
35182
|
|
|
34886
35183
|
/**
|
|
@@ -35709,16 +36006,20 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35709
36006
|
}
|
|
35710
36007
|
|
|
35711
36008
|
/**
|
|
35712
|
-
* Get a list of Key Performance Indicators
|
|
36009
|
+
* Get a list of Key Performance Indicators
|
|
35713
36010
|
*
|
|
36011
|
+
* @param {Object} opts Optional parameters
|
|
36012
|
+
* @param {Object} opts.kpiGroup The Group of Key Performance Indicators to return
|
|
35714
36013
|
*/
|
|
35715
|
-
getRoutingPredictorsKeyperformanceindicators() {
|
|
36014
|
+
getRoutingPredictorsKeyperformanceindicators(opts) {
|
|
36015
|
+
opts = opts || {};
|
|
36016
|
+
|
|
35716
36017
|
|
|
35717
36018
|
return this.apiClient.callApi(
|
|
35718
36019
|
'/api/v2/routing/predictors/keyperformanceindicators',
|
|
35719
36020
|
'GET',
|
|
35720
36021
|
{ },
|
|
35721
|
-
{
|
|
36022
|
+
{ 'kpiGroup': opts['kpiGroup'] },
|
|
35722
36023
|
{ },
|
|
35723
36024
|
{ },
|
|
35724
36025
|
null,
|
|
@@ -35986,6 +36287,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35986
36287
|
* @param {String} opts.name Filter by queue name
|
|
35987
36288
|
* @param {Array.<String>} opts.id Filter by queue ID(s)
|
|
35988
36289
|
* @param {Array.<String>} opts.divisionId Filter by queue division ID(s)
|
|
36290
|
+
* @param {Array.<String>} opts.peerId Filter by queue peer ID(s)
|
|
36291
|
+
* @param {Boolean} opts.hasPeer Filter by queues associated with peer
|
|
35989
36292
|
*/
|
|
35990
36293
|
getRoutingQueues(opts) {
|
|
35991
36294
|
opts = opts || {};
|
|
@@ -35995,7 +36298,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35995
36298
|
'/api/v2/routing/queues',
|
|
35996
36299
|
'GET',
|
|
35997
36300
|
{ },
|
|
35998
|
-
{ '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') },
|
|
36301
|
+
{ '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'] },
|
|
35999
36302
|
{ },
|
|
36000
36303
|
{ },
|
|
36001
36304
|
null,
|
|
@@ -37795,7 +38098,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37795
38098
|
/**
|
|
37796
38099
|
* SCIM service.
|
|
37797
38100
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
37798
|
-
* @version
|
|
38101
|
+
* @version 141.0.0
|
|
37799
38102
|
*/
|
|
37800
38103
|
|
|
37801
38104
|
/**
|
|
@@ -38672,7 +38975,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38672
38975
|
/**
|
|
38673
38976
|
* Scripts service.
|
|
38674
38977
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
38675
|
-
* @version
|
|
38978
|
+
* @version 141.0.0
|
|
38676
38979
|
*/
|
|
38677
38980
|
|
|
38678
38981
|
/**
|
|
@@ -39091,7 +39394,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39091
39394
|
/**
|
|
39092
39395
|
* Search service.
|
|
39093
39396
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
39094
|
-
* @version
|
|
39397
|
+
* @version 141.0.0
|
|
39095
39398
|
*/
|
|
39096
39399
|
|
|
39097
39400
|
/**
|
|
@@ -39626,7 +39929,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39626
39929
|
/**
|
|
39627
39930
|
* SpeechTextAnalytics service.
|
|
39628
39931
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
39629
|
-
* @version
|
|
39932
|
+
* @version 141.0.0
|
|
39630
39933
|
*/
|
|
39631
39934
|
|
|
39632
39935
|
/**
|
|
@@ -40479,7 +40782,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40479
40782
|
/**
|
|
40480
40783
|
* Stations service.
|
|
40481
40784
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
40482
|
-
* @version
|
|
40785
|
+
* @version 141.0.0
|
|
40483
40786
|
*/
|
|
40484
40787
|
|
|
40485
40788
|
/**
|
|
@@ -40626,7 +40929,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40626
40929
|
/**
|
|
40627
40930
|
* Suggest service.
|
|
40628
40931
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
40629
|
-
* @version
|
|
40932
|
+
* @version 141.0.0
|
|
40630
40933
|
*/
|
|
40631
40934
|
|
|
40632
40935
|
/**
|
|
@@ -40765,7 +41068,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40765
41068
|
/**
|
|
40766
41069
|
* Telephony service.
|
|
40767
41070
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
40768
|
-
* @version
|
|
41071
|
+
* @version 141.0.0
|
|
40769
41072
|
*/
|
|
40770
41073
|
|
|
40771
41074
|
/**
|
|
@@ -40873,7 +41176,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40873
41176
|
/**
|
|
40874
41177
|
* TelephonyProvidersEdge service.
|
|
40875
41178
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
40876
|
-
* @version
|
|
41179
|
+
* @version 141.0.0
|
|
40877
41180
|
*/
|
|
40878
41181
|
|
|
40879
41182
|
/**
|
|
@@ -44506,7 +44809,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44506
44809
|
/**
|
|
44507
44810
|
* Textbots service.
|
|
44508
44811
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
44509
|
-
* @version
|
|
44812
|
+
* @version 141.0.0
|
|
44510
44813
|
*/
|
|
44511
44814
|
|
|
44512
44815
|
/**
|
|
@@ -44634,7 +44937,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44634
44937
|
/**
|
|
44635
44938
|
* Tokens service.
|
|
44636
44939
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
44637
|
-
* @version
|
|
44940
|
+
* @version 141.0.0
|
|
44638
44941
|
*/
|
|
44639
44942
|
|
|
44640
44943
|
/**
|
|
@@ -44740,7 +45043,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44740
45043
|
/**
|
|
44741
45044
|
* Uploads service.
|
|
44742
45045
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
44743
|
-
* @version
|
|
45046
|
+
* @version 141.0.0
|
|
44744
45047
|
*/
|
|
44745
45048
|
|
|
44746
45049
|
/**
|
|
@@ -44891,7 +45194,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44891
45194
|
/**
|
|
44892
45195
|
* Usage service.
|
|
44893
45196
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
44894
|
-
* @version
|
|
45197
|
+
* @version 141.0.0
|
|
44895
45198
|
*/
|
|
44896
45199
|
|
|
44897
45200
|
/**
|
|
@@ -44962,7 +45265,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44962
45265
|
/**
|
|
44963
45266
|
* UserRecordings service.
|
|
44964
45267
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
44965
|
-
* @version
|
|
45268
|
+
* @version 141.0.0
|
|
44966
45269
|
*/
|
|
44967
45270
|
|
|
44968
45271
|
/**
|
|
@@ -45146,7 +45449,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45146
45449
|
/**
|
|
45147
45450
|
* Users service.
|
|
45148
45451
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
45149
|
-
* @version
|
|
45452
|
+
* @version 141.0.0
|
|
45150
45453
|
*/
|
|
45151
45454
|
|
|
45152
45455
|
/**
|
|
@@ -45966,18 +46269,18 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45966
46269
|
/**
|
|
45967
46270
|
* Returns a listing of roles and permissions for a user.
|
|
45968
46271
|
*
|
|
45969
|
-
* @param {String}
|
|
46272
|
+
* @param {String} subjectId User ID
|
|
45970
46273
|
*/
|
|
45971
|
-
getUserRoles(
|
|
45972
|
-
// verify the required parameter '
|
|
45973
|
-
if (
|
|
45974
|
-
throw 'Missing the required parameter "
|
|
46274
|
+
getUserRoles(subjectId) {
|
|
46275
|
+
// verify the required parameter 'subjectId' is set
|
|
46276
|
+
if (subjectId === undefined || subjectId === null) {
|
|
46277
|
+
throw 'Missing the required parameter "subjectId" when calling getUserRoles';
|
|
45975
46278
|
}
|
|
45976
46279
|
|
|
45977
46280
|
return this.apiClient.callApi(
|
|
45978
|
-
'/api/v2/users/{
|
|
46281
|
+
'/api/v2/users/{subjectId}/roles',
|
|
45979
46282
|
'GET',
|
|
45980
|
-
{ '
|
|
46283
|
+
{ 'subjectId': subjectId },
|
|
45981
46284
|
{ },
|
|
45982
46285
|
{ },
|
|
45983
46286
|
{ },
|
|
@@ -47230,13 +47533,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47230
47533
|
/**
|
|
47231
47534
|
* Sets the user's roles
|
|
47232
47535
|
*
|
|
47233
|
-
* @param {String}
|
|
47536
|
+
* @param {String} subjectId User ID
|
|
47234
47537
|
* @param {Array.<String>} body List of roles
|
|
47235
47538
|
*/
|
|
47236
|
-
putUserRoles(
|
|
47237
|
-
// verify the required parameter '
|
|
47238
|
-
if (
|
|
47239
|
-
throw 'Missing the required parameter "
|
|
47539
|
+
putUserRoles(subjectId, body) {
|
|
47540
|
+
// verify the required parameter 'subjectId' is set
|
|
47541
|
+
if (subjectId === undefined || subjectId === null) {
|
|
47542
|
+
throw 'Missing the required parameter "subjectId" when calling putUserRoles';
|
|
47240
47543
|
}
|
|
47241
47544
|
// verify the required parameter 'body' is set
|
|
47242
47545
|
if (body === undefined || body === null) {
|
|
@@ -47244,9 +47547,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47244
47547
|
}
|
|
47245
47548
|
|
|
47246
47549
|
return this.apiClient.callApi(
|
|
47247
|
-
'/api/v2/users/{
|
|
47550
|
+
'/api/v2/users/{subjectId}/roles',
|
|
47248
47551
|
'PUT',
|
|
47249
|
-
{ '
|
|
47552
|
+
{ 'subjectId': subjectId },
|
|
47250
47553
|
{ },
|
|
47251
47554
|
{ },
|
|
47252
47555
|
{ },
|
|
@@ -47448,7 +47751,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47448
47751
|
/**
|
|
47449
47752
|
* Utilities service.
|
|
47450
47753
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
47451
|
-
* @version
|
|
47754
|
+
* @version 141.0.0
|
|
47452
47755
|
*/
|
|
47453
47756
|
|
|
47454
47757
|
/**
|
|
@@ -47559,7 +47862,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47559
47862
|
/**
|
|
47560
47863
|
* Voicemail service.
|
|
47561
47864
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
47562
|
-
* @version
|
|
47865
|
+
* @version 141.0.0
|
|
47563
47866
|
*/
|
|
47564
47867
|
|
|
47565
47868
|
/**
|
|
@@ -48226,7 +48529,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48226
48529
|
/**
|
|
48227
48530
|
* WebChat service.
|
|
48228
48531
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
48229
|
-
* @version
|
|
48532
|
+
* @version 141.0.0
|
|
48230
48533
|
*/
|
|
48231
48534
|
|
|
48232
48535
|
/**
|
|
@@ -48770,7 +49073,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48770
49073
|
/**
|
|
48771
49074
|
* WebDeployments service.
|
|
48772
49075
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
48773
|
-
* @version
|
|
49076
|
+
* @version 141.0.0
|
|
48774
49077
|
*/
|
|
48775
49078
|
|
|
48776
49079
|
/**
|
|
@@ -49125,7 +49428,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49125
49428
|
/**
|
|
49126
49429
|
* WebMessaging service.
|
|
49127
49430
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
49128
|
-
* @version
|
|
49431
|
+
* @version 141.0.0
|
|
49129
49432
|
*/
|
|
49130
49433
|
|
|
49131
49434
|
/**
|
|
@@ -49171,7 +49474,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49171
49474
|
/**
|
|
49172
49475
|
* Widgets service.
|
|
49173
49476
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
49174
|
-
* @version
|
|
49477
|
+
* @version 141.0.0
|
|
49175
49478
|
*/
|
|
49176
49479
|
|
|
49177
49480
|
/**
|
|
@@ -49317,7 +49620,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49317
49620
|
/**
|
|
49318
49621
|
* WorkforceManagement service.
|
|
49319
49622
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
49320
|
-
* @version
|
|
49623
|
+
* @version 141.0.0
|
|
49321
49624
|
*/
|
|
49322
49625
|
|
|
49323
49626
|
/**
|
|
@@ -53568,7 +53871,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53568
53871
|
* </pre>
|
|
53569
53872
|
* </p>
|
|
53570
53873
|
* @module purecloud-platform-client-v2/index
|
|
53571
|
-
* @version
|
|
53874
|
+
* @version 141.0.0
|
|
53572
53875
|
*/
|
|
53573
53876
|
class platformClient {
|
|
53574
53877
|
constructor() {
|