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
|
@@ -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 140.0.1
|
|
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 140.0.1
|
|
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 140.0.1
|
|
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 140.0.1
|
|
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 140.0.1
|
|
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 140.0.1
|
|
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 140.0.1
|
|
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 140.0.1
|
|
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 140.0.1
|
|
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 140.0.1
|
|
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 140.0.1
|
|
9262
9264
|
*/
|
|
9263
9265
|
|
|
9264
9266
|
/**
|
|
@@ -13806,6 +13808,126 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13806
13808
|
);
|
|
13807
13809
|
}
|
|
13808
13810
|
|
|
13811
|
+
/**
|
|
13812
|
+
* Update a conversation by setting its recording state
|
|
13813
|
+
*
|
|
13814
|
+
* @param {String} conversationId conversationId
|
|
13815
|
+
* @param {Object} body SetRecordingState
|
|
13816
|
+
*/
|
|
13817
|
+
putConversationsCallRecordingstate(conversationId, body) {
|
|
13818
|
+
// verify the required parameter 'conversationId' is set
|
|
13819
|
+
if (conversationId === undefined || conversationId === null) {
|
|
13820
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationsCallRecordingstate';
|
|
13821
|
+
}
|
|
13822
|
+
// verify the required parameter 'body' is set
|
|
13823
|
+
if (body === undefined || body === null) {
|
|
13824
|
+
throw 'Missing the required parameter "body" when calling putConversationsCallRecordingstate';
|
|
13825
|
+
}
|
|
13826
|
+
|
|
13827
|
+
return this.apiClient.callApi(
|
|
13828
|
+
'/api/v2/conversations/calls/{conversationId}/recordingstate',
|
|
13829
|
+
'PUT',
|
|
13830
|
+
{ 'conversationId': conversationId },
|
|
13831
|
+
{ },
|
|
13832
|
+
{ },
|
|
13833
|
+
{ },
|
|
13834
|
+
body,
|
|
13835
|
+
['PureCloud OAuth'],
|
|
13836
|
+
['application/json'],
|
|
13837
|
+
['application/json']
|
|
13838
|
+
);
|
|
13839
|
+
}
|
|
13840
|
+
|
|
13841
|
+
/**
|
|
13842
|
+
* Update a conversation by setting its recording state
|
|
13843
|
+
*
|
|
13844
|
+
* @param {String} conversationId conversationId
|
|
13845
|
+
* @param {Object} body SetRecordingState
|
|
13846
|
+
*/
|
|
13847
|
+
putConversationsCallbackRecordingstate(conversationId, body) {
|
|
13848
|
+
// verify the required parameter 'conversationId' is set
|
|
13849
|
+
if (conversationId === undefined || conversationId === null) {
|
|
13850
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationsCallbackRecordingstate';
|
|
13851
|
+
}
|
|
13852
|
+
// verify the required parameter 'body' is set
|
|
13853
|
+
if (body === undefined || body === null) {
|
|
13854
|
+
throw 'Missing the required parameter "body" when calling putConversationsCallbackRecordingstate';
|
|
13855
|
+
}
|
|
13856
|
+
|
|
13857
|
+
return this.apiClient.callApi(
|
|
13858
|
+
'/api/v2/conversations/callbacks/{conversationId}/recordingstate',
|
|
13859
|
+
'PUT',
|
|
13860
|
+
{ 'conversationId': conversationId },
|
|
13861
|
+
{ },
|
|
13862
|
+
{ },
|
|
13863
|
+
{ },
|
|
13864
|
+
body,
|
|
13865
|
+
['PureCloud OAuth'],
|
|
13866
|
+
['application/json'],
|
|
13867
|
+
['application/json']
|
|
13868
|
+
);
|
|
13869
|
+
}
|
|
13870
|
+
|
|
13871
|
+
/**
|
|
13872
|
+
* Update a conversation by setting its recording state
|
|
13873
|
+
*
|
|
13874
|
+
* @param {String} conversationId conversationId
|
|
13875
|
+
* @param {Object} body SetRecordingState
|
|
13876
|
+
*/
|
|
13877
|
+
putConversationsChatRecordingstate(conversationId, body) {
|
|
13878
|
+
// verify the required parameter 'conversationId' is set
|
|
13879
|
+
if (conversationId === undefined || conversationId === null) {
|
|
13880
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationsChatRecordingstate';
|
|
13881
|
+
}
|
|
13882
|
+
// verify the required parameter 'body' is set
|
|
13883
|
+
if (body === undefined || body === null) {
|
|
13884
|
+
throw 'Missing the required parameter "body" when calling putConversationsChatRecordingstate';
|
|
13885
|
+
}
|
|
13886
|
+
|
|
13887
|
+
return this.apiClient.callApi(
|
|
13888
|
+
'/api/v2/conversations/chats/{conversationId}/recordingstate',
|
|
13889
|
+
'PUT',
|
|
13890
|
+
{ 'conversationId': conversationId },
|
|
13891
|
+
{ },
|
|
13892
|
+
{ },
|
|
13893
|
+
{ },
|
|
13894
|
+
body,
|
|
13895
|
+
['PureCloud OAuth'],
|
|
13896
|
+
['application/json'],
|
|
13897
|
+
['application/json']
|
|
13898
|
+
);
|
|
13899
|
+
}
|
|
13900
|
+
|
|
13901
|
+
/**
|
|
13902
|
+
* Update a conversation by setting its recording state
|
|
13903
|
+
*
|
|
13904
|
+
* @param {String} conversationId conversationId
|
|
13905
|
+
* @param {Object} body SetRecordingState
|
|
13906
|
+
*/
|
|
13907
|
+
putConversationsCobrowsesessionRecordingstate(conversationId, body) {
|
|
13908
|
+
// verify the required parameter 'conversationId' is set
|
|
13909
|
+
if (conversationId === undefined || conversationId === null) {
|
|
13910
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationsCobrowsesessionRecordingstate';
|
|
13911
|
+
}
|
|
13912
|
+
// verify the required parameter 'body' is set
|
|
13913
|
+
if (body === undefined || body === null) {
|
|
13914
|
+
throw 'Missing the required parameter "body" when calling putConversationsCobrowsesessionRecordingstate';
|
|
13915
|
+
}
|
|
13916
|
+
|
|
13917
|
+
return this.apiClient.callApi(
|
|
13918
|
+
'/api/v2/conversations/cobrowsesessions/{conversationId}/recordingstate',
|
|
13919
|
+
'PUT',
|
|
13920
|
+
{ 'conversationId': conversationId },
|
|
13921
|
+
{ },
|
|
13922
|
+
{ },
|
|
13923
|
+
{ },
|
|
13924
|
+
body,
|
|
13925
|
+
['PureCloud OAuth'],
|
|
13926
|
+
['application/json'],
|
|
13927
|
+
['application/json']
|
|
13928
|
+
);
|
|
13929
|
+
}
|
|
13930
|
+
|
|
13809
13931
|
/**
|
|
13810
13932
|
* Update conversation draft reply
|
|
13811
13933
|
*
|
|
@@ -13836,6 +13958,66 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13836
13958
|
);
|
|
13837
13959
|
}
|
|
13838
13960
|
|
|
13961
|
+
/**
|
|
13962
|
+
* Update a conversation by setting its recording state
|
|
13963
|
+
*
|
|
13964
|
+
* @param {String} conversationId conversationId
|
|
13965
|
+
* @param {Object} body SetRecordingState
|
|
13966
|
+
*/
|
|
13967
|
+
putConversationsEmailRecordingstate(conversationId, body) {
|
|
13968
|
+
// verify the required parameter 'conversationId' is set
|
|
13969
|
+
if (conversationId === undefined || conversationId === null) {
|
|
13970
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationsEmailRecordingstate';
|
|
13971
|
+
}
|
|
13972
|
+
// verify the required parameter 'body' is set
|
|
13973
|
+
if (body === undefined || body === null) {
|
|
13974
|
+
throw 'Missing the required parameter "body" when calling putConversationsEmailRecordingstate';
|
|
13975
|
+
}
|
|
13976
|
+
|
|
13977
|
+
return this.apiClient.callApi(
|
|
13978
|
+
'/api/v2/conversations/emails/{conversationId}/recordingstate',
|
|
13979
|
+
'PUT',
|
|
13980
|
+
{ 'conversationId': conversationId },
|
|
13981
|
+
{ },
|
|
13982
|
+
{ },
|
|
13983
|
+
{ },
|
|
13984
|
+
body,
|
|
13985
|
+
['PureCloud OAuth'],
|
|
13986
|
+
['application/json'],
|
|
13987
|
+
['application/json']
|
|
13988
|
+
);
|
|
13989
|
+
}
|
|
13990
|
+
|
|
13991
|
+
/**
|
|
13992
|
+
* Update a conversation by setting its recording state
|
|
13993
|
+
*
|
|
13994
|
+
* @param {String} conversationId conversationId
|
|
13995
|
+
* @param {Object} body SetRecordingState
|
|
13996
|
+
*/
|
|
13997
|
+
putConversationsMessageRecordingstate(conversationId, body) {
|
|
13998
|
+
// verify the required parameter 'conversationId' is set
|
|
13999
|
+
if (conversationId === undefined || conversationId === null) {
|
|
14000
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationsMessageRecordingstate';
|
|
14001
|
+
}
|
|
14002
|
+
// verify the required parameter 'body' is set
|
|
14003
|
+
if (body === undefined || body === null) {
|
|
14004
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessageRecordingstate';
|
|
14005
|
+
}
|
|
14006
|
+
|
|
14007
|
+
return this.apiClient.callApi(
|
|
14008
|
+
'/api/v2/conversations/messages/{conversationId}/recordingstate',
|
|
14009
|
+
'PUT',
|
|
14010
|
+
{ 'conversationId': conversationId },
|
|
14011
|
+
{ },
|
|
14012
|
+
{ },
|
|
14013
|
+
{ },
|
|
14014
|
+
body,
|
|
14015
|
+
['PureCloud OAuth'],
|
|
14016
|
+
['application/json'],
|
|
14017
|
+
['application/json']
|
|
14018
|
+
);
|
|
14019
|
+
}
|
|
14020
|
+
|
|
13839
14021
|
/**
|
|
13840
14022
|
* Update a LINE messenger integration
|
|
13841
14023
|
*
|
|
@@ -13916,13 +14098,103 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13916
14098
|
);
|
|
13917
14099
|
}
|
|
13918
14100
|
|
|
14101
|
+
/**
|
|
14102
|
+
* Update a conversation by setting its recording state
|
|
14103
|
+
*
|
|
14104
|
+
* @param {String} conversationId conversationId
|
|
14105
|
+
* @param {Object} body SetRecordingState
|
|
14106
|
+
*/
|
|
14107
|
+
putConversationsScreenshareRecordingstate(conversationId, body) {
|
|
14108
|
+
// verify the required parameter 'conversationId' is set
|
|
14109
|
+
if (conversationId === undefined || conversationId === null) {
|
|
14110
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationsScreenshareRecordingstate';
|
|
14111
|
+
}
|
|
14112
|
+
// verify the required parameter 'body' is set
|
|
14113
|
+
if (body === undefined || body === null) {
|
|
14114
|
+
throw 'Missing the required parameter "body" when calling putConversationsScreenshareRecordingstate';
|
|
14115
|
+
}
|
|
14116
|
+
|
|
14117
|
+
return this.apiClient.callApi(
|
|
14118
|
+
'/api/v2/conversations/screenshares/{conversationId}/recordingstate',
|
|
14119
|
+
'PUT',
|
|
14120
|
+
{ 'conversationId': conversationId },
|
|
14121
|
+
{ },
|
|
14122
|
+
{ },
|
|
14123
|
+
{ },
|
|
14124
|
+
body,
|
|
14125
|
+
['PureCloud OAuth'],
|
|
14126
|
+
['application/json'],
|
|
14127
|
+
['application/json']
|
|
14128
|
+
);
|
|
14129
|
+
}
|
|
14130
|
+
|
|
14131
|
+
/**
|
|
14132
|
+
* Update a conversation by setting its recording state
|
|
14133
|
+
*
|
|
14134
|
+
* @param {String} conversationId conversationId
|
|
14135
|
+
* @param {Object} body SetRecordingState
|
|
14136
|
+
*/
|
|
14137
|
+
putConversationsSocialRecordingstate(conversationId, body) {
|
|
14138
|
+
// verify the required parameter 'conversationId' is set
|
|
14139
|
+
if (conversationId === undefined || conversationId === null) {
|
|
14140
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationsSocialRecordingstate';
|
|
14141
|
+
}
|
|
14142
|
+
// verify the required parameter 'body' is set
|
|
14143
|
+
if (body === undefined || body === null) {
|
|
14144
|
+
throw 'Missing the required parameter "body" when calling putConversationsSocialRecordingstate';
|
|
14145
|
+
}
|
|
14146
|
+
|
|
14147
|
+
return this.apiClient.callApi(
|
|
14148
|
+
'/api/v2/conversations/socials/{conversationId}/recordingstate',
|
|
14149
|
+
'PUT',
|
|
14150
|
+
{ 'conversationId': conversationId },
|
|
14151
|
+
{ },
|
|
14152
|
+
{ },
|
|
14153
|
+
{ },
|
|
14154
|
+
body,
|
|
14155
|
+
['PureCloud OAuth'],
|
|
14156
|
+
['application/json'],
|
|
14157
|
+
['application/json']
|
|
14158
|
+
);
|
|
14159
|
+
}
|
|
14160
|
+
|
|
14161
|
+
/**
|
|
14162
|
+
* Update a conversation by setting its recording state
|
|
14163
|
+
*
|
|
14164
|
+
* @param {String} conversationId conversationId
|
|
14165
|
+
* @param {Object} body SetRecordingState
|
|
14166
|
+
*/
|
|
14167
|
+
putConversationsVideoRecordingstate(conversationId, body) {
|
|
14168
|
+
// verify the required parameter 'conversationId' is set
|
|
14169
|
+
if (conversationId === undefined || conversationId === null) {
|
|
14170
|
+
throw 'Missing the required parameter "conversationId" when calling putConversationsVideoRecordingstate';
|
|
14171
|
+
}
|
|
14172
|
+
// verify the required parameter 'body' is set
|
|
14173
|
+
if (body === undefined || body === null) {
|
|
14174
|
+
throw 'Missing the required parameter "body" when calling putConversationsVideoRecordingstate';
|
|
14175
|
+
}
|
|
14176
|
+
|
|
14177
|
+
return this.apiClient.callApi(
|
|
14178
|
+
'/api/v2/conversations/videos/{conversationId}/recordingstate',
|
|
14179
|
+
'PUT',
|
|
14180
|
+
{ 'conversationId': conversationId },
|
|
14181
|
+
{ },
|
|
14182
|
+
{ },
|
|
14183
|
+
{ },
|
|
14184
|
+
body,
|
|
14185
|
+
['PureCloud OAuth'],
|
|
14186
|
+
['application/json'],
|
|
14187
|
+
['application/json']
|
|
14188
|
+
);
|
|
14189
|
+
}
|
|
14190
|
+
|
|
13919
14191
|
}
|
|
13920
14192
|
|
|
13921
14193
|
class DataExtensionsApi {
|
|
13922
14194
|
/**
|
|
13923
14195
|
* DataExtensions service.
|
|
13924
14196
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
13925
|
-
* @version
|
|
14197
|
+
* @version 140.0.1
|
|
13926
14198
|
*/
|
|
13927
14199
|
|
|
13928
14200
|
/**
|
|
@@ -14008,7 +14280,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14008
14280
|
/**
|
|
14009
14281
|
* ExternalContacts service.
|
|
14010
14282
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
14011
|
-
* @version
|
|
14283
|
+
* @version 140.0.1
|
|
14012
14284
|
*/
|
|
14013
14285
|
|
|
14014
14286
|
/**
|
|
@@ -15751,7 +16023,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15751
16023
|
/**
|
|
15752
16024
|
* Fax service.
|
|
15753
16025
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
15754
|
-
* @version
|
|
16026
|
+
* @version 140.0.1
|
|
15755
16027
|
*/
|
|
15756
16028
|
|
|
15757
16029
|
/**
|
|
@@ -15922,7 +16194,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15922
16194
|
/**
|
|
15923
16195
|
* Flows service.
|
|
15924
16196
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
15925
|
-
* @version
|
|
16197
|
+
* @version 140.0.1
|
|
15926
16198
|
*/
|
|
15927
16199
|
|
|
15928
16200
|
/**
|
|
@@ -15993,7 +16265,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15993
16265
|
/**
|
|
15994
16266
|
* Gamification service.
|
|
15995
16267
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
15996
|
-
* @version
|
|
16268
|
+
* @version 140.0.1
|
|
15997
16269
|
*/
|
|
15998
16270
|
|
|
15999
16271
|
/**
|
|
@@ -16138,7 +16410,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16138
16410
|
|
|
16139
16411
|
/**
|
|
16140
16412
|
* Gamified metric by id
|
|
16141
|
-
*
|
|
16413
|
+
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
|
|
16142
16414
|
* @param {String} metricId metric Id
|
|
16143
16415
|
* @param {Object} opts Optional parameters
|
|
16144
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
|
|
@@ -16213,7 +16485,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16213
16485
|
|
|
16214
16486
|
/**
|
|
16215
16487
|
* All gamified metrics for a given profile
|
|
16216
|
-
*
|
|
16488
|
+
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
|
|
16217
16489
|
* @param {Object} opts Optional parameters
|
|
16218
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.
|
|
16219
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
|
|
@@ -16264,18 +16536,18 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16264
16536
|
/**
|
|
16265
16537
|
* Members of a given performance profile
|
|
16266
16538
|
*
|
|
16267
|
-
* @param {String}
|
|
16539
|
+
* @param {String} profileId Profile Id
|
|
16268
16540
|
*/
|
|
16269
|
-
getGamificationProfileMembers(
|
|
16270
|
-
// verify the required parameter '
|
|
16271
|
-
if (
|
|
16272
|
-
throw 'Missing the required parameter "
|
|
16541
|
+
getGamificationProfileMembers(profileId) {
|
|
16542
|
+
// verify the required parameter 'profileId' is set
|
|
16543
|
+
if (profileId === undefined || profileId === null) {
|
|
16544
|
+
throw 'Missing the required parameter "profileId" when calling getGamificationProfileMembers';
|
|
16273
16545
|
}
|
|
16274
16546
|
|
|
16275
16547
|
return this.apiClient.callApi(
|
|
16276
|
-
'/api/v2/gamification/profiles/{
|
|
16548
|
+
'/api/v2/gamification/profiles/{profileId}/members',
|
|
16277
16549
|
'GET',
|
|
16278
|
-
{ '
|
|
16550
|
+
{ 'profileId': profileId },
|
|
16279
16551
|
{ },
|
|
16280
16552
|
{ },
|
|
16281
16553
|
{ },
|
|
@@ -16327,6 +16599,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16327
16599
|
* @param {Object} opts Optional parameters
|
|
16328
16600
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
16329
16601
|
* @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
|
|
16602
|
+
* @param {String} opts.metricIds List of metric ids to filter the response (Optional, comma-separated).
|
|
16330
16603
|
*/
|
|
16331
16604
|
getGamificationProfileMetrics(profileId, opts) {
|
|
16332
16605
|
opts = opts || {};
|
|
@@ -16340,7 +16613,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16340
16613
|
'/api/v2/gamification/profiles/{profileId}/metrics',
|
|
16341
16614
|
'GET',
|
|
16342
16615
|
{ 'profileId': profileId },
|
|
16343
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'workday': opts['workday'] },
|
|
16616
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'workday': opts['workday'],'metricIds': opts['metricIds'] },
|
|
16344
16617
|
{ },
|
|
16345
16618
|
{ },
|
|
16346
16619
|
null,
|
|
@@ -17067,7 +17340,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17067
17340
|
|
|
17068
17341
|
/**
|
|
17069
17342
|
* Creates a gamified metric with a given metric definition and metric objective
|
|
17070
|
-
*
|
|
17343
|
+
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
|
|
17071
17344
|
* @param {Object} body Metric
|
|
17072
17345
|
*/
|
|
17073
17346
|
postGamificationMetrics(body) {
|
|
@@ -17143,13 +17416,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17143
17416
|
/**
|
|
17144
17417
|
* Assign members to a given performance profile
|
|
17145
17418
|
*
|
|
17146
|
-
* @param {String}
|
|
17419
|
+
* @param {String} profileId Profile Id
|
|
17147
17420
|
* @param {Object} body assignUsers
|
|
17148
17421
|
*/
|
|
17149
|
-
postGamificationProfileMembers(
|
|
17150
|
-
// verify the required parameter '
|
|
17151
|
-
if (
|
|
17152
|
-
throw 'Missing the required parameter "
|
|
17422
|
+
postGamificationProfileMembers(profileId, body) {
|
|
17423
|
+
// verify the required parameter 'profileId' is set
|
|
17424
|
+
if (profileId === undefined || profileId === null) {
|
|
17425
|
+
throw 'Missing the required parameter "profileId" when calling postGamificationProfileMembers';
|
|
17153
17426
|
}
|
|
17154
17427
|
// verify the required parameter 'body' is set
|
|
17155
17428
|
if (body === undefined || body === null) {
|
|
@@ -17157,9 +17430,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17157
17430
|
}
|
|
17158
17431
|
|
|
17159
17432
|
return this.apiClient.callApi(
|
|
17160
|
-
'/api/v2/gamification/profiles/{
|
|
17433
|
+
'/api/v2/gamification/profiles/{profileId}/members',
|
|
17161
17434
|
'POST',
|
|
17162
|
-
{ '
|
|
17435
|
+
{ 'profileId': profileId },
|
|
17163
17436
|
{ },
|
|
17164
17437
|
{ },
|
|
17165
17438
|
{ },
|
|
@@ -17173,13 +17446,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17173
17446
|
/**
|
|
17174
17447
|
* Validate member assignment
|
|
17175
17448
|
*
|
|
17176
|
-
* @param {String}
|
|
17449
|
+
* @param {String} profileId Profile Id
|
|
17177
17450
|
* @param {Object} body memberAssignments
|
|
17178
17451
|
*/
|
|
17179
|
-
postGamificationProfileMembersValidate(
|
|
17180
|
-
// verify the required parameter '
|
|
17181
|
-
if (
|
|
17182
|
-
throw 'Missing the required parameter "
|
|
17452
|
+
postGamificationProfileMembersValidate(profileId, body) {
|
|
17453
|
+
// verify the required parameter 'profileId' is set
|
|
17454
|
+
if (profileId === undefined || profileId === null) {
|
|
17455
|
+
throw 'Missing the required parameter "profileId" when calling postGamificationProfileMembersValidate';
|
|
17183
17456
|
}
|
|
17184
17457
|
// verify the required parameter 'body' is set
|
|
17185
17458
|
if (body === undefined || body === null) {
|
|
@@ -17187,9 +17460,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17187
17460
|
}
|
|
17188
17461
|
|
|
17189
17462
|
return this.apiClient.callApi(
|
|
17190
|
-
'/api/v2/gamification/profiles/{
|
|
17463
|
+
'/api/v2/gamification/profiles/{profileId}/members/validate',
|
|
17191
17464
|
'POST',
|
|
17192
|
-
{ '
|
|
17465
|
+
{ 'profileId': profileId },
|
|
17193
17466
|
{ },
|
|
17194
17467
|
{ },
|
|
17195
17468
|
{ },
|
|
@@ -17296,7 +17569,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17296
17569
|
|
|
17297
17570
|
/**
|
|
17298
17571
|
* Updates a metric
|
|
17299
|
-
*
|
|
17572
|
+
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
|
|
17300
17573
|
* @param {String} metricId metric Id
|
|
17301
17574
|
* @param {Object} body Metric
|
|
17302
17575
|
* @param {Object} opts Optional parameters
|
|
@@ -17423,7 +17696,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17423
17696
|
/**
|
|
17424
17697
|
* GeneralDataProtectionRegulation service.
|
|
17425
17698
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
17426
|
-
* @version
|
|
17699
|
+
* @version 140.0.1
|
|
17427
17700
|
*/
|
|
17428
17701
|
|
|
17429
17702
|
/**
|
|
@@ -17553,7 +17826,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17553
17826
|
/**
|
|
17554
17827
|
* Geolocation service.
|
|
17555
17828
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
17556
|
-
* @version
|
|
17829
|
+
* @version 140.0.1
|
|
17557
17830
|
*/
|
|
17558
17831
|
|
|
17559
17832
|
/**
|
|
@@ -17684,7 +17957,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17684
17957
|
/**
|
|
17685
17958
|
* Greetings service.
|
|
17686
17959
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
17687
|
-
* @version
|
|
17960
|
+
* @version 140.0.1
|
|
17688
17961
|
*/
|
|
17689
17962
|
|
|
17690
17963
|
/**
|
|
@@ -18139,7 +18412,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18139
18412
|
/**
|
|
18140
18413
|
* Groups service.
|
|
18141
18414
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
18142
|
-
* @version
|
|
18415
|
+
* @version 140.0.1
|
|
18143
18416
|
*/
|
|
18144
18417
|
|
|
18145
18418
|
/**
|
|
@@ -18544,7 +18817,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18544
18817
|
/**
|
|
18545
18818
|
* IdentityProvider service.
|
|
18546
18819
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
18547
|
-
* @version
|
|
18820
|
+
* @version 140.0.1
|
|
18548
18821
|
*/
|
|
18549
18822
|
|
|
18550
18823
|
/**
|
|
@@ -19300,7 +19573,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19300
19573
|
/**
|
|
19301
19574
|
* Integrations service.
|
|
19302
19575
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
19303
|
-
* @version
|
|
19576
|
+
* @version 140.0.1
|
|
19304
19577
|
*/
|
|
19305
19578
|
|
|
19306
19579
|
/**
|
|
@@ -20977,7 +21250,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20977
21250
|
/**
|
|
20978
21251
|
* Journey service.
|
|
20979
21252
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
20980
|
-
* @version
|
|
21253
|
+
* @version 140.0.1
|
|
20981
21254
|
*/
|
|
20982
21255
|
|
|
20983
21256
|
/**
|
|
@@ -21688,7 +21961,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21688
21961
|
/**
|
|
21689
21962
|
* Knowledge service.
|
|
21690
21963
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
21691
|
-
* @version
|
|
21964
|
+
* @version 140.0.1
|
|
21692
21965
|
*/
|
|
21693
21966
|
|
|
21694
21967
|
/**
|
|
@@ -21866,7 +22139,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21866
22139
|
* @param {Object} opts Optional parameters
|
|
21867
22140
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
21868
22141
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
21869
|
-
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
22142
|
+
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
21870
22143
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
21871
22144
|
* @param {String} opts.name Filter to return the categories that starts with the given category name.
|
|
21872
22145
|
*/
|
|
@@ -21974,7 +22247,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21974
22247
|
* @param {Object} opts Optional parameters
|
|
21975
22248
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
21976
22249
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
21977
|
-
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
22250
|
+
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
21978
22251
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
21979
22252
|
* @param {String} opts.categories Filter by categories ids, comma separated values expected.
|
|
21980
22253
|
* @param {String} opts.title Filter by document title.
|
|
@@ -22086,7 +22359,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22086
22359
|
* @param {Object} opts Optional parameters
|
|
22087
22360
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
22088
22361
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
22089
|
-
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
22362
|
+
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
22090
22363
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
22091
22364
|
* @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
|
|
22092
22365
|
*/
|
|
@@ -22122,7 +22395,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22122
22395
|
* @param {Object} opts Optional parameters
|
|
22123
22396
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
22124
22397
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
22125
|
-
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
22398
|
+
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
22126
22399
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
22127
22400
|
* @param {String} opts.name Filter by Name.
|
|
22128
22401
|
* @param {Object} opts.coreLanguage Filter by core language.
|
|
@@ -22588,7 +22861,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22588
22861
|
/**
|
|
22589
22862
|
* LanguageUnderstanding service.
|
|
22590
22863
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
22591
|
-
* @version
|
|
22864
|
+
* @version 140.0.1
|
|
22592
22865
|
*/
|
|
22593
22866
|
|
|
22594
22867
|
/**
|
|
@@ -23492,7 +23765,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23492
23765
|
/**
|
|
23493
23766
|
* Languages service.
|
|
23494
23767
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
23495
|
-
* @version
|
|
23768
|
+
* @version 140.0.1
|
|
23496
23769
|
*/
|
|
23497
23770
|
|
|
23498
23771
|
/**
|
|
@@ -23760,7 +24033,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23760
24033
|
/**
|
|
23761
24034
|
* Learning service.
|
|
23762
24035
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
23763
|
-
* @version
|
|
24036
|
+
* @version 140.0.1
|
|
23764
24037
|
*/
|
|
23765
24038
|
|
|
23766
24039
|
/**
|
|
@@ -23958,6 +24231,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23958
24231
|
);
|
|
23959
24232
|
}
|
|
23960
24233
|
|
|
24234
|
+
/**
|
|
24235
|
+
* Get a specific Learning Module job status
|
|
24236
|
+
*
|
|
24237
|
+
* @param {String} moduleId The ID of the learning module
|
|
24238
|
+
* @param {String} jobId The ID of the learning module job
|
|
24239
|
+
*/
|
|
24240
|
+
getLearningModuleJob(moduleId, jobId) {
|
|
24241
|
+
// verify the required parameter 'moduleId' is set
|
|
24242
|
+
if (moduleId === undefined || moduleId === null) {
|
|
24243
|
+
throw 'Missing the required parameter "moduleId" when calling getLearningModuleJob';
|
|
24244
|
+
}
|
|
24245
|
+
// verify the required parameter 'jobId' is set
|
|
24246
|
+
if (jobId === undefined || jobId === null) {
|
|
24247
|
+
throw 'Missing the required parameter "jobId" when calling getLearningModuleJob';
|
|
24248
|
+
}
|
|
24249
|
+
|
|
24250
|
+
return this.apiClient.callApi(
|
|
24251
|
+
'/api/v2/learning/modules/{moduleId}/jobs/{jobId}',
|
|
24252
|
+
'GET',
|
|
24253
|
+
{ 'moduleId': moduleId,'jobId': jobId },
|
|
24254
|
+
{ },
|
|
24255
|
+
{ },
|
|
24256
|
+
{ },
|
|
24257
|
+
null,
|
|
24258
|
+
['PureCloud OAuth'],
|
|
24259
|
+
['application/json'],
|
|
24260
|
+
['application/json']
|
|
24261
|
+
);
|
|
24262
|
+
}
|
|
24263
|
+
|
|
23961
24264
|
/**
|
|
23962
24265
|
* Get a learning module rule
|
|
23963
24266
|
*
|
|
@@ -24103,6 +24406,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24103
24406
|
);
|
|
24104
24407
|
}
|
|
24105
24408
|
|
|
24409
|
+
/**
|
|
24410
|
+
* Reassign Learning Assignment
|
|
24411
|
+
* This will reassign the state of the assignment to Assigned and update the assignment to the latest version of the module
|
|
24412
|
+
* @param {String} assignmentId The Learning Assignment ID
|
|
24413
|
+
*/
|
|
24414
|
+
postLearningAssignmentReassign(assignmentId) {
|
|
24415
|
+
// verify the required parameter 'assignmentId' is set
|
|
24416
|
+
if (assignmentId === undefined || assignmentId === null) {
|
|
24417
|
+
throw 'Missing the required parameter "assignmentId" when calling postLearningAssignmentReassign';
|
|
24418
|
+
}
|
|
24419
|
+
|
|
24420
|
+
return this.apiClient.callApi(
|
|
24421
|
+
'/api/v2/learning/assignments/{assignmentId}/reassign',
|
|
24422
|
+
'POST',
|
|
24423
|
+
{ 'assignmentId': assignmentId },
|
|
24424
|
+
{ },
|
|
24425
|
+
{ },
|
|
24426
|
+
{ },
|
|
24427
|
+
null,
|
|
24428
|
+
['PureCloud OAuth'],
|
|
24429
|
+
['application/json'],
|
|
24430
|
+
['application/json']
|
|
24431
|
+
);
|
|
24432
|
+
}
|
|
24433
|
+
|
|
24434
|
+
/**
|
|
24435
|
+
* Reset Learning Assignment
|
|
24436
|
+
* This will reset the state of the assignment to Assigned and remove the version of Learning module associated with the assignment
|
|
24437
|
+
* @param {String} assignmentId The Learning Assignment ID
|
|
24438
|
+
*/
|
|
24439
|
+
postLearningAssignmentReset(assignmentId) {
|
|
24440
|
+
// verify the required parameter 'assignmentId' is set
|
|
24441
|
+
if (assignmentId === undefined || assignmentId === null) {
|
|
24442
|
+
throw 'Missing the required parameter "assignmentId" when calling postLearningAssignmentReset';
|
|
24443
|
+
}
|
|
24444
|
+
|
|
24445
|
+
return this.apiClient.callApi(
|
|
24446
|
+
'/api/v2/learning/assignments/{assignmentId}/reset',
|
|
24447
|
+
'POST',
|
|
24448
|
+
{ 'assignmentId': assignmentId },
|
|
24449
|
+
{ },
|
|
24450
|
+
{ },
|
|
24451
|
+
{ },
|
|
24452
|
+
null,
|
|
24453
|
+
['PureCloud OAuth'],
|
|
24454
|
+
['application/json'],
|
|
24455
|
+
['application/json']
|
|
24456
|
+
);
|
|
24457
|
+
}
|
|
24458
|
+
|
|
24106
24459
|
/**
|
|
24107
24460
|
* Create Learning Assignment
|
|
24108
24461
|
*
|
|
@@ -24200,6 +24553,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24200
24553
|
);
|
|
24201
24554
|
}
|
|
24202
24555
|
|
|
24556
|
+
/**
|
|
24557
|
+
* Starts a specified operation on learning module
|
|
24558
|
+
* This will initiate operation specified in the request body for a learning module
|
|
24559
|
+
* @param {String} moduleId The ID of the learning module
|
|
24560
|
+
* @param {Object} body The learning module job request
|
|
24561
|
+
*/
|
|
24562
|
+
postLearningModuleJobs(moduleId, body) {
|
|
24563
|
+
// verify the required parameter 'moduleId' is set
|
|
24564
|
+
if (moduleId === undefined || moduleId === null) {
|
|
24565
|
+
throw 'Missing the required parameter "moduleId" when calling postLearningModuleJobs';
|
|
24566
|
+
}
|
|
24567
|
+
// verify the required parameter 'body' is set
|
|
24568
|
+
if (body === undefined || body === null) {
|
|
24569
|
+
throw 'Missing the required parameter "body" when calling postLearningModuleJobs';
|
|
24570
|
+
}
|
|
24571
|
+
|
|
24572
|
+
return this.apiClient.callApi(
|
|
24573
|
+
'/api/v2/learning/modules/{moduleId}/jobs',
|
|
24574
|
+
'POST',
|
|
24575
|
+
{ 'moduleId': moduleId },
|
|
24576
|
+
{ },
|
|
24577
|
+
{ },
|
|
24578
|
+
{ },
|
|
24579
|
+
body,
|
|
24580
|
+
['PureCloud OAuth'],
|
|
24581
|
+
['application/json'],
|
|
24582
|
+
['application/json']
|
|
24583
|
+
);
|
|
24584
|
+
}
|
|
24585
|
+
|
|
24203
24586
|
/**
|
|
24204
24587
|
* Publish a Learning module
|
|
24205
24588
|
*
|
|
@@ -24351,7 +24734,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24351
24734
|
/**
|
|
24352
24735
|
* License service.
|
|
24353
24736
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
24354
|
-
* @version
|
|
24737
|
+
* @version 140.0.1
|
|
24355
24738
|
*/
|
|
24356
24739
|
|
|
24357
24740
|
/**
|
|
@@ -24589,7 +24972,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24589
24972
|
/**
|
|
24590
24973
|
* Locations service.
|
|
24591
24974
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
24592
|
-
* @version
|
|
24975
|
+
* @version 140.0.1
|
|
24593
24976
|
*/
|
|
24594
24977
|
|
|
24595
24978
|
/**
|
|
@@ -24825,7 +25208,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24825
25208
|
/**
|
|
24826
25209
|
* Messaging service.
|
|
24827
25210
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
24828
|
-
* @version
|
|
25211
|
+
* @version 140.0.1
|
|
24829
25212
|
*/
|
|
24830
25213
|
|
|
24831
25214
|
/**
|
|
@@ -24976,7 +25359,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24976
25359
|
/**
|
|
24977
25360
|
* MobileDevices service.
|
|
24978
25361
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
24979
|
-
* @version
|
|
25362
|
+
* @version 140.0.1
|
|
24980
25363
|
*/
|
|
24981
25364
|
|
|
24982
25365
|
/**
|
|
@@ -25127,7 +25510,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25127
25510
|
/**
|
|
25128
25511
|
* Notifications service.
|
|
25129
25512
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
25130
|
-
* @version
|
|
25513
|
+
* @version 140.0.1
|
|
25131
25514
|
*/
|
|
25132
25515
|
|
|
25133
25516
|
/**
|
|
@@ -25352,7 +25735,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25352
25735
|
/**
|
|
25353
25736
|
* OAuth service.
|
|
25354
25737
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
25355
|
-
* @version
|
|
25738
|
+
* @version 140.0.1
|
|
25356
25739
|
*/
|
|
25357
25740
|
|
|
25358
25741
|
/**
|
|
@@ -25718,7 +26101,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25718
26101
|
/**
|
|
25719
26102
|
* Objects service.
|
|
25720
26103
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
25721
|
-
* @version
|
|
26104
|
+
* @version 140.0.1
|
|
25722
26105
|
*/
|
|
25723
26106
|
|
|
25724
26107
|
/**
|
|
@@ -25989,7 +26372,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25989
26372
|
/**
|
|
25990
26373
|
* Organization service.
|
|
25991
26374
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
25992
|
-
* @version
|
|
26375
|
+
* @version 140.0.1
|
|
25993
26376
|
*/
|
|
25994
26377
|
|
|
25995
26378
|
/**
|
|
@@ -26392,7 +26775,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26392
26775
|
/**
|
|
26393
26776
|
* OrganizationAuthorization service.
|
|
26394
26777
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
26395
|
-
* @version
|
|
26778
|
+
* @version 140.0.1
|
|
26396
26779
|
*/
|
|
26397
26780
|
|
|
26398
26781
|
/**
|
|
@@ -27317,7 +27700,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27317
27700
|
/**
|
|
27318
27701
|
* Outbound service.
|
|
27319
27702
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
27320
|
-
* @version
|
|
27703
|
+
* @version 140.0.1
|
|
27321
27704
|
*/
|
|
27322
27705
|
|
|
27323
27706
|
/**
|
|
@@ -30572,7 +30955,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30572
30955
|
/**
|
|
30573
30956
|
* Presence service.
|
|
30574
30957
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
30575
|
-
* @version
|
|
30958
|
+
* @version 140.0.1
|
|
30576
30959
|
*/
|
|
30577
30960
|
|
|
30578
30961
|
/**
|
|
@@ -30894,7 +31277,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30894
31277
|
/**
|
|
30895
31278
|
* Quality service.
|
|
30896
31279
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
30897
|
-
* @version
|
|
31280
|
+
* @version 140.0.1
|
|
30898
31281
|
*/
|
|
30899
31282
|
|
|
30900
31283
|
/**
|
|
@@ -31652,7 +32035,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31652
32035
|
/**
|
|
31653
32036
|
* Retrieve a list of the latest form versions by context ids
|
|
31654
32037
|
*
|
|
31655
|
-
* @param {Array.<String>} contextId A comma-delimited list of valid survey form context ids
|
|
32038
|
+
* @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.
|
|
31656
32039
|
* @param {Object} opts Optional parameters
|
|
31657
32040
|
* @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)
|
|
31658
32041
|
*/
|
|
@@ -32472,7 +32855,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32472
32855
|
/**
|
|
32473
32856
|
* Recording service.
|
|
32474
32857
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
32475
|
-
* @version
|
|
32858
|
+
* @version 140.0.1
|
|
32476
32859
|
*/
|
|
32477
32860
|
|
|
32478
32861
|
/**
|
|
@@ -34125,7 +34508,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34125
34508
|
/**
|
|
34126
34509
|
* ResponseManagement service.
|
|
34127
34510
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
34128
|
-
* @version
|
|
34511
|
+
* @version 140.0.1
|
|
34129
34512
|
*/
|
|
34130
34513
|
|
|
34131
34514
|
/**
|
|
@@ -34609,7 +34992,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34609
34992
|
/**
|
|
34610
34993
|
* Routing service.
|
|
34611
34994
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
34612
|
-
* @version
|
|
34995
|
+
* @version 140.0.1
|
|
34613
34996
|
*/
|
|
34614
34997
|
|
|
34615
34998
|
/**
|
|
@@ -34922,12 +35305,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34922
35305
|
* Delete a phone number provisioned for SMS.
|
|
34923
35306
|
*
|
|
34924
35307
|
* @param {String} addressId Address ID
|
|
34925
|
-
* @param {Object} opts Optional parameters
|
|
34926
|
-
* @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)
|
|
34927
35308
|
*/
|
|
34928
|
-
deleteRoutingSmsPhonenumber(addressId
|
|
34929
|
-
opts = opts || {};
|
|
34930
|
-
|
|
35309
|
+
deleteRoutingSmsPhonenumber(addressId) {
|
|
34931
35310
|
// verify the required parameter 'addressId' is set
|
|
34932
35311
|
if (addressId === undefined || addressId === null) {
|
|
34933
35312
|
throw 'Missing the required parameter "addressId" when calling deleteRoutingSmsPhonenumber';
|
|
@@ -34937,7 +35316,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34937
35316
|
'/api/v2/routing/sms/phonenumbers/{addressId}',
|
|
34938
35317
|
'DELETE',
|
|
34939
35318
|
{ 'addressId': addressId },
|
|
34940
|
-
{
|
|
35319
|
+
{ },
|
|
34941
35320
|
{ },
|
|
34942
35321
|
{ },
|
|
34943
35322
|
null,
|
|
@@ -35108,7 +35487,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35108
35487
|
* @param {Object} opts Optional parameters
|
|
35109
35488
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
35110
35489
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
35111
|
-
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
35490
|
+
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
35112
35491
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
35113
35492
|
* @param {Array.<String>} opts.queueId Queue ID(s) to filter assessments by.
|
|
35114
35493
|
*/
|
|
@@ -35419,7 +35798,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35419
35798
|
* @param {Object} opts Optional parameters
|
|
35420
35799
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
35421
35800
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
35422
|
-
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
35801
|
+
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
35423
35802
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
35424
35803
|
* @param {Array.<String>} opts.queueId Comma-separated list of queue Ids to filter by.
|
|
35425
35804
|
*/
|
|
@@ -35442,16 +35821,20 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35442
35821
|
}
|
|
35443
35822
|
|
|
35444
35823
|
/**
|
|
35445
|
-
* Get a list of Key Performance Indicators
|
|
35824
|
+
* Get a list of Key Performance Indicators
|
|
35446
35825
|
*
|
|
35826
|
+
* @param {Object} opts Optional parameters
|
|
35827
|
+
* @param {Object} opts.kpiGroup The Group of Key Performance Indicators to return
|
|
35447
35828
|
*/
|
|
35448
|
-
getRoutingPredictorsKeyperformanceindicators() {
|
|
35829
|
+
getRoutingPredictorsKeyperformanceindicators(opts) {
|
|
35830
|
+
opts = opts || {};
|
|
35831
|
+
|
|
35449
35832
|
|
|
35450
35833
|
return this.apiClient.callApi(
|
|
35451
35834
|
'/api/v2/routing/predictors/keyperformanceindicators',
|
|
35452
35835
|
'GET',
|
|
35453
35836
|
{ },
|
|
35454
|
-
{
|
|
35837
|
+
{ 'kpiGroup': opts['kpiGroup'] },
|
|
35455
35838
|
{ },
|
|
35456
35839
|
{ },
|
|
35457
35840
|
null,
|
|
@@ -37091,12 +37474,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37091
37474
|
* Provision a phone number for SMS
|
|
37092
37475
|
*
|
|
37093
37476
|
* @param {Object} body SmsPhoneNumber
|
|
37094
|
-
* @param {Object} opts Optional parameters
|
|
37095
|
-
* @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)
|
|
37096
37477
|
*/
|
|
37097
|
-
postRoutingSmsPhonenumbers(body
|
|
37098
|
-
opts = opts || {};
|
|
37099
|
-
|
|
37478
|
+
postRoutingSmsPhonenumbers(body) {
|
|
37100
37479
|
// verify the required parameter 'body' is set
|
|
37101
37480
|
if (body === undefined || body === null) {
|
|
37102
37481
|
throw 'Missing the required parameter "body" when calling postRoutingSmsPhonenumbers';
|
|
@@ -37106,7 +37485,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37106
37485
|
'/api/v2/routing/sms/phonenumbers',
|
|
37107
37486
|
'POST',
|
|
37108
37487
|
{ },
|
|
37109
|
-
{
|
|
37488
|
+
{ },
|
|
37110
37489
|
{ },
|
|
37111
37490
|
{ },
|
|
37112
37491
|
body,
|
|
@@ -37351,12 +37730,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37351
37730
|
*
|
|
37352
37731
|
* @param {String} addressId Address ID
|
|
37353
37732
|
* @param {Object} body SmsPhoneNumber
|
|
37354
|
-
* @param {Object} opts Optional parameters
|
|
37355
|
-
* @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)
|
|
37356
37733
|
*/
|
|
37357
|
-
putRoutingSmsPhonenumber(addressId, body
|
|
37358
|
-
opts = opts || {};
|
|
37359
|
-
|
|
37734
|
+
putRoutingSmsPhonenumber(addressId, body) {
|
|
37360
37735
|
// verify the required parameter 'addressId' is set
|
|
37361
37736
|
if (addressId === undefined || addressId === null) {
|
|
37362
37737
|
throw 'Missing the required parameter "addressId" when calling putRoutingSmsPhonenumber';
|
|
@@ -37370,7 +37745,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37370
37745
|
'/api/v2/routing/sms/phonenumbers/{addressId}',
|
|
37371
37746
|
'PUT',
|
|
37372
37747
|
{ 'addressId': addressId },
|
|
37373
|
-
{
|
|
37748
|
+
{ },
|
|
37374
37749
|
{ },
|
|
37375
37750
|
{ },
|
|
37376
37751
|
body,
|
|
@@ -37536,7 +37911,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37536
37911
|
/**
|
|
37537
37912
|
* SCIM service.
|
|
37538
37913
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
37539
|
-
* @version
|
|
37914
|
+
* @version 140.0.1
|
|
37540
37915
|
*/
|
|
37541
37916
|
|
|
37542
37917
|
/**
|
|
@@ -38413,7 +38788,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38413
38788
|
/**
|
|
38414
38789
|
* Scripts service.
|
|
38415
38790
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
38416
|
-
* @version
|
|
38791
|
+
* @version 140.0.1
|
|
38417
38792
|
*/
|
|
38418
38793
|
|
|
38419
38794
|
/**
|
|
@@ -38832,7 +39207,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38832
39207
|
/**
|
|
38833
39208
|
* Search service.
|
|
38834
39209
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
38835
|
-
* @version
|
|
39210
|
+
* @version 140.0.1
|
|
38836
39211
|
*/
|
|
38837
39212
|
|
|
38838
39213
|
/**
|
|
@@ -39367,7 +39742,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39367
39742
|
/**
|
|
39368
39743
|
* SpeechTextAnalytics service.
|
|
39369
39744
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
39370
|
-
* @version
|
|
39745
|
+
* @version 140.0.1
|
|
39371
39746
|
*/
|
|
39372
39747
|
|
|
39373
39748
|
/**
|
|
@@ -40220,7 +40595,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40220
40595
|
/**
|
|
40221
40596
|
* Stations service.
|
|
40222
40597
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
40223
|
-
* @version
|
|
40598
|
+
* @version 140.0.1
|
|
40224
40599
|
*/
|
|
40225
40600
|
|
|
40226
40601
|
/**
|
|
@@ -40367,7 +40742,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40367
40742
|
/**
|
|
40368
40743
|
* Suggest service.
|
|
40369
40744
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
40370
|
-
* @version
|
|
40745
|
+
* @version 140.0.1
|
|
40371
40746
|
*/
|
|
40372
40747
|
|
|
40373
40748
|
/**
|
|
@@ -40506,7 +40881,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40506
40881
|
/**
|
|
40507
40882
|
* Telephony service.
|
|
40508
40883
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
40509
|
-
* @version
|
|
40884
|
+
* @version 140.0.1
|
|
40510
40885
|
*/
|
|
40511
40886
|
|
|
40512
40887
|
/**
|
|
@@ -40614,7 +40989,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40614
40989
|
/**
|
|
40615
40990
|
* TelephonyProvidersEdge service.
|
|
40616
40991
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
40617
|
-
* @version
|
|
40992
|
+
* @version 140.0.1
|
|
40618
40993
|
*/
|
|
40619
40994
|
|
|
40620
40995
|
/**
|
|
@@ -44247,7 +44622,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44247
44622
|
/**
|
|
44248
44623
|
* Textbots service.
|
|
44249
44624
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
44250
|
-
* @version
|
|
44625
|
+
* @version 140.0.1
|
|
44251
44626
|
*/
|
|
44252
44627
|
|
|
44253
44628
|
/**
|
|
@@ -44375,7 +44750,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44375
44750
|
/**
|
|
44376
44751
|
* Tokens service.
|
|
44377
44752
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
44378
|
-
* @version
|
|
44753
|
+
* @version 140.0.1
|
|
44379
44754
|
*/
|
|
44380
44755
|
|
|
44381
44756
|
/**
|
|
@@ -44481,7 +44856,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44481
44856
|
/**
|
|
44482
44857
|
* Uploads service.
|
|
44483
44858
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
44484
|
-
* @version
|
|
44859
|
+
* @version 140.0.1
|
|
44485
44860
|
*/
|
|
44486
44861
|
|
|
44487
44862
|
/**
|
|
@@ -44632,7 +45007,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44632
45007
|
/**
|
|
44633
45008
|
* Usage service.
|
|
44634
45009
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
44635
|
-
* @version
|
|
45010
|
+
* @version 140.0.1
|
|
44636
45011
|
*/
|
|
44637
45012
|
|
|
44638
45013
|
/**
|
|
@@ -44703,7 +45078,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44703
45078
|
/**
|
|
44704
45079
|
* UserRecordings service.
|
|
44705
45080
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
44706
|
-
* @version
|
|
45081
|
+
* @version 140.0.1
|
|
44707
45082
|
*/
|
|
44708
45083
|
|
|
44709
45084
|
/**
|
|
@@ -44887,7 +45262,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44887
45262
|
/**
|
|
44888
45263
|
* Users service.
|
|
44889
45264
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
44890
|
-
* @version
|
|
45265
|
+
* @version 140.0.1
|
|
44891
45266
|
*/
|
|
44892
45267
|
|
|
44893
45268
|
/**
|
|
@@ -45707,18 +46082,18 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45707
46082
|
/**
|
|
45708
46083
|
* Returns a listing of roles and permissions for a user.
|
|
45709
46084
|
*
|
|
45710
|
-
* @param {String}
|
|
46085
|
+
* @param {String} subjectId User ID
|
|
45711
46086
|
*/
|
|
45712
|
-
getUserRoles(
|
|
45713
|
-
// verify the required parameter '
|
|
45714
|
-
if (
|
|
45715
|
-
throw 'Missing the required parameter "
|
|
46087
|
+
getUserRoles(subjectId) {
|
|
46088
|
+
// verify the required parameter 'subjectId' is set
|
|
46089
|
+
if (subjectId === undefined || subjectId === null) {
|
|
46090
|
+
throw 'Missing the required parameter "subjectId" when calling getUserRoles';
|
|
45716
46091
|
}
|
|
45717
46092
|
|
|
45718
46093
|
return this.apiClient.callApi(
|
|
45719
|
-
'/api/v2/users/{
|
|
46094
|
+
'/api/v2/users/{subjectId}/roles',
|
|
45720
46095
|
'GET',
|
|
45721
|
-
{ '
|
|
46096
|
+
{ 'subjectId': subjectId },
|
|
45722
46097
|
{ },
|
|
45723
46098
|
{ },
|
|
45724
46099
|
{ },
|
|
@@ -46971,13 +47346,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46971
47346
|
/**
|
|
46972
47347
|
* Sets the user's roles
|
|
46973
47348
|
*
|
|
46974
|
-
* @param {String}
|
|
47349
|
+
* @param {String} subjectId User ID
|
|
46975
47350
|
* @param {Array.<String>} body List of roles
|
|
46976
47351
|
*/
|
|
46977
|
-
putUserRoles(
|
|
46978
|
-
// verify the required parameter '
|
|
46979
|
-
if (
|
|
46980
|
-
throw 'Missing the required parameter "
|
|
47352
|
+
putUserRoles(subjectId, body) {
|
|
47353
|
+
// verify the required parameter 'subjectId' is set
|
|
47354
|
+
if (subjectId === undefined || subjectId === null) {
|
|
47355
|
+
throw 'Missing the required parameter "subjectId" when calling putUserRoles';
|
|
46981
47356
|
}
|
|
46982
47357
|
// verify the required parameter 'body' is set
|
|
46983
47358
|
if (body === undefined || body === null) {
|
|
@@ -46985,9 +47360,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46985
47360
|
}
|
|
46986
47361
|
|
|
46987
47362
|
return this.apiClient.callApi(
|
|
46988
|
-
'/api/v2/users/{
|
|
47363
|
+
'/api/v2/users/{subjectId}/roles',
|
|
46989
47364
|
'PUT',
|
|
46990
|
-
{ '
|
|
47365
|
+
{ 'subjectId': subjectId },
|
|
46991
47366
|
{ },
|
|
46992
47367
|
{ },
|
|
46993
47368
|
{ },
|
|
@@ -47189,7 +47564,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47189
47564
|
/**
|
|
47190
47565
|
* Utilities service.
|
|
47191
47566
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
47192
|
-
* @version
|
|
47567
|
+
* @version 140.0.1
|
|
47193
47568
|
*/
|
|
47194
47569
|
|
|
47195
47570
|
/**
|
|
@@ -47300,7 +47675,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47300
47675
|
/**
|
|
47301
47676
|
* Voicemail service.
|
|
47302
47677
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
47303
|
-
* @version
|
|
47678
|
+
* @version 140.0.1
|
|
47304
47679
|
*/
|
|
47305
47680
|
|
|
47306
47681
|
/**
|
|
@@ -47967,7 +48342,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47967
48342
|
/**
|
|
47968
48343
|
* WebChat service.
|
|
47969
48344
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
47970
|
-
* @version
|
|
48345
|
+
* @version 140.0.1
|
|
47971
48346
|
*/
|
|
47972
48347
|
|
|
47973
48348
|
/**
|
|
@@ -48511,7 +48886,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48511
48886
|
/**
|
|
48512
48887
|
* WebDeployments service.
|
|
48513
48888
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
48514
|
-
* @version
|
|
48889
|
+
* @version 140.0.1
|
|
48515
48890
|
*/
|
|
48516
48891
|
|
|
48517
48892
|
/**
|
|
@@ -48866,7 +49241,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48866
49241
|
/**
|
|
48867
49242
|
* WebMessaging service.
|
|
48868
49243
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
48869
|
-
* @version
|
|
49244
|
+
* @version 140.0.1
|
|
48870
49245
|
*/
|
|
48871
49246
|
|
|
48872
49247
|
/**
|
|
@@ -48912,7 +49287,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48912
49287
|
/**
|
|
48913
49288
|
* Widgets service.
|
|
48914
49289
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
48915
|
-
* @version
|
|
49290
|
+
* @version 140.0.1
|
|
48916
49291
|
*/
|
|
48917
49292
|
|
|
48918
49293
|
/**
|
|
@@ -49058,7 +49433,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49058
49433
|
/**
|
|
49059
49434
|
* WorkforceManagement service.
|
|
49060
49435
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
49061
|
-
* @version
|
|
49436
|
+
* @version 140.0.1
|
|
49062
49437
|
*/
|
|
49063
49438
|
|
|
49064
49439
|
/**
|
|
@@ -53309,7 +53684,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53309
53684
|
* </pre>
|
|
53310
53685
|
* </p>
|
|
53311
53686
|
* @module purecloud-platform-client-v2/index
|
|
53312
|
-
* @version
|
|
53687
|
+
* @version 140.0.1
|
|
53313
53688
|
*/
|
|
53314
53689
|
class platformClient {
|
|
53315
53690
|
constructor() {
|