purecloud-platform-client-v2 131.1.0 → 132.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 +94 -81
- package/dist/web-amd/purecloud-platform-client-v2.js +95 -82
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +100 -87
- package/dist/web-cjs/purecloud-platform-client-v2.js +3747 -942
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +65 -10
- package/package.json +9 -9
- package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +2 -2
- 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 +7 -3
- 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 +1 -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 +7 -3
- 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 +8 -5
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -1,8 +1,10 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
var superagent = require('superagent');
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
|
|
6
|
+
|
|
7
|
+
var superagent__default = /*#__PURE__*/_interopDefaultLegacy(superagent);
|
|
6
8
|
|
|
7
9
|
var PureCloudRegionHosts = {
|
|
8
10
|
us_east_1: 'mypurecloud.com',
|
|
@@ -393,7 +395,7 @@ class Configuration {
|
|
|
393
395
|
|
|
394
396
|
/**
|
|
395
397
|
* @module purecloud-platform-client-v2/ApiClient
|
|
396
|
-
* @version
|
|
398
|
+
* @version 132.0.0
|
|
397
399
|
*/
|
|
398
400
|
class ApiClient {
|
|
399
401
|
/**
|
|
@@ -497,7 +499,7 @@ class ApiClient {
|
|
|
497
499
|
this.settingsPrefix = 'purecloud';
|
|
498
500
|
|
|
499
501
|
// Expose superagent module for use with superagent-proxy
|
|
500
|
-
this.superagent =
|
|
502
|
+
this.superagent = superagent__default["default"];
|
|
501
503
|
|
|
502
504
|
// Transparently request a new access token when it expires (Code Authorization only)
|
|
503
505
|
this.refreshInProgress = false;
|
|
@@ -668,7 +670,7 @@ class ApiClient {
|
|
|
668
670
|
}
|
|
669
671
|
|
|
670
672
|
// Build token request
|
|
671
|
-
var request =
|
|
673
|
+
var request = superagent__default["default"]('POST', `https://login.${this.config.environment}/oauth/token`);
|
|
672
674
|
if (this.proxy && request.proxy) {
|
|
673
675
|
request.proxy(this.proxy);
|
|
674
676
|
}
|
|
@@ -924,7 +926,7 @@ class ApiClient {
|
|
|
924
926
|
* @param {string} encodedData - Base64 encoded client and clientSecret pair
|
|
925
927
|
*/
|
|
926
928
|
_formAuthRequest(encodedData) {
|
|
927
|
-
var request =
|
|
929
|
+
var request = superagent__default["default"]('POST', `https://login.${this.config.environment}/oauth/token`);
|
|
928
930
|
// Set the headers
|
|
929
931
|
request.set('Authorization', 'Basic ' + encodedData);
|
|
930
932
|
request.set('Content-Type', 'application/x-www-form-urlencoded');
|
|
@@ -1326,7 +1328,7 @@ class ApiClient {
|
|
|
1326
1328
|
sendRequest(this);
|
|
1327
1329
|
function sendRequest(that) {
|
|
1328
1330
|
var url = that.buildUrl(path, pathParams);
|
|
1329
|
-
var request =
|
|
1331
|
+
var request = superagent__default["default"](httpMethod, url);
|
|
1330
1332
|
|
|
1331
1333
|
if (that.proxy && request.proxy) {
|
|
1332
1334
|
request.proxy(that.proxy);
|
|
@@ -1340,7 +1342,7 @@ class ApiClient {
|
|
|
1340
1342
|
|
|
1341
1343
|
// set header parameters
|
|
1342
1344
|
request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
|
|
1343
|
-
//request.set({ 'purecloud-sdk': '
|
|
1345
|
+
//request.set({ 'purecloud-sdk': '132.0.0' });
|
|
1344
1346
|
|
|
1345
1347
|
// set request timeout
|
|
1346
1348
|
request.timeout(that.timeout);
|
|
@@ -1440,7 +1442,7 @@ class AlertingApi {
|
|
|
1440
1442
|
/**
|
|
1441
1443
|
* Alerting service.
|
|
1442
1444
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1443
|
-
* @version
|
|
1445
|
+
* @version 132.0.0
|
|
1444
1446
|
*/
|
|
1445
1447
|
|
|
1446
1448
|
/**
|
|
@@ -1754,7 +1756,7 @@ class AnalyticsApi {
|
|
|
1754
1756
|
/**
|
|
1755
1757
|
* Analytics service.
|
|
1756
1758
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1757
|
-
* @version
|
|
1759
|
+
* @version 132.0.0
|
|
1758
1760
|
*/
|
|
1759
1761
|
|
|
1760
1762
|
/**
|
|
@@ -2936,7 +2938,7 @@ class ArchitectApi {
|
|
|
2936
2938
|
/**
|
|
2937
2939
|
* Architect service.
|
|
2938
2940
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
2939
|
-
* @version
|
|
2941
|
+
* @version 132.0.0
|
|
2940
2942
|
*/
|
|
2941
2943
|
|
|
2942
2944
|
/**
|
|
@@ -5932,7 +5934,7 @@ class AuditApi {
|
|
|
5932
5934
|
/**
|
|
5933
5935
|
* Audit service.
|
|
5934
5936
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
5935
|
-
* @version
|
|
5937
|
+
* @version 132.0.0
|
|
5936
5938
|
*/
|
|
5937
5939
|
|
|
5938
5940
|
/**
|
|
@@ -6103,7 +6105,7 @@ class AuthorizationApi {
|
|
|
6103
6105
|
/**
|
|
6104
6106
|
* Authorization service.
|
|
6105
6107
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
6106
|
-
* @version
|
|
6108
|
+
* @version 132.0.0
|
|
6107
6109
|
*/
|
|
6108
6110
|
|
|
6109
6111
|
/**
|
|
@@ -7286,7 +7288,7 @@ class BillingApi {
|
|
|
7286
7288
|
/**
|
|
7287
7289
|
* Billing service.
|
|
7288
7290
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
7289
|
-
* @version
|
|
7291
|
+
* @version 132.0.0
|
|
7290
7292
|
*/
|
|
7291
7293
|
|
|
7292
7294
|
/**
|
|
@@ -7366,7 +7368,7 @@ class ChatApi {
|
|
|
7366
7368
|
/**
|
|
7367
7369
|
* Chat service.
|
|
7368
7370
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
7369
|
-
* @version
|
|
7371
|
+
* @version 132.0.0
|
|
7370
7372
|
*/
|
|
7371
7373
|
|
|
7372
7374
|
/**
|
|
@@ -7457,7 +7459,7 @@ class CoachingApi {
|
|
|
7457
7459
|
/**
|
|
7458
7460
|
* Coaching service.
|
|
7459
7461
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
7460
|
-
* @version
|
|
7462
|
+
* @version 132.0.0
|
|
7461
7463
|
*/
|
|
7462
7464
|
|
|
7463
7465
|
/**
|
|
@@ -8034,7 +8036,7 @@ class ContentManagementApi {
|
|
|
8034
8036
|
/**
|
|
8035
8037
|
* ContentManagement service.
|
|
8036
8038
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8037
|
-
* @version
|
|
8039
|
+
* @version 132.0.0
|
|
8038
8040
|
*/
|
|
8039
8041
|
|
|
8040
8042
|
/**
|
|
@@ -9174,7 +9176,7 @@ class ConversationsApi {
|
|
|
9174
9176
|
/**
|
|
9175
9177
|
* Conversations service.
|
|
9176
9178
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9177
|
-
* @version
|
|
9179
|
+
* @version 132.0.0
|
|
9178
9180
|
*/
|
|
9179
9181
|
|
|
9180
9182
|
/**
|
|
@@ -13324,7 +13326,7 @@ class ConversationsApi {
|
|
|
13324
13326
|
|
|
13325
13327
|
/**
|
|
13326
13328
|
* Send an agentless outbound message
|
|
13327
|
-
* Send an
|
|
13329
|
+
* Send an agentless (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will generate a new Conversation, if there is an existing active Conversation between the fromAddress and toAddress already, then this POST will fail.
|
|
13328
13330
|
* @param {Object} body Create agentless outbound messaging request
|
|
13329
13331
|
*/
|
|
13330
13332
|
postConversationsMessagesAgentless(body) {
|
|
@@ -13738,7 +13740,7 @@ class DataExtensionsApi {
|
|
|
13738
13740
|
/**
|
|
13739
13741
|
* DataExtensions service.
|
|
13740
13742
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
13741
|
-
* @version
|
|
13743
|
+
* @version 132.0.0
|
|
13742
13744
|
*/
|
|
13743
13745
|
|
|
13744
13746
|
/**
|
|
@@ -13824,7 +13826,7 @@ class ExternalContactsApi {
|
|
|
13824
13826
|
/**
|
|
13825
13827
|
* ExternalContacts service.
|
|
13826
13828
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
13827
|
-
* @version
|
|
13829
|
+
* @version 132.0.0
|
|
13828
13830
|
*/
|
|
13829
13831
|
|
|
13830
13832
|
/**
|
|
@@ -15567,7 +15569,7 @@ class FaxApi {
|
|
|
15567
15569
|
/**
|
|
15568
15570
|
* Fax service.
|
|
15569
15571
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
15570
|
-
* @version
|
|
15572
|
+
* @version 132.0.0
|
|
15571
15573
|
*/
|
|
15572
15574
|
|
|
15573
15575
|
/**
|
|
@@ -15738,7 +15740,7 @@ class FlowsApi {
|
|
|
15738
15740
|
/**
|
|
15739
15741
|
* Flows service.
|
|
15740
15742
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
15741
|
-
* @version
|
|
15743
|
+
* @version 132.0.0
|
|
15742
15744
|
*/
|
|
15743
15745
|
|
|
15744
15746
|
/**
|
|
@@ -15809,7 +15811,7 @@ class GamificationApi {
|
|
|
15809
15811
|
/**
|
|
15810
15812
|
* Gamification service.
|
|
15811
15813
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
15812
|
-
* @version
|
|
15814
|
+
* @version 132.0.0
|
|
15813
15815
|
*/
|
|
15814
15816
|
|
|
15815
15817
|
/**
|
|
@@ -17085,8 +17087,12 @@ class GamificationApi {
|
|
|
17085
17087
|
* Create a new custom performance profile
|
|
17086
17088
|
*
|
|
17087
17089
|
* @param {Object} body performanceProfile
|
|
17090
|
+
* @param {Object} opts Optional parameters
|
|
17091
|
+
* @param {Boolean} opts.copyMetrics Flag to copy metrics. If set to false, there will be no metrics associated with the new profile. If set to true or is absent (the default behavior), all metrics from the default profile will be copied over into the new profile. (default to true)
|
|
17088
17092
|
*/
|
|
17089
|
-
postGamificationProfiles(body) {
|
|
17093
|
+
postGamificationProfiles(body, opts) {
|
|
17094
|
+
opts = opts || {};
|
|
17095
|
+
|
|
17090
17096
|
// verify the required parameter 'body' is set
|
|
17091
17097
|
if (body === undefined || body === null) {
|
|
17092
17098
|
throw 'Missing the required parameter "body" when calling postGamificationProfiles';
|
|
@@ -17096,7 +17102,7 @@ class GamificationApi {
|
|
|
17096
17102
|
'/api/v2/gamification/profiles',
|
|
17097
17103
|
'POST',
|
|
17098
17104
|
{ },
|
|
17099
|
-
{
|
|
17105
|
+
{ 'copyMetrics': opts['copyMetrics'] },
|
|
17100
17106
|
{ },
|
|
17101
17107
|
{ },
|
|
17102
17108
|
body,
|
|
@@ -17235,7 +17241,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
17235
17241
|
/**
|
|
17236
17242
|
* GeneralDataProtectionRegulation service.
|
|
17237
17243
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
17238
|
-
* @version
|
|
17244
|
+
* @version 132.0.0
|
|
17239
17245
|
*/
|
|
17240
17246
|
|
|
17241
17247
|
/**
|
|
@@ -17365,7 +17371,7 @@ class GeolocationApi {
|
|
|
17365
17371
|
/**
|
|
17366
17372
|
* Geolocation service.
|
|
17367
17373
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
17368
|
-
* @version
|
|
17374
|
+
* @version 132.0.0
|
|
17369
17375
|
*/
|
|
17370
17376
|
|
|
17371
17377
|
/**
|
|
@@ -17496,7 +17502,7 @@ class GreetingsApi {
|
|
|
17496
17502
|
/**
|
|
17497
17503
|
* Greetings service.
|
|
17498
17504
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
17499
|
-
* @version
|
|
17505
|
+
* @version 132.0.0
|
|
17500
17506
|
*/
|
|
17501
17507
|
|
|
17502
17508
|
/**
|
|
@@ -17951,7 +17957,7 @@ class GroupsApi {
|
|
|
17951
17957
|
/**
|
|
17952
17958
|
* Groups service.
|
|
17953
17959
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
17954
|
-
* @version
|
|
17960
|
+
* @version 132.0.0
|
|
17955
17961
|
*/
|
|
17956
17962
|
|
|
17957
17963
|
/**
|
|
@@ -18356,7 +18362,7 @@ class IdentityProviderApi {
|
|
|
18356
18362
|
/**
|
|
18357
18363
|
* IdentityProvider service.
|
|
18358
18364
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
18359
|
-
* @version
|
|
18365
|
+
* @version 132.0.0
|
|
18360
18366
|
*/
|
|
18361
18367
|
|
|
18362
18368
|
/**
|
|
@@ -19112,7 +19118,7 @@ class IntegrationsApi {
|
|
|
19112
19118
|
/**
|
|
19113
19119
|
* Integrations service.
|
|
19114
19120
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
19115
|
-
* @version
|
|
19121
|
+
* @version 132.0.0
|
|
19116
19122
|
*/
|
|
19117
19123
|
|
|
19118
19124
|
/**
|
|
@@ -20787,7 +20793,7 @@ class JourneyApi {
|
|
|
20787
20793
|
/**
|
|
20788
20794
|
* Journey service.
|
|
20789
20795
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
20790
|
-
* @version
|
|
20796
|
+
* @version 132.0.0
|
|
20791
20797
|
*/
|
|
20792
20798
|
|
|
20793
20799
|
/**
|
|
@@ -21498,7 +21504,7 @@ class KnowledgeApi {
|
|
|
21498
21504
|
/**
|
|
21499
21505
|
* Knowledge service.
|
|
21500
21506
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
21501
|
-
* @version
|
|
21507
|
+
* @version 132.0.0
|
|
21502
21508
|
*/
|
|
21503
21509
|
|
|
21504
21510
|
/**
|
|
@@ -22398,7 +22404,7 @@ class LanguageUnderstandingApi {
|
|
|
22398
22404
|
/**
|
|
22399
22405
|
* LanguageUnderstanding service.
|
|
22400
22406
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
22401
|
-
* @version
|
|
22407
|
+
* @version 132.0.0
|
|
22402
22408
|
*/
|
|
22403
22409
|
|
|
22404
22410
|
/**
|
|
@@ -23302,7 +23308,7 @@ class LanguagesApi {
|
|
|
23302
23308
|
/**
|
|
23303
23309
|
* Languages service.
|
|
23304
23310
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
23305
|
-
* @version
|
|
23311
|
+
* @version 132.0.0
|
|
23306
23312
|
*/
|
|
23307
23313
|
|
|
23308
23314
|
/**
|
|
@@ -23570,7 +23576,7 @@ class LearningApi {
|
|
|
23570
23576
|
/**
|
|
23571
23577
|
* Learning service.
|
|
23572
23578
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
23573
|
-
* @version
|
|
23579
|
+
* @version 132.0.0
|
|
23574
23580
|
*/
|
|
23575
23581
|
|
|
23576
23582
|
/**
|
|
@@ -24161,7 +24167,7 @@ class LicenseApi {
|
|
|
24161
24167
|
/**
|
|
24162
24168
|
* License service.
|
|
24163
24169
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
24164
|
-
* @version
|
|
24170
|
+
* @version 132.0.0
|
|
24165
24171
|
*/
|
|
24166
24172
|
|
|
24167
24173
|
/**
|
|
@@ -24399,7 +24405,7 @@ class LocationsApi {
|
|
|
24399
24405
|
/**
|
|
24400
24406
|
* Locations service.
|
|
24401
24407
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
24402
|
-
* @version
|
|
24408
|
+
* @version 132.0.0
|
|
24403
24409
|
*/
|
|
24404
24410
|
|
|
24405
24411
|
/**
|
|
@@ -24635,7 +24641,7 @@ class MessagingApi {
|
|
|
24635
24641
|
/**
|
|
24636
24642
|
* Messaging service.
|
|
24637
24643
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
24638
|
-
* @version
|
|
24644
|
+
* @version 132.0.0
|
|
24639
24645
|
*/
|
|
24640
24646
|
|
|
24641
24647
|
/**
|
|
@@ -24786,7 +24792,7 @@ class MobileDevicesApi {
|
|
|
24786
24792
|
/**
|
|
24787
24793
|
* MobileDevices service.
|
|
24788
24794
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
24789
|
-
* @version
|
|
24795
|
+
* @version 132.0.0
|
|
24790
24796
|
*/
|
|
24791
24797
|
|
|
24792
24798
|
/**
|
|
@@ -24937,7 +24943,7 @@ class NotificationsApi {
|
|
|
24937
24943
|
/**
|
|
24938
24944
|
* Notifications service.
|
|
24939
24945
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
24940
|
-
* @version
|
|
24946
|
+
* @version 132.0.0
|
|
24941
24947
|
*/
|
|
24942
24948
|
|
|
24943
24949
|
/**
|
|
@@ -25162,7 +25168,7 @@ class OAuthApi {
|
|
|
25162
25168
|
/**
|
|
25163
25169
|
* OAuth service.
|
|
25164
25170
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
25165
|
-
* @version
|
|
25171
|
+
* @version 132.0.0
|
|
25166
25172
|
*/
|
|
25167
25173
|
|
|
25168
25174
|
/**
|
|
@@ -25520,7 +25526,7 @@ class ObjectsApi {
|
|
|
25520
25526
|
/**
|
|
25521
25527
|
* Objects service.
|
|
25522
25528
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
25523
|
-
* @version
|
|
25529
|
+
* @version 132.0.0
|
|
25524
25530
|
*/
|
|
25525
25531
|
|
|
25526
25532
|
/**
|
|
@@ -25791,7 +25797,7 @@ class OrganizationApi {
|
|
|
25791
25797
|
/**
|
|
25792
25798
|
* Organization service.
|
|
25793
25799
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
25794
|
-
* @version
|
|
25800
|
+
* @version 132.0.0
|
|
25795
25801
|
*/
|
|
25796
25802
|
|
|
25797
25803
|
/**
|
|
@@ -26194,7 +26200,7 @@ class OrganizationAuthorizationApi {
|
|
|
26194
26200
|
/**
|
|
26195
26201
|
* OrganizationAuthorization service.
|
|
26196
26202
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
26197
|
-
* @version
|
|
26203
|
+
* @version 132.0.0
|
|
26198
26204
|
*/
|
|
26199
26205
|
|
|
26200
26206
|
/**
|
|
@@ -27119,7 +27125,7 @@ class OutboundApi {
|
|
|
27119
27125
|
/**
|
|
27120
27126
|
* Outbound service.
|
|
27121
27127
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
27122
|
-
* @version
|
|
27128
|
+
* @version 132.0.0
|
|
27123
27129
|
*/
|
|
27124
27130
|
|
|
27125
27131
|
/**
|
|
@@ -29504,8 +29510,12 @@ class OutboundApi {
|
|
|
29504
29510
|
* Only Internal DNC lists may be appended to
|
|
29505
29511
|
* @param {String} dncListId DncList ID
|
|
29506
29512
|
* @param {Array.<Object>} body DNC Phone Numbers
|
|
29513
|
+
* @param {Object} opts Optional parameters
|
|
29514
|
+
* @param {String} opts.expirationDateTime Expiration date for DNC phone numbers in yyyy-MM-ddTHH:mmZ format
|
|
29507
29515
|
*/
|
|
29508
|
-
postOutboundDnclistPhonenumbers(dncListId, body) {
|
|
29516
|
+
postOutboundDnclistPhonenumbers(dncListId, body, opts) {
|
|
29517
|
+
opts = opts || {};
|
|
29518
|
+
|
|
29509
29519
|
// verify the required parameter 'dncListId' is set
|
|
29510
29520
|
if (dncListId === undefined || dncListId === null) {
|
|
29511
29521
|
throw 'Missing the required parameter "dncListId" when calling postOutboundDnclistPhonenumbers';
|
|
@@ -29519,7 +29529,7 @@ class OutboundApi {
|
|
|
29519
29529
|
'/api/v2/outbound/dnclists/{dncListId}/phonenumbers',
|
|
29520
29530
|
'POST',
|
|
29521
29531
|
{ 'dncListId': dncListId },
|
|
29522
|
-
{
|
|
29532
|
+
{ 'expirationDateTime': opts['expirationDateTime'] },
|
|
29523
29533
|
{ },
|
|
29524
29534
|
{ },
|
|
29525
29535
|
body,
|
|
@@ -30145,7 +30155,7 @@ class PresenceApi {
|
|
|
30145
30155
|
/**
|
|
30146
30156
|
* Presence service.
|
|
30147
30157
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
30148
|
-
* @version
|
|
30158
|
+
* @version 132.0.0
|
|
30149
30159
|
*/
|
|
30150
30160
|
|
|
30151
30161
|
/**
|
|
@@ -30517,7 +30527,7 @@ class QualityApi {
|
|
|
30517
30527
|
/**
|
|
30518
30528
|
* Quality service.
|
|
30519
30529
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
30520
|
-
* @version
|
|
30530
|
+
* @version 132.0.0
|
|
30521
30531
|
*/
|
|
30522
30532
|
|
|
30523
30533
|
/**
|
|
@@ -30673,7 +30683,7 @@ class QualityApi {
|
|
|
30673
30683
|
|
|
30674
30684
|
/**
|
|
30675
30685
|
* Gets a list of Agent Activities
|
|
30676
|
-
*
|
|
30686
|
+
* Each item on the list shows one agent's evaluation activity comprised of the number of evaluations and the highest, average, and lowest standard and critical scores, as well as a sub list showing the number and average score of evaluations for each evaluator for that agent. evaluatorUserId, startTime, and endTime are all filtering criteria. If specified, the only evaluations used to compile the agent activity response will be ones that match the filtering criteria. agentUserId, name, group, and agentTeamId are all agent selection criteria. criteria. If one or more agent selection criteria are specified, then the returned activity will include users that match the criteria even if those users did not have any agent activity or evaluations that do not match any filtering criteria. If no agent selection criteria are specified but an evaluatorUserId is, then the returned activity will be only for those agents that had evaluations where the evaluator is the evaluatorUserId. If no agent selection criteria are specified and no evaluatorUserId is specified, then the returned activity will be for all users
|
|
30677
30687
|
* @param {Object} opts Optional parameters
|
|
30678
30688
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
30679
30689
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
@@ -32095,7 +32105,7 @@ class RecordingApi {
|
|
|
32095
32105
|
/**
|
|
32096
32106
|
* Recording service.
|
|
32097
32107
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
32098
|
-
* @version
|
|
32108
|
+
* @version 132.0.0
|
|
32099
32109
|
*/
|
|
32100
32110
|
|
|
32101
32111
|
/**
|
|
@@ -32308,6 +32318,7 @@ class RecordingApi {
|
|
|
32308
32318
|
* @param {Boolean} opts.download requesting a download format of the recording. Valid values:true,false (default to false)
|
|
32309
32319
|
* @param {String} opts.fileName the name of the downloaded fileName
|
|
32310
32320
|
* @param {String} opts.locale The locale for the requested file when downloading, as an ISO 639-1 code
|
|
32321
|
+
* @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3
|
|
32311
32322
|
*/
|
|
32312
32323
|
getConversationRecording(conversationId, recordingId, opts) {
|
|
32313
32324
|
opts = opts || {};
|
|
@@ -32325,7 +32336,7 @@ class RecordingApi {
|
|
|
32325
32336
|
'/api/v2/conversations/{conversationId}/recordings/{recordingId}',
|
|
32326
32337
|
'GET',
|
|
32327
32338
|
{ 'conversationId': conversationId,'recordingId': recordingId },
|
|
32328
|
-
{ 'formatId': opts['formatId'],'emailFormatId': opts['emailFormatId'],'chatFormatId': opts['chatFormatId'],'messageFormatId': opts['messageFormatId'],'download': opts['download'],'fileName': opts['fileName'],'locale': opts['locale'] },
|
|
32339
|
+
{ 'formatId': opts['formatId'],'emailFormatId': opts['emailFormatId'],'chatFormatId': opts['chatFormatId'],'messageFormatId': opts['messageFormatId'],'download': opts['download'],'fileName': opts['fileName'],'locale': opts['locale'],'mediaFormats': this.apiClient.buildCollectionParam(opts['mediaFormats'], 'multi') },
|
|
32329
32340
|
{ },
|
|
32330
32341
|
{ },
|
|
32331
32342
|
null,
|
|
@@ -32461,7 +32472,8 @@ class RecordingApi {
|
|
|
32461
32472
|
* @param {String} conversationId Conversation ID
|
|
32462
32473
|
* @param {Object} opts Optional parameters
|
|
32463
32474
|
* @param {Number} opts.maxWaitMs The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value. (default to 5000)
|
|
32464
|
-
* @param {Object} opts.formatId The desired media format
|
|
32475
|
+
* @param {Object} opts.formatId The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE. (default to WEBM)
|
|
32476
|
+
* @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3.
|
|
32465
32477
|
*/
|
|
32466
32478
|
getConversationRecordings(conversationId, opts) {
|
|
32467
32479
|
opts = opts || {};
|
|
@@ -32475,7 +32487,7 @@ class RecordingApi {
|
|
|
32475
32487
|
'/api/v2/conversations/{conversationId}/recordings',
|
|
32476
32488
|
'GET',
|
|
32477
32489
|
{ 'conversationId': conversationId },
|
|
32478
|
-
{ 'maxWaitMs': opts['maxWaitMs'],'formatId': opts['formatId'] },
|
|
32490
|
+
{ 'maxWaitMs': opts['maxWaitMs'],'formatId': opts['formatId'],'mediaFormats': this.apiClient.buildCollectionParam(opts['mediaFormats'], 'multi') },
|
|
32479
32491
|
{ },
|
|
32480
32492
|
{ },
|
|
32481
32493
|
null,
|
|
@@ -32522,6 +32534,7 @@ class RecordingApi {
|
|
|
32522
32534
|
* @param {Boolean} opts.download requesting a download format of the recording (default to false)
|
|
32523
32535
|
* @param {String} opts.fileName the name of the downloaded fileName
|
|
32524
32536
|
* @param {String} opts.locale The locale for the requested file when downloading, as an ISO 639-1 code
|
|
32537
|
+
* @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3
|
|
32525
32538
|
*/
|
|
32526
32539
|
getOrphanrecordingMedia(orphanId, opts) {
|
|
32527
32540
|
opts = opts || {};
|
|
@@ -32535,7 +32548,7 @@ class RecordingApi {
|
|
|
32535
32548
|
'/api/v2/orphanrecordings/{orphanId}/media',
|
|
32536
32549
|
'GET',
|
|
32537
32550
|
{ 'orphanId': orphanId },
|
|
32538
|
-
{ 'formatId': opts['formatId'],'emailFormatId': opts['emailFormatId'],'chatFormatId': opts['chatFormatId'],'messageFormatId': opts['messageFormatId'],'download': opts['download'],'fileName': opts['fileName'],'locale': opts['locale'] },
|
|
32551
|
+
{ 'formatId': opts['formatId'],'emailFormatId': opts['emailFormatId'],'chatFormatId': opts['chatFormatId'],'messageFormatId': opts['messageFormatId'],'download': opts['download'],'fileName': opts['fileName'],'locale': opts['locale'],'mediaFormats': this.apiClient.buildCollectionParam(opts['mediaFormats'], 'multi') },
|
|
32539
32552
|
{ },
|
|
32540
32553
|
{ },
|
|
32541
32554
|
null,
|
|
@@ -33618,7 +33631,7 @@ class ResponseManagementApi {
|
|
|
33618
33631
|
/**
|
|
33619
33632
|
* ResponseManagement service.
|
|
33620
33633
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
33621
|
-
* @version
|
|
33634
|
+
* @version 132.0.0
|
|
33622
33635
|
*/
|
|
33623
33636
|
|
|
33624
33637
|
/**
|
|
@@ -33943,7 +33956,7 @@ class RoutingApi {
|
|
|
33943
33956
|
/**
|
|
33944
33957
|
* Routing service.
|
|
33945
33958
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
33946
|
-
* @version
|
|
33959
|
+
* @version 132.0.0
|
|
33947
33960
|
*/
|
|
33948
33961
|
|
|
33949
33962
|
/**
|
|
@@ -36866,7 +36879,7 @@ class SCIMApi {
|
|
|
36866
36879
|
/**
|
|
36867
36880
|
* SCIM service.
|
|
36868
36881
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
36869
|
-
* @version
|
|
36882
|
+
* @version 132.0.0
|
|
36870
36883
|
*/
|
|
36871
36884
|
|
|
36872
36885
|
/**
|
|
@@ -37743,7 +37756,7 @@ class ScriptsApi {
|
|
|
37743
37756
|
/**
|
|
37744
37757
|
* Scripts service.
|
|
37745
37758
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
37746
|
-
* @version
|
|
37759
|
+
* @version 132.0.0
|
|
37747
37760
|
*/
|
|
37748
37761
|
|
|
37749
37762
|
/**
|
|
@@ -38096,7 +38109,7 @@ class SearchApi {
|
|
|
38096
38109
|
/**
|
|
38097
38110
|
* Search service.
|
|
38098
38111
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
38099
|
-
* @version
|
|
38112
|
+
* @version 132.0.0
|
|
38100
38113
|
*/
|
|
38101
38114
|
|
|
38102
38115
|
/**
|
|
@@ -38631,7 +38644,7 @@ class SpeechTextAnalyticsApi {
|
|
|
38631
38644
|
/**
|
|
38632
38645
|
* SpeechTextAnalytics service.
|
|
38633
38646
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
38634
|
-
* @version
|
|
38647
|
+
* @version 132.0.0
|
|
38635
38648
|
*/
|
|
38636
38649
|
|
|
38637
38650
|
/**
|
|
@@ -39484,7 +39497,7 @@ class StationsApi {
|
|
|
39484
39497
|
/**
|
|
39485
39498
|
* Stations service.
|
|
39486
39499
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
39487
|
-
* @version
|
|
39500
|
+
* @version 132.0.0
|
|
39488
39501
|
*/
|
|
39489
39502
|
|
|
39490
39503
|
/**
|
|
@@ -39631,7 +39644,7 @@ class SuggestApi {
|
|
|
39631
39644
|
/**
|
|
39632
39645
|
* Suggest service.
|
|
39633
39646
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
39634
|
-
* @version
|
|
39647
|
+
* @version 132.0.0
|
|
39635
39648
|
*/
|
|
39636
39649
|
|
|
39637
39650
|
/**
|
|
@@ -39770,7 +39783,7 @@ class TelephonyApi {
|
|
|
39770
39783
|
/**
|
|
39771
39784
|
* Telephony service.
|
|
39772
39785
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
39773
|
-
* @version
|
|
39786
|
+
* @version 132.0.0
|
|
39774
39787
|
*/
|
|
39775
39788
|
|
|
39776
39789
|
/**
|
|
@@ -39878,7 +39891,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
39878
39891
|
/**
|
|
39879
39892
|
* TelephonyProvidersEdge service.
|
|
39880
39893
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
39881
|
-
* @version
|
|
39894
|
+
* @version 132.0.0
|
|
39882
39895
|
*/
|
|
39883
39896
|
|
|
39884
39897
|
/**
|
|
@@ -43511,7 +43524,7 @@ class TextbotsApi {
|
|
|
43511
43524
|
/**
|
|
43512
43525
|
* Textbots service.
|
|
43513
43526
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
43514
|
-
* @version
|
|
43527
|
+
* @version 132.0.0
|
|
43515
43528
|
*/
|
|
43516
43529
|
|
|
43517
43530
|
/**
|
|
@@ -43639,7 +43652,7 @@ class TokensApi {
|
|
|
43639
43652
|
/**
|
|
43640
43653
|
* Tokens service.
|
|
43641
43654
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
43642
|
-
* @version
|
|
43655
|
+
* @version 132.0.0
|
|
43643
43656
|
*/
|
|
43644
43657
|
|
|
43645
43658
|
/**
|
|
@@ -43745,7 +43758,7 @@ class UploadsApi {
|
|
|
43745
43758
|
/**
|
|
43746
43759
|
* Uploads service.
|
|
43747
43760
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
43748
|
-
* @version
|
|
43761
|
+
* @version 132.0.0
|
|
43749
43762
|
*/
|
|
43750
43763
|
|
|
43751
43764
|
/**
|
|
@@ -43921,7 +43934,7 @@ class UsageApi {
|
|
|
43921
43934
|
/**
|
|
43922
43935
|
* Usage service.
|
|
43923
43936
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
43924
|
-
* @version
|
|
43937
|
+
* @version 132.0.0
|
|
43925
43938
|
*/
|
|
43926
43939
|
|
|
43927
43940
|
/**
|
|
@@ -43992,7 +44005,7 @@ class UserRecordingsApi {
|
|
|
43992
44005
|
/**
|
|
43993
44006
|
* UserRecordings service.
|
|
43994
44007
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
43995
|
-
* @version
|
|
44008
|
+
* @version 132.0.0
|
|
43996
44009
|
*/
|
|
43997
44010
|
|
|
43998
44011
|
/**
|
|
@@ -44176,7 +44189,7 @@ class UsersApi {
|
|
|
44176
44189
|
/**
|
|
44177
44190
|
* Users service.
|
|
44178
44191
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
44179
|
-
* @version
|
|
44192
|
+
* @version 132.0.0
|
|
44180
44193
|
*/
|
|
44181
44194
|
|
|
44182
44195
|
/**
|
|
@@ -46478,7 +46491,7 @@ class UtilitiesApi {
|
|
|
46478
46491
|
/**
|
|
46479
46492
|
* Utilities service.
|
|
46480
46493
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
46481
|
-
* @version
|
|
46494
|
+
* @version 132.0.0
|
|
46482
46495
|
*/
|
|
46483
46496
|
|
|
46484
46497
|
/**
|
|
@@ -46589,7 +46602,7 @@ class VoicemailApi {
|
|
|
46589
46602
|
/**
|
|
46590
46603
|
* Voicemail service.
|
|
46591
46604
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
46592
|
-
* @version
|
|
46605
|
+
* @version 132.0.0
|
|
46593
46606
|
*/
|
|
46594
46607
|
|
|
46595
46608
|
/**
|
|
@@ -47256,7 +47269,7 @@ class WebChatApi {
|
|
|
47256
47269
|
/**
|
|
47257
47270
|
* WebChat service.
|
|
47258
47271
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
47259
|
-
* @version
|
|
47272
|
+
* @version 132.0.0
|
|
47260
47273
|
*/
|
|
47261
47274
|
|
|
47262
47275
|
/**
|
|
@@ -47800,7 +47813,7 @@ class WebDeploymentsApi {
|
|
|
47800
47813
|
/**
|
|
47801
47814
|
* WebDeployments service.
|
|
47802
47815
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
47803
|
-
* @version
|
|
47816
|
+
* @version 132.0.0
|
|
47804
47817
|
*/
|
|
47805
47818
|
|
|
47806
47819
|
/**
|
|
@@ -48155,7 +48168,7 @@ class WebMessagingApi {
|
|
|
48155
48168
|
/**
|
|
48156
48169
|
* WebMessaging service.
|
|
48157
48170
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
48158
|
-
* @version
|
|
48171
|
+
* @version 132.0.0
|
|
48159
48172
|
*/
|
|
48160
48173
|
|
|
48161
48174
|
/**
|
|
@@ -48201,7 +48214,7 @@ class WidgetsApi {
|
|
|
48201
48214
|
/**
|
|
48202
48215
|
* Widgets service.
|
|
48203
48216
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
48204
|
-
* @version
|
|
48217
|
+
* @version 132.0.0
|
|
48205
48218
|
*/
|
|
48206
48219
|
|
|
48207
48220
|
/**
|
|
@@ -48347,7 +48360,7 @@ class WorkforceManagementApi {
|
|
|
48347
48360
|
/**
|
|
48348
48361
|
* WorkforceManagement service.
|
|
48349
48362
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
48350
|
-
* @version
|
|
48363
|
+
* @version 132.0.0
|
|
48351
48364
|
*/
|
|
48352
48365
|
|
|
48353
48366
|
/**
|
|
@@ -52378,7 +52391,7 @@ class WorkforceManagementApi {
|
|
|
52378
52391
|
* </pre>
|
|
52379
52392
|
* </p>
|
|
52380
52393
|
* @module purecloud-platform-client-v2/index
|
|
52381
|
-
* @version
|
|
52394
|
+
* @version 132.0.0
|
|
52382
52395
|
*/
|
|
52383
52396
|
class platformClient {
|
|
52384
52397
|
constructor() {
|