purecloud-platform-client-v2 182.1.0 → 184.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 +786 -127
- package/dist/web-amd/purecloud-platform-client-v2.js +786 -127
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +295 -119
- package/dist/web-cjs/purecloud-platform-client-v2.js +295 -119
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +554 -229
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +30 -19
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +149 -5
- 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 +7 -8
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.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 +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +4 -8
- 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 +39 -2
- 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/LogCaptureApi.js +75 -0
- 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 +7 -8
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.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 +401 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -6
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +7 -4
- 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 +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/SettingsApi.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/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.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 +7 -1
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -845,7 +845,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
845
845
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
846
846
|
if(this.environment.startsWith('https://'))this.environment=this.environment.substring(8);if(this.environment.startsWith('http://'))this.environment=this.environment.substring(7);if(this.environment.startsWith('api.'))this.environment=this.environment.substring(4);this.basePath="https://api.".concat(this.environment);this.authUrl="https://login.".concat(this.environment);}},{key:"getConfigString",value:function getConfigString(section,key){if(this.config._sections[section])return this.config._sections[section][key];}},{key:"getConfigBoolean",value:function getConfigBoolean(section,key){if(this.config._sections[section]&&this.config._sections[section][key]!==undefined){if(typeof this.config._sections[section][key]==='string'){return this.config._sections[section][key]==='true';}else return this.config._sections[section][key];}}},{key:"getConfigInt",value:function getConfigInt(section,key){if(this.config._sections[section]&&this.config._sections[section][key]){if(typeof this.config._sections[section][key]==='string'){return parseInt(this.config._sections[section][key]);}else return this.config._sections[section][key];}}}]);return Configuration;}();/**
|
|
847
847
|
* @module purecloud-platform-client-v2/ApiClient
|
|
848
|
-
* @version
|
|
848
|
+
* @version 184.0.0
|
|
849
849
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
850
850
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
851
851
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -1100,7 +1100,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
1100
1100
|
that.config.logger.log('error',error.response.status,httpMethod,url,request.headers,error.response.headers,bodyParam,error.response.data);data=that.returnExtended===true?{status:error.response.status,statusText:error.response.statusText,headers:error.response.headers,body:error.response.data,text:error.response.text,error:error}:error.response.data?error.response.data:error.response.text;}reject(data);});}});}}]);return ApiClient;}();var AlertingApi=/*#__PURE__*/function(){/**
|
|
1101
1101
|
* Alerting service.
|
|
1102
1102
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1103
|
-
* @version
|
|
1103
|
+
* @version 184.0.0
|
|
1104
1104
|
*/ /**
|
|
1105
1105
|
* Constructs a new AlertingApi.
|
|
1106
1106
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -1114,13 +1114,15 @@ that.config.logger.log('error',error.response.status,httpMethod,url,request.head
|
|
|
1114
1114
|
*/_createClass(AlertingApi,[{key:"deleteAlertingAlert",value:function deleteAlertingAlert(alertId){// verify the required parameter 'alertId' is set
|
|
1115
1115
|
if(alertId===undefined||alertId===null){throw'Missing the required parameter "alertId" when calling deleteAlertingAlert';}return this.apiClient.callApi('/api/v2/alerting/alerts/{alertId}','DELETE',{'alertId':alertId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1116
1116
|
* Delete an interaction stats alert
|
|
1117
|
-
*
|
|
1117
|
+
* Apps should migrate to use DELETE /api/v2/alerting/alerts/{alertId}.
|
|
1118
1118
|
* @param {String} alertId Alert ID
|
|
1119
|
+
* @deprecated
|
|
1119
1120
|
*/},{key:"deleteAlertingInteractionstatsAlert",value:function deleteAlertingInteractionstatsAlert(alertId){// verify the required parameter 'alertId' is set
|
|
1120
1121
|
if(alertId===undefined||alertId===null){throw'Missing the required parameter "alertId" when calling deleteAlertingInteractionstatsAlert';}return this.apiClient.callApi('/api/v2/alerting/interactionstats/alerts/{alertId}','DELETE',{'alertId':alertId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1121
|
-
* Delete an interaction stats rule
|
|
1122
|
-
*
|
|
1122
|
+
* Delete an interaction stats rule
|
|
1123
|
+
* Apps should migrate to use DELETE /api/v2/alerting/rules/{ruleId}.
|
|
1123
1124
|
* @param {String} ruleId Rule ID
|
|
1125
|
+
* @deprecated
|
|
1124
1126
|
*/},{key:"deleteAlertingInteractionstatsRule",value:function deleteAlertingInteractionstatsRule(ruleId){// verify the required parameter 'ruleId' is set
|
|
1125
1127
|
if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "ruleId" when calling deleteAlertingInteractionstatsRule';}return this.apiClient.callApi('/api/v2/alerting/interactionstats/rules/{ruleId}','DELETE',{'ruleId':ruleId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1126
1128
|
* Delete a rule.
|
|
@@ -1133,35 +1135,41 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
1133
1135
|
* @param {String} alertId Alert ID
|
|
1134
1136
|
*/},{key:"getAlertingAlert",value:function getAlertingAlert(alertId){// verify the required parameter 'alertId' is set
|
|
1135
1137
|
if(alertId===undefined||alertId===null){throw'Missing the required parameter "alertId" when calling getAlertingAlert';}return this.apiClient.callApi('/api/v2/alerting/alerts/{alertId}','GET',{'alertId':alertId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1136
|
-
* Gets active alert count for a user
|
|
1137
|
-
*
|
|
1138
|
+
* Gets active alert count for a user
|
|
1139
|
+
* Apps should migrate to use POST /api/v2/alerting/alerts/query with the queryType set to Count and alertStatus to Active in the request body.
|
|
1140
|
+
* @deprecated
|
|
1138
1141
|
*/},{key:"getAlertingAlertsActive",value:function getAlertingAlertsActive(){return this.apiClient.callApi('/api/v2/alerting/alerts/active','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1139
1142
|
* Get an interaction stats alert
|
|
1140
|
-
*
|
|
1143
|
+
* Apps should migrate to use GET /api/v2/alerting/alerts/{alertId}.
|
|
1141
1144
|
* @param {String} alertId Alert ID
|
|
1142
1145
|
* @param {Object} opts Optional parameters
|
|
1143
1146
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
1147
|
+
* @deprecated
|
|
1144
1148
|
*/},{key:"getAlertingInteractionstatsAlert",value:function getAlertingInteractionstatsAlert(alertId,opts){opts=opts||{};// verify the required parameter 'alertId' is set
|
|
1145
1149
|
if(alertId===undefined||alertId===null){throw'Missing the required parameter "alertId" when calling getAlertingInteractionstatsAlert';}return this.apiClient.callApi('/api/v2/alerting/interactionstats/alerts/{alertId}','GET',{'alertId':alertId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1146
|
-
* Get interaction stats alert list
|
|
1147
|
-
*
|
|
1150
|
+
* Get interaction stats alert list
|
|
1151
|
+
* Apps should migrate to use POST /api/v2/alerting/alerts/query.
|
|
1148
1152
|
* @param {Object} opts Optional parameters
|
|
1149
1153
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
1154
|
+
* @deprecated
|
|
1150
1155
|
*/},{key:"getAlertingInteractionstatsAlerts",value:function getAlertingInteractionstatsAlerts(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/alerting/interactionstats/alerts','GET',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1151
|
-
* Gets user unread count of interaction stats alerts
|
|
1152
|
-
*
|
|
1156
|
+
* Gets user unread count of interaction stats alerts
|
|
1157
|
+
* Apps should migrate to use POST /api/v2/alerting/alerts/query with the queryType set to Count and viewStatus to Unread in the request body.
|
|
1158
|
+
* @deprecated
|
|
1153
1159
|
*/},{key:"getAlertingInteractionstatsAlertsUnread",value:function getAlertingInteractionstatsAlertsUnread(){return this.apiClient.callApi('/api/v2/alerting/interactionstats/alerts/unread','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1154
|
-
* Get an interaction stats rule
|
|
1155
|
-
*
|
|
1160
|
+
* Get an interaction stats rule
|
|
1161
|
+
* Apps should migrate to use GET /api/v2/alerting/rules/{ruleId}.
|
|
1156
1162
|
* @param {String} ruleId Rule ID
|
|
1157
1163
|
* @param {Object} opts Optional parameters
|
|
1158
1164
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
1165
|
+
* @deprecated
|
|
1159
1166
|
*/},{key:"getAlertingInteractionstatsRule",value:function getAlertingInteractionstatsRule(ruleId,opts){opts=opts||{};// verify the required parameter 'ruleId' is set
|
|
1160
1167
|
if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "ruleId" when calling getAlertingInteractionstatsRule';}return this.apiClient.callApi('/api/v2/alerting/interactionstats/rules/{ruleId}','GET',{'ruleId':ruleId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1161
|
-
* Get an interaction stats rule list
|
|
1162
|
-
*
|
|
1168
|
+
* Get an interaction stats rule list
|
|
1169
|
+
* Apps should migrate to use POST /api/v2/alerting/rules/query.
|
|
1163
1170
|
* @param {Object} opts Optional parameters
|
|
1164
1171
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
1172
|
+
* @deprecated
|
|
1165
1173
|
*/},{key:"getAlertingInteractionstatsRules",value:function getAlertingInteractionstatsRules(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/alerting/interactionstats/rules','GET',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1166
1174
|
* Get a rule.
|
|
1167
1175
|
*
|
|
@@ -1190,11 +1198,12 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
1190
1198
|
* @param {Object} opts Optional parameters
|
|
1191
1199
|
* @param {Object} opts.body
|
|
1192
1200
|
*/},{key:"postAlertingAlertsQuery",value:function postAlertingAlertsQuery(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/alerting/alerts/query','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1193
|
-
* Create an interaction stats rule
|
|
1194
|
-
*
|
|
1201
|
+
* Create an interaction stats rule
|
|
1202
|
+
* Apps should migrate to use POST /api/v2/alerting/rules.
|
|
1195
1203
|
* @param {Object} body AlertingRule
|
|
1196
1204
|
* @param {Object} opts Optional parameters
|
|
1197
1205
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
1206
|
+
* @deprecated
|
|
1198
1207
|
*/},{key:"postAlertingInteractionstatsRules",value:function postAlertingInteractionstatsRules(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
1199
1208
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAlertingInteractionstatsRules';}return this.apiClient.callApi('/api/v2/alerting/interactionstats/rules','POST',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1200
1209
|
* Create a Rule.
|
|
@@ -1220,20 +1229,22 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
1220
1229
|
*/},{key:"putAlertingAlert",value:function putAlertingAlert(alertId,opts){opts=opts||{};// verify the required parameter 'alertId' is set
|
|
1221
1230
|
if(alertId===undefined||alertId===null){throw'Missing the required parameter "alertId" when calling putAlertingAlert';}return this.apiClient.callApi('/api/v2/alerting/alerts/{alertId}','PUT',{'alertId':alertId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1222
1231
|
* Update an interaction stats alert read status
|
|
1223
|
-
*
|
|
1232
|
+
* Apps should migrate to use PUT /api/v2/alerting/alerts/{alertId}.
|
|
1224
1233
|
* @param {String} alertId Alert ID
|
|
1225
1234
|
* @param {Object} body InteractionStatsAlert
|
|
1226
1235
|
* @param {Object} opts Optional parameters
|
|
1227
1236
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
1237
|
+
* @deprecated
|
|
1228
1238
|
*/},{key:"putAlertingInteractionstatsAlert",value:function putAlertingInteractionstatsAlert(alertId,body,opts){opts=opts||{};// verify the required parameter 'alertId' is set
|
|
1229
1239
|
if(alertId===undefined||alertId===null){throw'Missing the required parameter "alertId" when calling putAlertingInteractionstatsAlert';}// verify the required parameter 'body' is set
|
|
1230
1240
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAlertingInteractionstatsAlert';}return this.apiClient.callApi('/api/v2/alerting/interactionstats/alerts/{alertId}','PUT',{'alertId':alertId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1231
1241
|
* Update an interaction stats rule
|
|
1232
|
-
*
|
|
1242
|
+
* Apps should migrate to use PUT /api/v2/alerting/rules/{ruleId}.
|
|
1233
1243
|
* @param {String} ruleId Rule ID
|
|
1234
1244
|
* @param {Object} body AlertingRule
|
|
1235
1245
|
* @param {Object} opts Optional parameters
|
|
1236
1246
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
1247
|
+
* @deprecated
|
|
1237
1248
|
*/},{key:"putAlertingInteractionstatsRule",value:function putAlertingInteractionstatsRule(ruleId,body,opts){opts=opts||{};// verify the required parameter 'ruleId' is set
|
|
1238
1249
|
if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "ruleId" when calling putAlertingInteractionstatsRule';}// verify the required parameter 'body' is set
|
|
1239
1250
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAlertingInteractionstatsRule';}return this.apiClient.callApi('/api/v2/alerting/interactionstats/rules/{ruleId}','PUT',{'ruleId':ruleId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -1246,7 +1257,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
1246
1257
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAlertingRule';}return this.apiClient.callApi('/api/v2/alerting/rules/{ruleId}','PUT',{'ruleId':ruleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return AlertingApi;}();var AnalyticsApi=/*#__PURE__*/function(){/**
|
|
1247
1258
|
* Analytics service.
|
|
1248
1259
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1249
|
-
* @version
|
|
1260
|
+
* @version 184.0.0
|
|
1250
1261
|
*/ /**
|
|
1251
1262
|
* Constructs a new AnalyticsApi.
|
|
1252
1263
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -1284,7 +1295,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
1284
1295
|
*/},{key:"getAnalyticsActionsAggregatesJobResults",value:function getAnalyticsActionsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
1285
1296
|
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getAnalyticsActionsAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/actions/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1286
1297
|
* Get Reporting Turns.
|
|
1287
|
-
* Returns the reporting turns grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint
|
|
1298
|
+
* Returns the reporting turns grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
|
|
1288
1299
|
* @param {String} botFlowId ID of the bot flow.
|
|
1289
1300
|
* @param {Object} opts Optional parameters
|
|
1290
1301
|
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
@@ -1296,6 +1307,17 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
1296
1307
|
* @param {Object} opts.askActionResults Optional case-insensitive comma separated list of ask action results to filter the reporting turns.
|
|
1297
1308
|
*/},{key:"getAnalyticsBotflowReportingturns",value:function getAnalyticsBotflowReportingturns(botFlowId,opts){opts=opts||{};// verify the required parameter 'botFlowId' is set
|
|
1298
1309
|
if(botFlowId===undefined||botFlowId===null){throw'Missing the required parameter "botFlowId" when calling getAnalyticsBotflowReportingturns';}return this.apiClient.callApi('/api/v2/analytics/botflows/{botFlowId}/reportingturns','GET',{'botFlowId':botFlowId},{'after':opts['after'],'pageSize':opts['pageSize'],'interval':opts['interval'],'actionId':opts['actionId'],'sessionId':opts['sessionId'],'language':opts['language'],'askActionResults':opts['askActionResults']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1310
|
+
* Get Bot Flow Sessions.
|
|
1311
|
+
* Returns the bot flow sessions in reverse chronological order from the date they were created. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
|
|
1312
|
+
* @param {String} botFlowId ID of the bot flow.
|
|
1313
|
+
* @param {Object} opts Optional parameters
|
|
1314
|
+
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
1315
|
+
* @param {String} opts.pageSize Max number of entities to return. Maximum of 250 (default to 50)
|
|
1316
|
+
* @param {String} opts.interval Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: '2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07'. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
1317
|
+
* @param {Object} opts.botResultCategories Optional case-insensitive comma separated list of Bot Result Categories to filter sessions by.
|
|
1318
|
+
* @param {String} opts.endLanguage Optional case-insensitive language code to filter sessions by the language the sessions ended in.
|
|
1319
|
+
*/},{key:"getAnalyticsBotflowSessions",value:function getAnalyticsBotflowSessions(botFlowId,opts){opts=opts||{};// verify the required parameter 'botFlowId' is set
|
|
1320
|
+
if(botFlowId===undefined||botFlowId===null){throw'Missing the required parameter "botFlowId" when calling getAnalyticsBotflowSessions';}return this.apiClient.callApi('/api/v2/analytics/botflows/{botFlowId}/sessions','GET',{'botFlowId':botFlowId},{'after':opts['after'],'pageSize':opts['pageSize'],'interval':opts['interval'],'botResultCategories':opts['botResultCategories'],'endLanguage':opts['endLanguage']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1299
1321
|
* Get status for async query for bot aggregates
|
|
1300
1322
|
*
|
|
1301
1323
|
* @param {String} jobId jobId
|
|
@@ -1367,6 +1389,20 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
1367
1389
|
* getAnalyticsEvaluationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1368
1390
|
*/},{key:"getAnalyticsEvaluationsAggregatesJobResults",value:function getAnalyticsEvaluationsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
1369
1391
|
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getAnalyticsEvaluationsAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/evaluations/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1392
|
+
* Get status for async query for flow execution aggregates
|
|
1393
|
+
*
|
|
1394
|
+
* @param {String} jobId jobId
|
|
1395
|
+
* getAnalyticsFlowexecutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1396
|
+
*/},{key:"getAnalyticsFlowexecutionsAggregatesJob",value:function getAnalyticsFlowexecutionsAggregatesJob(jobId){// verify the required parameter 'jobId' is set
|
|
1397
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getAnalyticsFlowexecutionsAggregatesJob';}return this.apiClient.callApi('/api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1398
|
+
* Fetch a page of results for an async aggregates query
|
|
1399
|
+
*
|
|
1400
|
+
* @param {String} jobId jobId
|
|
1401
|
+
* @param {Object} opts Optional parameters
|
|
1402
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
1403
|
+
* getAnalyticsFlowexecutionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1404
|
+
*/},{key:"getAnalyticsFlowexecutionsAggregatesJobResults",value:function getAnalyticsFlowexecutionsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
1405
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getAnalyticsFlowexecutionsAggregatesJobResults';}return this.apiClient.callApi('/api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}/results','GET',{'jobId':jobId},{'cursor':opts['cursor']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1370
1406
|
* Get status for async query for Flow aggregates
|
|
1371
1407
|
*
|
|
1372
1408
|
* @param {String} jobId jobId
|
|
@@ -1638,6 +1674,18 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
1638
1674
|
* @param {Object} body query
|
|
1639
1675
|
*/},{key:"postAnalyticsEvaluationsAggregatesQuery",value:function postAnalyticsEvaluationsAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
1640
1676
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsEvaluationsAggregatesQuery';}return this.apiClient.callApi('/api/v2/analytics/evaluations/aggregates/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1677
|
+
* Query for flow execution aggregates asynchronously
|
|
1678
|
+
*
|
|
1679
|
+
* @param {Object} body query
|
|
1680
|
+
* postAnalyticsFlowexecutionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1681
|
+
*/},{key:"postAnalyticsFlowexecutionsAggregatesJobs",value:function postAnalyticsFlowexecutionsAggregatesJobs(body){// verify the required parameter 'body' is set
|
|
1682
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsFlowexecutionsAggregatesJobs';}return this.apiClient.callApi('/api/v2/analytics/flowexecutions/aggregates/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1683
|
+
* Query for flow execution aggregates
|
|
1684
|
+
*
|
|
1685
|
+
* @param {Object} body query
|
|
1686
|
+
* postAnalyticsFlowexecutionsAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1687
|
+
*/},{key:"postAnalyticsFlowexecutionsAggregatesQuery",value:function postAnalyticsFlowexecutionsAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
1688
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsFlowexecutionsAggregatesQuery';}return this.apiClient.callApi('/api/v2/analytics/flowexecutions/aggregates/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1641
1689
|
* Query for flow activity observations
|
|
1642
1690
|
*
|
|
1643
1691
|
* @param {Object} body query
|
|
@@ -1697,13 +1745,15 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
1697
1745
|
*/},{key:"postAnalyticsReportingExports",value:function postAnalyticsReportingExports(body){// verify the required parameter 'body' is set
|
|
1698
1746
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsReportingExports';}return this.apiClient.callApi('/api/v2/analytics/reporting/exports','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1699
1747
|
* Place a scheduled report immediately into the reporting queue
|
|
1700
|
-
*
|
|
1748
|
+
* This route is deprecated, please use POST:api/v2/analytics/reporting/exports/{exportId}/execute instead
|
|
1701
1749
|
* @param {String} scheduleId Schedule ID
|
|
1750
|
+
* @deprecated
|
|
1702
1751
|
*/},{key:"postAnalyticsReportingScheduleRunreport",value:function postAnalyticsReportingScheduleRunreport(scheduleId){// verify the required parameter 'scheduleId' is set
|
|
1703
1752
|
if(scheduleId===undefined||scheduleId===null){throw'Missing the required parameter "scheduleId" when calling postAnalyticsReportingScheduleRunreport';}return this.apiClient.callApi('/api/v2/analytics/reporting/schedules/{scheduleId}/runreport','POST',{'scheduleId':scheduleId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1704
1753
|
* Create a scheduled report job
|
|
1705
|
-
*
|
|
1754
|
+
* This route is deprecated, please use POST:api/v2/analytics/reporting/exports instead
|
|
1706
1755
|
* @param {Object} body ReportSchedule
|
|
1756
|
+
* @deprecated
|
|
1707
1757
|
*/},{key:"postAnalyticsReportingSchedules",value:function postAnalyticsReportingSchedules(body){// verify the required parameter 'body' is set
|
|
1708
1758
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsReportingSchedules';}return this.apiClient.callApi('/api/v2/analytics/reporting/schedules','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1709
1759
|
* Query for resolution aggregates asynchronously
|
|
@@ -1805,15 +1855,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
1805
1855
|
*/},{key:"putAnalyticsDataretentionSettings",value:function putAnalyticsDataretentionSettings(body){// verify the required parameter 'body' is set
|
|
1806
1856
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAnalyticsDataretentionSettings';}return this.apiClient.callApi('/api/v2/analytics/dataretention/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
1807
1857
|
* Update a scheduled report job.
|
|
1808
|
-
*
|
|
1858
|
+
* This route is deprecated, please use PATCH:api/v2/analytics/reporting/exports/{exportId}/schedule instead
|
|
1809
1859
|
* @param {String} scheduleId Schedule ID
|
|
1810
1860
|
* @param {Object} body ReportSchedule
|
|
1861
|
+
* @deprecated
|
|
1811
1862
|
*/},{key:"putAnalyticsReportingSchedule",value:function putAnalyticsReportingSchedule(scheduleId,body){// verify the required parameter 'scheduleId' is set
|
|
1812
1863
|
if(scheduleId===undefined||scheduleId===null){throw'Missing the required parameter "scheduleId" when calling putAnalyticsReportingSchedule';}// verify the required parameter 'body' is set
|
|
1813
1864
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAnalyticsReportingSchedule';}return this.apiClient.callApi('/api/v2/analytics/reporting/schedules/{scheduleId}','PUT',{'scheduleId':scheduleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return AnalyticsApi;}();var ArchitectApi=/*#__PURE__*/function(){/**
|
|
1814
1865
|
* Architect service.
|
|
1815
1866
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
1816
|
-
* @version
|
|
1867
|
+
* @version 184.0.0
|
|
1817
1868
|
*/ /**
|
|
1818
1869
|
* Constructs a new ArchitectApi.
|
|
1819
1870
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -2845,7 +2896,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
2845
2896
|
if(flowOutcomeId===undefined||flowOutcomeId===null){throw'Missing the required parameter "flowOutcomeId" when calling putFlowsOutcome';}return this.apiClient.callApi('/api/v2/flows/outcomes/{flowOutcomeId}','PUT',{'flowOutcomeId':flowOutcomeId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return ArchitectApi;}();var AuditApi=/*#__PURE__*/function(){/**
|
|
2846
2897
|
* Audit service.
|
|
2847
2898
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
2848
|
-
* @version
|
|
2899
|
+
* @version 184.0.0
|
|
2849
2900
|
*/ /**
|
|
2850
2901
|
* Constructs a new AuditApi.
|
|
2851
2902
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -2887,7 +2938,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2887
2938
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAuditsQueryRealtime';}return this.apiClient.callApi('/api/v2/audits/query/realtime','POST',{},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return AuditApi;}();var AuthorizationApi=/*#__PURE__*/function(){/**
|
|
2888
2939
|
* Authorization service.
|
|
2889
2940
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
2890
|
-
* @version
|
|
2941
|
+
* @version 184.0.0
|
|
2891
2942
|
*/ /**
|
|
2892
2943
|
* Constructs a new AuthorizationApi.
|
|
2893
2944
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -3083,10 +3134,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3083
3134
|
* Recreate a previously deleted division.
|
|
3084
3135
|
*
|
|
3085
3136
|
* @param {String} divisionId Division ID
|
|
3086
|
-
* @param {Object}
|
|
3087
|
-
|
|
3088
|
-
|
|
3089
|
-
if(
|
|
3137
|
+
* @param {Object} opts Optional parameters
|
|
3138
|
+
* @param {Object} opts.body Recreated division data
|
|
3139
|
+
*/},{key:"postAuthorizationDivisionRestore",value:function postAuthorizationDivisionRestore(divisionId,opts){opts=opts||{};// verify the required parameter 'divisionId' is set
|
|
3140
|
+
if(divisionId===undefined||divisionId===null){throw'Missing the required parameter "divisionId" when calling postAuthorizationDivisionRestore';}return this.apiClient.callApi('/api/v2/authorization/divisions/{divisionId}/restore','POST',{'divisionId':divisionId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3090
3141
|
* Create a division.
|
|
3091
3142
|
*
|
|
3092
3143
|
* @param {Object} body Division
|
|
@@ -3198,7 +3249,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
3198
3249
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserRoles';}return this.apiClient.callApi('/api/v2/users/{subjectId}/roles','PUT',{'subjectId':subjectId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return AuthorizationApi;}();var BillingApi=/*#__PURE__*/function(){/**
|
|
3199
3250
|
* Billing service.
|
|
3200
3251
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
3201
|
-
* @version
|
|
3252
|
+
* @version 184.0.0
|
|
3202
3253
|
*/ /**
|
|
3203
3254
|
* Constructs a new BillingApi.
|
|
3204
3255
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -3222,7 +3273,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
3222
3273
|
if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required parameter "trustorOrgId" when calling getBillingTrusteebillingoverviewTrustorOrgId';}return this.apiClient.callApi('/api/v2/billing/trusteebillingoverview/{trustorOrgId}','GET',{'trustorOrgId':trustorOrgId},{'billingPeriodIndex':opts['billingPeriodIndex']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return BillingApi;}();var CarrierServicesApi=/*#__PURE__*/function(){/**
|
|
3223
3274
|
* CarrierServices service.
|
|
3224
3275
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
3225
|
-
* @version
|
|
3276
|
+
* @version 184.0.0
|
|
3226
3277
|
*/ /**
|
|
3227
3278
|
* Constructs a new CarrierServicesApi.
|
|
3228
3279
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -3242,7 +3293,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
3242
3293
|
*/},{key:"postCarrierservicesIntegrationsEmergencylocationsMe",value:function postCarrierservicesIntegrationsEmergencylocationsMe(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/carrierservices/integrations/emergencylocations/me','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return CarrierServicesApi;}();var ChatApi=/*#__PURE__*/function(){/**
|
|
3243
3294
|
* Chat service.
|
|
3244
3295
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
3245
|
-
* @version
|
|
3296
|
+
* @version 184.0.0
|
|
3246
3297
|
*/ /**
|
|
3247
3298
|
* Constructs a new ChatApi.
|
|
3248
3299
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -3439,7 +3490,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3439
3490
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putChatsSettings';}return this.apiClient.callApi('/api/v2/chats/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return ChatApi;}();var CoachingApi=/*#__PURE__*/function(){/**
|
|
3440
3491
|
* Coaching service.
|
|
3441
3492
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
3442
|
-
* @version
|
|
3493
|
+
* @version 184.0.0
|
|
3443
3494
|
*/ /**
|
|
3444
3495
|
* Constructs a new CoachingApi.
|
|
3445
3496
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -3592,7 +3643,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3592
3643
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postCoachingScheduleslotsQuery';}return this.apiClient.callApi('/api/v2/coaching/scheduleslots/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return CoachingApi;}();var ContentManagementApi=/*#__PURE__*/function(){/**
|
|
3593
3644
|
* ContentManagement service.
|
|
3594
3645
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
3595
|
-
* @version
|
|
3646
|
+
* @version 184.0.0
|
|
3596
3647
|
*/ /**
|
|
3597
3648
|
* Constructs a new ContentManagementApi.
|
|
3598
3649
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -3894,7 +3945,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
3894
3945
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putContentmanagementWorkspaceTagvalue';}return this.apiClient.callApi('/api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId}','PUT',{'workspaceId':workspaceId,'tagId':tagId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return ContentManagementApi;}();var ConversationsApi=/*#__PURE__*/function(){/**
|
|
3895
3946
|
* Conversations service.
|
|
3896
3947
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
3897
|
-
* @version
|
|
3948
|
+
* @version 184.0.0
|
|
3898
3949
|
*/ /**
|
|
3899
3950
|
* Constructs a new ConversationsApi.
|
|
3900
3951
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -5618,7 +5669,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
5618
5669
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putConversationsVideoRecordingstate';}return this.apiClient.callApi('/api/v2/conversations/videos/{conversationId}/recordingstate','PUT',{'conversationId':conversationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return ConversationsApi;}();var DataExtensionsApi=/*#__PURE__*/function(){/**
|
|
5619
5670
|
* DataExtensions service.
|
|
5620
5671
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
5621
|
-
* @version
|
|
5672
|
+
* @version 184.0.0
|
|
5622
5673
|
*/ /**
|
|
5623
5674
|
* Constructs a new DataExtensionsApi.
|
|
5624
5675
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -5639,7 +5690,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
5639
5690
|
*/},{key:"getDataextensionsLimits",value:function getDataextensionsLimits(){return this.apiClient.callApi('/api/v2/dataextensions/limits','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return DataExtensionsApi;}();var DownloadsApi=/*#__PURE__*/function(){/**
|
|
5640
5691
|
* Downloads service.
|
|
5641
5692
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
5642
|
-
* @version
|
|
5693
|
+
* @version 184.0.0
|
|
5643
5694
|
*/ /**
|
|
5644
5695
|
* Constructs a new DownloadsApi.
|
|
5645
5696
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -5658,7 +5709,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
5658
5709
|
if(downloadId===undefined||downloadId===null){throw'Missing the required parameter "downloadId" when calling getDownload';}return this.apiClient.callApi('/api/v2/downloads/{downloadId}','GET',{'downloadId':downloadId},{'contentDisposition':opts['contentDisposition'],'issueRedirect':opts['issueRedirect'],'redirectToAuth':opts['redirectToAuth']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return DownloadsApi;}();var EmailsApi=/*#__PURE__*/function(){/**
|
|
5659
5710
|
* Emails service.
|
|
5660
5711
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
5661
|
-
* @version
|
|
5712
|
+
* @version 184.0.0
|
|
5662
5713
|
*/ /**
|
|
5663
5714
|
* Constructs a new EmailsApi.
|
|
5664
5715
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -5676,7 +5727,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
5676
5727
|
*/},{key:"patchEmailsSettings",value:function patchEmailsSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/emails/settings','PATCH',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return EmailsApi;}();var EventsApi=/*#__PURE__*/function(){/**
|
|
5677
5728
|
* Events service.
|
|
5678
5729
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
5679
|
-
* @version
|
|
5730
|
+
* @version 184.0.0
|
|
5680
5731
|
*/ /**
|
|
5681
5732
|
* Constructs a new EventsApi.
|
|
5682
5733
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -5701,7 +5752,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5701
5752
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postEventsUsersRoutingstatus';}return this.apiClient.callApi('/api/v2/events/users/routingstatus','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return EventsApi;}();var ExternalContactsApi=/*#__PURE__*/function(){/**
|
|
5702
5753
|
* ExternalContacts service.
|
|
5703
5754
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
5704
|
-
* @version
|
|
5755
|
+
* @version 184.0.0
|
|
5705
5756
|
*/ /**
|
|
5706
5757
|
* Constructs a new ExternalContactsApi.
|
|
5707
5758
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -6156,7 +6207,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
6156
6207
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putExternalcontactsRelationship';}return this.apiClient.callApi('/api/v2/externalcontacts/relationships/{relationshipId}','PUT',{'relationshipId':relationshipId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return ExternalContactsApi;}();var FaxApi=/*#__PURE__*/function(){/**
|
|
6157
6208
|
* Fax service.
|
|
6158
6209
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
6159
|
-
* @version
|
|
6210
|
+
* @version 184.0.0
|
|
6160
6211
|
*/ /**
|
|
6161
6212
|
* Constructs a new FaxApi.
|
|
6162
6213
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -6197,7 +6248,7 @@ if(documentId===undefined||documentId===null){throw'Missing the required paramet
|
|
|
6197
6248
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putFaxDocument';}return this.apiClient.callApi('/api/v2/fax/documents/{documentId}','PUT',{'documentId':documentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return FaxApi;}();var FlowsApi=/*#__PURE__*/function(){/**
|
|
6198
6249
|
* Flows service.
|
|
6199
6250
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
6200
|
-
* @version
|
|
6251
|
+
* @version 184.0.0
|
|
6201
6252
|
*/ /**
|
|
6202
6253
|
* Constructs a new FlowsApi.
|
|
6203
6254
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -6246,7 +6297,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6246
6297
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postAnalyticsFlowsObservationsQuery';}return this.apiClient.callApi('/api/v2/analytics/flows/observations/query','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return FlowsApi;}();var GamificationApi=/*#__PURE__*/function(){/**
|
|
6247
6298
|
* Gamification service.
|
|
6248
6299
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
6249
|
-
* @version
|
|
6300
|
+
* @version 184.0.0
|
|
6250
6301
|
*/ /**
|
|
6251
6302
|
* Constructs a new GamificationApi.
|
|
6252
6303
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -6786,7 +6837,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6786
6837
|
if(status===undefined||status===null){throw'Missing the required parameter "status" when calling putGamificationStatus';}return this.apiClient.callApi('/api/v2/gamification/status','PUT',{},{},{},{},status,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return GamificationApi;}();var GeneralDataProtectionRegulationApi=/*#__PURE__*/function(){/**
|
|
6787
6838
|
* GeneralDataProtectionRegulation service.
|
|
6788
6839
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
6789
|
-
* @version
|
|
6840
|
+
* @version 184.0.0
|
|
6790
6841
|
*/ /**
|
|
6791
6842
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
6792
6843
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -6821,7 +6872,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
6821
6872
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postGdprRequests';}return this.apiClient.callApi('/api/v2/gdpr/requests','POST',{},{'deleteConfirmed':opts['deleteConfirmed']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return GeneralDataProtectionRegulationApi;}();var GeolocationApi=/*#__PURE__*/function(){/**
|
|
6822
6873
|
* Geolocation service.
|
|
6823
6874
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
6824
|
-
* @version
|
|
6875
|
+
* @version 184.0.0
|
|
6825
6876
|
*/ /**
|
|
6826
6877
|
* Constructs a new GeolocationApi.
|
|
6827
6878
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -6855,7 +6906,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
6855
6906
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchUserGeolocation';}return this.apiClient.callApi('/api/v2/users/{userId}/geolocations/{clientId}','PATCH',{'userId':userId,'clientId':clientId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return GeolocationApi;}();var GreetingsApi=/*#__PURE__*/function(){/**
|
|
6856
6907
|
* Greetings service.
|
|
6857
6908
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
6858
|
-
* @version
|
|
6909
|
+
* @version 184.0.0
|
|
6859
6910
|
*/ /**
|
|
6860
6911
|
* Constructs a new GreetingsApi.
|
|
6861
6912
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -6962,7 +7013,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
6962
7013
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserGreetingsDefaults';}return this.apiClient.callApi('/api/v2/users/{userId}/greetings/defaults','PUT',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return GreetingsApi;}();var GroupsApi=/*#__PURE__*/function(){/**
|
|
6963
7014
|
* Groups service.
|
|
6964
7015
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
6965
|
-
* @version
|
|
7016
|
+
* @version 184.0.0
|
|
6966
7017
|
*/ /**
|
|
6967
7018
|
* Constructs a new GroupsApi.
|
|
6968
7019
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -7095,7 +7146,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
7095
7146
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putGroupDynamicsettings';}return this.apiClient.callApi('/api/v2/groups/{groupId}/dynamicsettings','PUT',{'groupId':groupId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return GroupsApi;}();var IdentityProviderApi=/*#__PURE__*/function(){/**
|
|
7096
7147
|
* IdentityProvider service.
|
|
7097
7148
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
7098
|
-
* @version
|
|
7149
|
+
* @version 184.0.0
|
|
7099
7150
|
*/ /**
|
|
7100
7151
|
* Constructs a new IdentityProviderApi.
|
|
7101
7152
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -7229,7 +7280,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7229
7280
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putIdentityprovidersSalesforce';}return this.apiClient.callApi('/api/v2/identityproviders/salesforce','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return IdentityProviderApi;}();var InfrastructureAsCodeApi=/*#__PURE__*/function(){/**
|
|
7230
7281
|
* InfrastructureAsCode service.
|
|
7231
7282
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
7232
|
-
* @version
|
|
7283
|
+
* @version 184.0.0
|
|
7233
7284
|
*/ /**
|
|
7234
7285
|
* Constructs a new InfrastructureAsCodeApi.
|
|
7235
7286
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -7283,7 +7334,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
7283
7334
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postInfrastructureascodeJobs';}return this.apiClient.callApi('/api/v2/infrastructureascode/jobs','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return InfrastructureAsCodeApi;}();var IntegrationsApi=/*#__PURE__*/function(){/**
|
|
7284
7335
|
* Integrations service.
|
|
7285
7336
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
7286
|
-
* @version
|
|
7337
|
+
* @version 184.0.0
|
|
7287
7338
|
*/ /**
|
|
7288
7339
|
* Constructs a new IntegrationsApi.
|
|
7289
7340
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -7717,7 +7768,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7717
7768
|
*/},{key:"postIntegrationsActionTest",value:function postIntegrationsActionTest(actionId,body){// verify the required parameter 'actionId' is set
|
|
7718
7769
|
if(actionId===undefined||actionId===null){throw'Missing the required parameter "actionId" when calling postIntegrationsActionTest';}// verify the required parameter 'body' is set
|
|
7719
7770
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postIntegrationsActionTest';}return this.apiClient.callApi('/api/v2/integrations/actions/{actionId}/test','POST',{'actionId':actionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7720
|
-
* Create a new Action
|
|
7771
|
+
* Create a new Action. Not supported for 'Function Integration' actions. Function integrations must be created as drafts to allow managing of uploading required ZIP function package before they may be used as a published action.
|
|
7721
7772
|
*
|
|
7722
7773
|
* @param {Object} body Input used to create Action.
|
|
7723
7774
|
*/},{key:"postIntegrationsActions",value:function postIntegrationsActions(body){// verify the required parameter 'body' is set
|
|
@@ -7804,7 +7855,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
7804
7855
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putIntegrationsUnifiedcommunicationThirdpartypresences';}return this.apiClient.callApi('/api/v2/integrations/unifiedcommunications/{ucIntegrationId}/thirdpartypresences','PUT',{'ucIntegrationId':ucIntegrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return IntegrationsApi;}();var JourneyApi=/*#__PURE__*/function(){/**
|
|
7805
7856
|
* Journey service.
|
|
7806
7857
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
7807
|
-
* @version
|
|
7858
|
+
* @version 184.0.0
|
|
7808
7859
|
*/ /**
|
|
7809
7860
|
* Constructs a new JourneyApi.
|
|
7810
7861
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -7920,16 +7971,15 @@ if(actionTemplateId===undefined||actionTemplateId===null){throw'Missing the requ
|
|
|
7920
7971
|
*
|
|
7921
7972
|
* @param {String} deploymentId The ID of the deployment sending the ping.
|
|
7922
7973
|
* @param {String} customerCookieId ID of the customer associated with the ping.
|
|
7923
|
-
* @param {String} sessionId UUID of the customer session. Use the same Session Id for all pings, AppEvents and ActionEvents in the session
|
|
7924
7974
|
* @param {Object} opts Optional parameters
|
|
7925
7975
|
* @param {String} opts.dl Document Location: 1) Web Page URL if overridden or URL fragment identifier (window.location.hash). OR 2) Application screen name that the ping request was sent from in the app. e.g. 'home' or 'help. Pings without this parameter will not return actions.
|
|
7926
7976
|
* @param {String} opts.dt Document Title. A human readable name for the page or screen
|
|
7927
7977
|
* @param {String} opts.appNamespace Namespace of the application (e.g. com.genesys.bancodinero). Used for domain filtering in application sessions
|
|
7978
|
+
* @param {String} opts.sessionId UUID of the customer session. Use the same Session Id for all pings, AppEvents and ActionEvents in the session
|
|
7928
7979
|
* @param {Number} opts.sinceLastBeaconMilliseconds How long (milliseconds) since the last app event or beacon was sent. The response may return a pollInternvalMilliseconds to reduce the frequency of pings.
|
|
7929
|
-
*/},{key:"getJourneyDeploymentCustomerPing",value:function getJourneyDeploymentCustomerPing(deploymentId,customerCookieId,
|
|
7980
|
+
*/},{key:"getJourneyDeploymentCustomerPing",value:function getJourneyDeploymentCustomerPing(deploymentId,customerCookieId,opts){opts=opts||{};// verify the required parameter 'deploymentId' is set
|
|
7930
7981
|
if(deploymentId===undefined||deploymentId===null){throw'Missing the required parameter "deploymentId" when calling getJourneyDeploymentCustomerPing';}// verify the required parameter 'customerCookieId' is set
|
|
7931
|
-
if(customerCookieId===undefined||customerCookieId===null){throw'Missing the required parameter "customerCookieId" when calling getJourneyDeploymentCustomerPing';}
|
|
7932
|
-
if(sessionId===undefined||sessionId===null){throw'Missing the required parameter "sessionId" when calling getJourneyDeploymentCustomerPing';}return this.apiClient.callApi('/api/v2/journey/deployments/{deploymentId}/customers/{customerCookieId}/ping','GET',{'deploymentId':deploymentId,'customerCookieId':customerCookieId},{'dl':opts['dl'],'dt':opts['dt'],'appNamespace':opts['appNamespace'],'sessionId':sessionId,'sinceLastBeaconMilliseconds':opts['sinceLastBeaconMilliseconds']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7982
|
+
if(customerCookieId===undefined||customerCookieId===null){throw'Missing the required parameter "customerCookieId" when calling getJourneyDeploymentCustomerPing';}return this.apiClient.callApi('/api/v2/journey/deployments/{deploymentId}/customers/{customerCookieId}/ping','GET',{'deploymentId':deploymentId,'customerCookieId':customerCookieId},{'dl':opts['dl'],'dt':opts['dt'],'appNamespace':opts['appNamespace'],'sessionId':opts['sessionId'],'sinceLastBeaconMilliseconds':opts['sinceLastBeaconMilliseconds']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7933
7983
|
* Retrieve a single outcome.
|
|
7934
7984
|
*
|
|
7935
7985
|
* @param {String} outcomeId ID of the outcome.
|
|
@@ -8109,7 +8159,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
8109
8159
|
*/},{key:"postJourneySegments",value:function postJourneySegments(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/journey/segments','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return JourneyApi;}();var KnowledgeApi=/*#__PURE__*/function(){/**
|
|
8110
8160
|
* Knowledge service.
|
|
8111
8161
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
8112
|
-
* @version
|
|
8162
|
+
* @version 184.0.0
|
|
8113
8163
|
*/ /**
|
|
8114
8164
|
* Constructs a new KnowledgeApi.
|
|
8115
8165
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -8906,7 +8956,7 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
8906
8956
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postKnowledgeKnowledgebases';}return this.apiClient.callApi('/api/v2/knowledge/knowledgebases','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return KnowledgeApi;}();var LanguageUnderstandingApi=/*#__PURE__*/function(){/**
|
|
8907
8957
|
* LanguageUnderstanding service.
|
|
8908
8958
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
8909
|
-
* @version
|
|
8959
|
+
* @version 184.0.0
|
|
8910
8960
|
*/ /**
|
|
8911
8961
|
* Constructs a new LanguageUnderstandingApi.
|
|
8912
8962
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -9162,7 +9212,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
9162
9212
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putLanguageunderstandingDomainVersion';}return this.apiClient.callApi('/api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}','PUT',{'domainId':domainId,'domainVersionId':domainVersionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return LanguageUnderstandingApi;}();var LanguagesApi=/*#__PURE__*/function(){/**
|
|
9163
9213
|
* Languages service.
|
|
9164
9214
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
9165
|
-
* @version
|
|
9215
|
+
* @version 184.0.0
|
|
9166
9216
|
*/ /**
|
|
9167
9217
|
* Constructs a new LanguagesApi.
|
|
9168
9218
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -9217,7 +9267,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
9217
9267
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postLanguages';}return this.apiClient.callApi('/api/v2/languages','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return LanguagesApi;}();var LearningApi=/*#__PURE__*/function(){/**
|
|
9218
9268
|
* Learning service.
|
|
9219
9269
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
9220
|
-
* @version
|
|
9270
|
+
* @version 184.0.0
|
|
9221
9271
|
*/ /**
|
|
9222
9272
|
* Constructs a new LearningApi.
|
|
9223
9273
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -9320,7 +9370,8 @@ if(versionId===undefined||versionId===null){throw'Missing the required parameter
|
|
|
9320
9370
|
* @param {Array.<String>} opts.expand Fields to expand in response(case insensitive)
|
|
9321
9371
|
* @param {Object} opts.isPublished Specifies if only the Unpublished (isPublished is False) or Published (isPublished is True) modules are returned. If isPublished is Any or omitted, both types are returned (default to Any)
|
|
9322
9372
|
* @param {Array.<String>} opts.statuses Specifies the module statuses to filter by
|
|
9323
|
-
|
|
9373
|
+
* @param {Array.<String>} opts.externalIds Specifies the module external IDs to filter by. Only one ID is allowed
|
|
9374
|
+
*/},{key:"getLearningModules",value:function getLearningModules(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/learning/modules','GET',{},{'isArchived':opts['isArchived'],'types':this.apiClient.buildCollectionParam(opts['types'],'multi'),'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortOrder':opts['sortOrder'],'sortBy':opts['sortBy'],'searchTerm':opts['searchTerm'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'isPublished':opts['isPublished'],'statuses':this.apiClient.buildCollectionParam(opts['statuses'],'multi'),'externalIds':this.apiClient.buildCollectionParam(opts['externalIds'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9324
9375
|
* Get all learning modules of an organization including assignments for a specific user
|
|
9325
9376
|
*
|
|
9326
9377
|
* @param {Array.<String>} userIds The IDs of the users to include
|
|
@@ -9352,6 +9403,16 @@ if(assignmentId===undefined||assignmentId===null){throw'Missing the required par
|
|
|
9352
9403
|
* @param {Object} opts.body The Learning assignment reschedule model
|
|
9353
9404
|
*/},{key:"patchLearningAssignmentReschedule",value:function patchLearningAssignmentReschedule(assignmentId,opts){opts=opts||{};// verify the required parameter 'assignmentId' is set
|
|
9354
9405
|
if(assignmentId===undefined||assignmentId===null){throw'Missing the required parameter "assignmentId" when calling patchLearningAssignmentReschedule';}return this.apiClient.callApi('/api/v2/learning/assignments/{assignmentId}/reschedule','PATCH',{'assignmentId':assignmentId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9406
|
+
* Update an external assignment for a specific user
|
|
9407
|
+
*
|
|
9408
|
+
* @param {String} moduleId Key identifier for the module
|
|
9409
|
+
* @param {String} userId Key identifier for the user
|
|
9410
|
+
* @param {Object} body The learning request for updating the assignment
|
|
9411
|
+
* patchLearningModuleUserAssignments is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9412
|
+
*/},{key:"patchLearningModuleUserAssignments",value:function patchLearningModuleUserAssignments(moduleId,userId,body){// verify the required parameter 'moduleId' is set
|
|
9413
|
+
if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "moduleId" when calling patchLearningModuleUserAssignments';}// verify the required parameter 'userId' is set
|
|
9414
|
+
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling patchLearningModuleUserAssignments';}// verify the required parameter 'body' is set
|
|
9415
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchLearningModuleUserAssignments';}return this.apiClient.callApi('/api/v2/learning/modules/{moduleId}/users/{userId}/assignments','PATCH',{'moduleId':moduleId,'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9355
9416
|
* Score learning assessment for preview
|
|
9356
9417
|
*
|
|
9357
9418
|
* @param {Object} body Assessment form and answers to score
|
|
@@ -9436,7 +9497,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
9436
9497
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putLearningModuleRule';}return this.apiClient.callApi('/api/v2/learning/modules/{moduleId}/rule','PUT',{'moduleId':moduleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return LearningApi;}();var LicenseApi=/*#__PURE__*/function(){/**
|
|
9437
9498
|
* License service.
|
|
9438
9499
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
9439
|
-
* @version
|
|
9500
|
+
* @version 184.0.0
|
|
9440
9501
|
*/ /**
|
|
9441
9502
|
* Constructs a new LicenseApi.
|
|
9442
9503
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -9490,7 +9551,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
9490
9551
|
*/},{key:"postLicenseUsers",value:function postLicenseUsers(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/license/users','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return LicenseApi;}();var LocationsApi=/*#__PURE__*/function(){/**
|
|
9491
9552
|
* Locations service.
|
|
9492
9553
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
9493
|
-
* @version
|
|
9554
|
+
* @version 184.0.0
|
|
9494
9555
|
*/ /**
|
|
9495
9556
|
* Constructs a new LocationsApi.
|
|
9496
9557
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -9546,10 +9607,30 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9546
9607
|
*
|
|
9547
9608
|
* @param {Object} body Search request options
|
|
9548
9609
|
*/},{key:"postLocationsSearch",value:function postLocationsSearch(body){// verify the required parameter 'body' is set
|
|
9549
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postLocationsSearch';}return this.apiClient.callApi('/api/v2/locations/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return LocationsApi;}();var
|
|
9610
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postLocationsSearch';}return this.apiClient.callApi('/api/v2/locations/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return LocationsApi;}();var LogCaptureApi=/*#__PURE__*/function(){/**
|
|
9611
|
+
* LogCapture service.
|
|
9612
|
+
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
9613
|
+
* @version 184.0.0
|
|
9614
|
+
*/ /**
|
|
9615
|
+
* Constructs a new LogCaptureApi.
|
|
9616
|
+
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
9617
|
+
* @class
|
|
9618
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
9619
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
9620
|
+
*/function LogCaptureApi(apiClient){_classCallCheck(this,LogCaptureApi);this.apiClient=apiClient||ApiClient.instance;}/**
|
|
9621
|
+
* Gets status of async download execution
|
|
9622
|
+
*
|
|
9623
|
+
* @param {String} jobId Job ID
|
|
9624
|
+
*/_createClass(LogCaptureApi,[{key:"getDiagnosticsLogcaptureBrowserEntriesDownloadJob",value:function getDiagnosticsLogcaptureBrowserEntriesDownloadJob(jobId){// verify the required parameter 'jobId' is set
|
|
9625
|
+
if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId" when calling getDiagnosticsLogcaptureBrowserEntriesDownloadJob';}return this.apiClient.callApi('/api/v2/diagnostics/logcapture/browser/entries/download/jobs/{jobId}','GET',{'jobId':jobId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9626
|
+
* Creates an async download execution
|
|
9627
|
+
*
|
|
9628
|
+
* @param {Object} opts Optional parameters
|
|
9629
|
+
* @param {Object} opts.body
|
|
9630
|
+
*/},{key:"postDiagnosticsLogcaptureBrowserEntriesDownloadJobs",value:function postDiagnosticsLogcaptureBrowserEntriesDownloadJobs(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/diagnostics/logcapture/browser/entries/download/jobs','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return LogCaptureApi;}();var MessagingApi=/*#__PURE__*/function(){/**
|
|
9550
9631
|
* Messaging service.
|
|
9551
9632
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
9552
|
-
* @version
|
|
9633
|
+
* @version 184.0.0
|
|
9553
9634
|
*/ /**
|
|
9554
9635
|
* Constructs a new MessagingApi.
|
|
9555
9636
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -9639,7 +9720,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9639
9720
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putMessagingSettingsDefault';}return this.apiClient.callApi('/api/v2/messaging/settings/default','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return MessagingApi;}();var MobileDevicesApi=/*#__PURE__*/function(){/**
|
|
9640
9721
|
* MobileDevices service.
|
|
9641
9722
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
9642
|
-
* @version
|
|
9723
|
+
* @version 184.0.0
|
|
9643
9724
|
*/ /**
|
|
9644
9725
|
* Constructs a new MobileDevicesApi.
|
|
9645
9726
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -9678,7 +9759,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9678
9759
|
if(deviceId===undefined||deviceId===null){throw'Missing the required parameter "deviceId" when calling putMobiledevice';}return this.apiClient.callApi('/api/v2/mobiledevices/{deviceId}','PUT',{'deviceId':deviceId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return MobileDevicesApi;}();var NotificationsApi=/*#__PURE__*/function(){/**
|
|
9679
9760
|
* Notifications service.
|
|
9680
9761
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
9681
|
-
* @version
|
|
9762
|
+
* @version 184.0.0
|
|
9682
9763
|
*/ /**
|
|
9683
9764
|
* Constructs a new NotificationsApi.
|
|
9684
9765
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -9735,7 +9816,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
9735
9816
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putNotificationsChannelSubscriptions';}return this.apiClient.callApi('/api/v2/notifications/channels/{channelId}/subscriptions','PUT',{'channelId':channelId},{'ignoreErrors':opts['ignoreErrors']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return NotificationsApi;}();var OAuthApi=/*#__PURE__*/function(){/**
|
|
9736
9817
|
* OAuth service.
|
|
9737
9818
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
9738
|
-
* @version
|
|
9819
|
+
* @version 184.0.0
|
|
9739
9820
|
*/ /**
|
|
9740
9821
|
* Constructs a new OAuthApi.
|
|
9741
9822
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -9820,7 +9901,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
9820
9901
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOauthClient';}return this.apiClient.callApi('/api/v2/oauth/clients/{clientId}','PUT',{'clientId':clientId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return OAuthApi;}();var ObjectsApi=/*#__PURE__*/function(){/**
|
|
9821
9902
|
* Objects service.
|
|
9822
9903
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
9823
|
-
* @version
|
|
9904
|
+
* @version 184.0.0
|
|
9824
9905
|
*/ /**
|
|
9825
9906
|
* Constructs a new ObjectsApi.
|
|
9826
9907
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -9873,10 +9954,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9873
9954
|
* Recreate a previously deleted division.
|
|
9874
9955
|
*
|
|
9875
9956
|
* @param {String} divisionId Division ID
|
|
9876
|
-
* @param {Object}
|
|
9877
|
-
|
|
9878
|
-
|
|
9879
|
-
if(
|
|
9957
|
+
* @param {Object} opts Optional parameters
|
|
9958
|
+
* @param {Object} opts.body Recreated division data
|
|
9959
|
+
*/},{key:"postAuthorizationDivisionRestore",value:function postAuthorizationDivisionRestore(divisionId,opts){opts=opts||{};// verify the required parameter 'divisionId' is set
|
|
9960
|
+
if(divisionId===undefined||divisionId===null){throw'Missing the required parameter "divisionId" when calling postAuthorizationDivisionRestore';}return this.apiClient.callApi('/api/v2/authorization/divisions/{divisionId}/restore','POST',{'divisionId':divisionId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9880
9961
|
* Create a division.
|
|
9881
9962
|
*
|
|
9882
9963
|
* @param {Object} body Division
|
|
@@ -9891,7 +9972,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
9891
9972
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAuthorizationDivision';}return this.apiClient.callApi('/api/v2/authorization/divisions/{divisionId}','PUT',{'divisionId':divisionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return ObjectsApi;}();var OperationalEventsApi=/*#__PURE__*/function(){/**
|
|
9892
9973
|
* OperationalEvents service.
|
|
9893
9974
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
9894
|
-
* @version
|
|
9975
|
+
* @version 184.0.0
|
|
9895
9976
|
*/ /**
|
|
9896
9977
|
* Constructs a new OperationalEventsApi.
|
|
9897
9978
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -9909,7 +9990,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
9909
9990
|
*/},{key:"getUsageEventsDefinitions",value:function getUsageEventsDefinitions(){return this.apiClient.callApi('/api/v2/usage/events/definitions','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return OperationalEventsApi;}();var OrganizationApi=/*#__PURE__*/function(){/**
|
|
9910
9991
|
* Organization service.
|
|
9911
9992
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
9912
|
-
* @version
|
|
9993
|
+
* @version 184.0.0
|
|
9913
9994
|
*/ /**
|
|
9914
9995
|
* Constructs a new OrganizationApi.
|
|
9915
9996
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -10011,7 +10092,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10011
10092
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOrganizationsWhitelist';}return this.apiClient.callApi('/api/v2/organizations/whitelist','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return OrganizationApi;}();var OrganizationAuthorizationApi=/*#__PURE__*/function(){/**
|
|
10012
10093
|
* OrganizationAuthorization service.
|
|
10013
10094
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
10014
|
-
* @version
|
|
10095
|
+
* @version 184.0.0
|
|
10015
10096
|
*/ /**
|
|
10016
10097
|
* Constructs a new OrganizationAuthorizationApi.
|
|
10017
10098
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -10334,7 +10415,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
10334
10415
|
if(trusteeUserId===undefined||trusteeUserId===null){throw'Missing the required parameter "trusteeUserId" when calling putOrgauthorizationTrustorUser';}return this.apiClient.callApi('/api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId}','PUT',{'trustorOrgId':trustorOrgId,'trusteeUserId':trusteeUserId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return OrganizationAuthorizationApi;}();var OutboundApi=/*#__PURE__*/function(){/**
|
|
10335
10416
|
* Outbound service.
|
|
10336
10417
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
10337
|
-
* @version
|
|
10418
|
+
* @version 184.0.0
|
|
10338
10419
|
*/ /**
|
|
10339
10420
|
* Constructs a new OutboundApi.
|
|
10340
10421
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -10401,6 +10482,16 @@ if(contactListFilterId===undefined||contactListFilterId===null){throw'Missing th
|
|
|
10401
10482
|
* @param {Array.<String>} id contact list id(s) to delete
|
|
10402
10483
|
*/},{key:"deleteOutboundContactlists",value:function deleteOutboundContactlists(id){// verify the required parameter 'id' is set
|
|
10403
10484
|
if(id===undefined||id===null){throw'Missing the required parameter "id" when calling deleteOutboundContactlists';}return this.apiClient.callApi('/api/v2/outbound/contactlists','DELETE',{},{'id':this.apiClient.buildCollectionParam(id,'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10485
|
+
* Delete Contact List Template
|
|
10486
|
+
*
|
|
10487
|
+
* @param {String} contactListTemplateId ContactListTemplate ID
|
|
10488
|
+
*/},{key:"deleteOutboundContactlisttemplate",value:function deleteOutboundContactlisttemplate(contactListTemplateId){// verify the required parameter 'contactListTemplateId' is set
|
|
10489
|
+
if(contactListTemplateId===undefined||contactListTemplateId===null){throw'Missing the required parameter "contactListTemplateId" when calling deleteOutboundContactlisttemplate';}return this.apiClient.callApi('/api/v2/outbound/contactlisttemplates/{contactListTemplateId}','DELETE',{'contactListTemplateId':contactListTemplateId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10490
|
+
* Delete multiple contact list templates.
|
|
10491
|
+
*
|
|
10492
|
+
* @param {Array.<String>} id contact list template id(s) to delete
|
|
10493
|
+
*/},{key:"deleteOutboundContactlisttemplates",value:function deleteOutboundContactlisttemplates(id){// verify the required parameter 'id' is set
|
|
10494
|
+
if(id===undefined||id===null){throw'Missing the required parameter "id" when calling deleteOutboundContactlisttemplates';}return this.apiClient.callApi('/api/v2/outbound/contactlisttemplates','DELETE',{},{'id':this.apiClient.buildCollectionParam(id,'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10404
10495
|
* Delete an Outbound Digital Rule Set
|
|
10405
10496
|
*
|
|
10406
10497
|
* @param {String} digitalRuleSetId The Digital Rule Set ID
|
|
@@ -10432,6 +10523,16 @@ if(dncListId===undefined||dncListId===null){throw'Missing the required parameter
|
|
|
10432
10523
|
* @param {Boolean} opts.expiredOnly Set to true to only remove DNC entries that are expired (default to false)
|
|
10433
10524
|
*/},{key:"deleteOutboundDnclistPhonenumbers",value:function deleteOutboundDnclistPhonenumbers(dncListId,opts){opts=opts||{};// verify the required parameter 'dncListId' is set
|
|
10434
10525
|
if(dncListId===undefined||dncListId===null){throw'Missing the required parameter "dncListId" when calling deleteOutboundDnclistPhonenumbers';}return this.apiClient.callApi('/api/v2/outbound/dnclists/{dncListId}/phonenumbers','DELETE',{'dncListId':dncListId},{'expiredOnly':opts['expiredOnly']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10526
|
+
* Delete Import Template
|
|
10527
|
+
*
|
|
10528
|
+
* @param {String} importTemplateId Import Template ID
|
|
10529
|
+
*/},{key:"deleteOutboundImporttemplate",value:function deleteOutboundImporttemplate(importTemplateId){// verify the required parameter 'importTemplateId' is set
|
|
10530
|
+
if(importTemplateId===undefined||importTemplateId===null){throw'Missing the required parameter "importTemplateId" when calling deleteOutboundImporttemplate';}return this.apiClient.callApi('/api/v2/outbound/importtemplates/{importTemplateId}','DELETE',{'importTemplateId':importTemplateId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10531
|
+
* Delete multiple import templates.
|
|
10532
|
+
*
|
|
10533
|
+
* @param {Array.<String>} id import template id(s) to delete
|
|
10534
|
+
*/},{key:"deleteOutboundImporttemplates",value:function deleteOutboundImporttemplates(id){// verify the required parameter 'id' is set
|
|
10535
|
+
if(id===undefined||id===null){throw'Missing the required parameter "id" when calling deleteOutboundImporttemplates';}return this.apiClient.callApi('/api/v2/outbound/importtemplates','DELETE',{},{'id':this.apiClient.buildCollectionParam(id,'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10435
10536
|
* Delete an Outbound Messaging Campaign
|
|
10436
10537
|
*
|
|
10437
10538
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
@@ -10706,6 +10807,22 @@ if(contactListId===undefined||contactListId===null){throw'Missing the required p
|
|
|
10706
10807
|
* @param {String} opts.sortBy Sort by
|
|
10707
10808
|
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
10708
10809
|
*/},{key:"getOutboundContactlistsDivisionviews",value:function getOutboundContactlistsDivisionviews(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/outbound/contactlists/divisionviews','GET',{},{'includeImportStatus':opts['includeImportStatus'],'includeSize':opts['includeSize'],'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'filterType':opts['filterType'],'name':opts['name'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10810
|
+
* Get Contact List Template
|
|
10811
|
+
*
|
|
10812
|
+
* @param {String} contactListTemplateId ContactListTemplate ID
|
|
10813
|
+
*/},{key:"getOutboundContactlisttemplate",value:function getOutboundContactlisttemplate(contactListTemplateId){// verify the required parameter 'contactListTemplateId' is set
|
|
10814
|
+
if(contactListTemplateId===undefined||contactListTemplateId===null){throw'Missing the required parameter "contactListTemplateId" when calling getOutboundContactlisttemplate';}return this.apiClient.callApi('/api/v2/outbound/contactlisttemplates/{contactListTemplateId}','GET',{'contactListTemplateId':contactListTemplateId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10815
|
+
* Query a list of contact list templates
|
|
10816
|
+
*
|
|
10817
|
+
* @param {Object} opts Optional parameters
|
|
10818
|
+
* @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
|
|
10819
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
10820
|
+
* @param {Boolean} opts.allowEmptyResult Whether to return an empty page when there are no results for that page (default to false)
|
|
10821
|
+
* @param {Object} opts.filterType Filter type (default to Prefix)
|
|
10822
|
+
* @param {String} opts.name Name
|
|
10823
|
+
* @param {String} opts.sortBy Sort by
|
|
10824
|
+
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
10825
|
+
*/},{key:"getOutboundContactlisttemplates",value:function getOutboundContactlisttemplates(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/outbound/contactlisttemplates','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'allowEmptyResult':opts['allowEmptyResult'],'filterType':opts['filterType'],'name':opts['name'],'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10709
10826
|
* Get an Outbound Digital Rule Set
|
|
10710
10827
|
*
|
|
10711
10828
|
* @param {String} digitalRuleSetId The Digital Rule Set ID
|
|
@@ -10794,6 +10911,30 @@ if(eventId===undefined||eventId===null){throw'Missing the required parameter "ev
|
|
|
10794
10911
|
* @param {String} opts.sortBy Sort by
|
|
10795
10912
|
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
10796
10913
|
*/},{key:"getOutboundEvents",value:function getOutboundEvents(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/outbound/events','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'filterType':opts['filterType'],'category':opts['category'],'level':opts['level'],'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10914
|
+
* Get Import Template
|
|
10915
|
+
*
|
|
10916
|
+
* @param {String} importTemplateId Import Template ID
|
|
10917
|
+
*/},{key:"getOutboundImporttemplate",value:function getOutboundImporttemplate(importTemplateId){// verify the required parameter 'importTemplateId' is set
|
|
10918
|
+
if(importTemplateId===undefined||importTemplateId===null){throw'Missing the required parameter "importTemplateId" when calling getOutboundImporttemplate';}return this.apiClient.callApi('/api/v2/outbound/importtemplates/{importTemplateId}','GET',{'importTemplateId':importTemplateId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10919
|
+
* Get the import status for an import template.
|
|
10920
|
+
*
|
|
10921
|
+
* @param {String} importTemplateId importTemplateId
|
|
10922
|
+
* @param {Object} opts Optional parameters
|
|
10923
|
+
* @param {String} opts.listNamePrefix listNamePrefix
|
|
10924
|
+
*/},{key:"getOutboundImporttemplateImportstatus",value:function getOutboundImporttemplateImportstatus(importTemplateId,opts){opts=opts||{};// verify the required parameter 'importTemplateId' is set
|
|
10925
|
+
if(importTemplateId===undefined||importTemplateId===null){throw'Missing the required parameter "importTemplateId" when calling getOutboundImporttemplateImportstatus';}return this.apiClient.callApi('/api/v2/outbound/importtemplates/{importTemplateId}/importstatus','GET',{'importTemplateId':importTemplateId},{'listNamePrefix':opts['listNamePrefix']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10926
|
+
* Query Import Templates
|
|
10927
|
+
*
|
|
10928
|
+
* @param {Object} opts Optional parameters
|
|
10929
|
+
* @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
|
|
10930
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
10931
|
+
* @param {Boolean} opts.allowEmptyResult Whether to return an empty page when there are no results for that page (default to false)
|
|
10932
|
+
* @param {Object} opts.filterType Filter type (default to Prefix)
|
|
10933
|
+
* @param {String} opts.name Name
|
|
10934
|
+
* @param {String} opts.sortBy Sort by
|
|
10935
|
+
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
10936
|
+
* @param {String} opts.contactListTemplateId Contact List Template ID
|
|
10937
|
+
*/},{key:"getOutboundImporttemplates",value:function getOutboundImporttemplates(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/outbound/importtemplates','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'allowEmptyResult':opts['allowEmptyResult'],'filterType':opts['filterType'],'name':opts['name'],'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder'],'contactListTemplateId':opts['contactListTemplateId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
10797
10938
|
* Get an Outbound Messaging Campaign
|
|
10798
10939
|
*
|
|
10799
10940
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
@@ -11032,6 +11173,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11032
11173
|
* @param {Object} body ContactList
|
|
11033
11174
|
*/},{key:"postOutboundContactlists",value:function postOutboundContactlists(body){// verify the required parameter 'body' is set
|
|
11034
11175
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postOutboundContactlists';}return this.apiClient.callApi('/api/v2/outbound/contactlists','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11176
|
+
* Create Contact List Template
|
|
11177
|
+
*
|
|
11178
|
+
* @param {Object} body ContactListTemplate
|
|
11179
|
+
*/},{key:"postOutboundContactlisttemplates",value:function postOutboundContactlisttemplates(body){// verify the required parameter 'body' is set
|
|
11180
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postOutboundContactlisttemplates';}return this.apiClient.callApi('/api/v2/outbound/contactlisttemplates','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11181
|
+
* Add multiple contact list templates
|
|
11182
|
+
*
|
|
11183
|
+
* @param {Array.<Object>} body contact list template(s) to add
|
|
11184
|
+
*/},{key:"postOutboundContactlisttemplatesBulkAdd",value:function postOutboundContactlisttemplatesBulkAdd(body){// verify the required parameter 'body' is set
|
|
11185
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postOutboundContactlisttemplatesBulkAdd';}return this.apiClient.callApi('/api/v2/outbound/contactlisttemplates/bulk/add','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11035
11186
|
* Add phone numbers to a Dialer DNC list.
|
|
11036
11187
|
*
|
|
11037
11188
|
* @param {String} conversationId Conversation ID
|
|
@@ -11068,6 +11219,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11068
11219
|
* @param {Object} body DncList
|
|
11069
11220
|
*/},{key:"postOutboundDnclists",value:function postOutboundDnclists(body){// verify the required parameter 'body' is set
|
|
11070
11221
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postOutboundDnclists';}return this.apiClient.callApi('/api/v2/outbound/dnclists','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11222
|
+
* Create Import Template
|
|
11223
|
+
*
|
|
11224
|
+
* @param {Object} body ImportTemplate
|
|
11225
|
+
*/},{key:"postOutboundImporttemplates",value:function postOutboundImporttemplates(body){// verify the required parameter 'body' is set
|
|
11226
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postOutboundImporttemplates';}return this.apiClient.callApi('/api/v2/outbound/importtemplates','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11227
|
+
* Add multiple import templates
|
|
11228
|
+
*
|
|
11229
|
+
* @param {Array.<Object>} body import template(s) to add
|
|
11230
|
+
*/},{key:"postOutboundImporttemplatesBulkAdd",value:function postOutboundImporttemplatesBulkAdd(body){// verify the required parameter 'body' is set
|
|
11231
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postOutboundImporttemplatesBulkAdd';}return this.apiClient.callApi('/api/v2/outbound/importtemplates/bulk/add','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11071
11232
|
* Create a Messaging Campaign
|
|
11072
11233
|
*
|
|
11073
11234
|
* @param {Object} body Messaging Campaign
|
|
@@ -11155,6 +11316,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11155
11316
|
*/},{key:"putOutboundContactlistfilter",value:function putOutboundContactlistfilter(contactListFilterId,body){// verify the required parameter 'contactListFilterId' is set
|
|
11156
11317
|
if(contactListFilterId===undefined||contactListFilterId===null){throw'Missing the required parameter "contactListFilterId" when calling putOutboundContactlistfilter';}// verify the required parameter 'body' is set
|
|
11157
11318
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOutboundContactlistfilter';}return this.apiClient.callApi('/api/v2/outbound/contactlistfilters/{contactListFilterId}','PUT',{'contactListFilterId':contactListFilterId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11319
|
+
* Update a contact list template.
|
|
11320
|
+
*
|
|
11321
|
+
* @param {String} contactListTemplateId ContactListTemplate ID
|
|
11322
|
+
* @param {Object} body ContactListTemplate
|
|
11323
|
+
*/},{key:"putOutboundContactlisttemplate",value:function putOutboundContactlisttemplate(contactListTemplateId,body){// verify the required parameter 'contactListTemplateId' is set
|
|
11324
|
+
if(contactListTemplateId===undefined||contactListTemplateId===null){throw'Missing the required parameter "contactListTemplateId" when calling putOutboundContactlisttemplate';}// verify the required parameter 'body' is set
|
|
11325
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOutboundContactlisttemplate';}return this.apiClient.callApi('/api/v2/outbound/contactlisttemplates/{contactListTemplateId}','PUT',{'contactListTemplateId':contactListTemplateId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11158
11326
|
* Update an Outbound Digital Rule Set
|
|
11159
11327
|
*
|
|
11160
11328
|
* @param {String} digitalRuleSetId The Digital Rule Set ID
|
|
@@ -11169,6 +11337,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11169
11337
|
*/},{key:"putOutboundDnclist",value:function putOutboundDnclist(dncListId,body){// verify the required parameter 'dncListId' is set
|
|
11170
11338
|
if(dncListId===undefined||dncListId===null){throw'Missing the required parameter "dncListId" when calling putOutboundDnclist';}// verify the required parameter 'body' is set
|
|
11171
11339
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOutboundDnclist';}return this.apiClient.callApi('/api/v2/outbound/dnclists/{dncListId}','PUT',{'dncListId':dncListId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11340
|
+
* Update Import Template
|
|
11341
|
+
*
|
|
11342
|
+
* @param {String} importTemplateId Import Template ID
|
|
11343
|
+
* @param {Object} body importTemplate
|
|
11344
|
+
*/},{key:"putOutboundImporttemplate",value:function putOutboundImporttemplate(importTemplateId,body){// verify the required parameter 'importTemplateId' is set
|
|
11345
|
+
if(importTemplateId===undefined||importTemplateId===null){throw'Missing the required parameter "importTemplateId" when calling putOutboundImporttemplate';}// verify the required parameter 'body' is set
|
|
11346
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOutboundImporttemplate';}return this.apiClient.callApi('/api/v2/outbound/importtemplates/{importTemplateId}','PUT',{'importTemplateId':importTemplateId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11172
11347
|
* Update an Outbound Messaging Campaign
|
|
11173
11348
|
*
|
|
11174
11349
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
@@ -11225,7 +11400,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11225
11400
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putOutboundWrapupcodemappings';}return this.apiClient.callApi('/api/v2/outbound/wrapupcodemappings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return OutboundApi;}();var PresenceApi=/*#__PURE__*/function(){/**
|
|
11226
11401
|
* Presence service.
|
|
11227
11402
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
11228
|
-
* @version
|
|
11403
|
+
* @version 184.0.0
|
|
11229
11404
|
*/ /**
|
|
11230
11405
|
* Constructs a new PresenceApi.
|
|
11231
11406
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -11236,7 +11411,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11236
11411
|
* Delete a Presence Definition
|
|
11237
11412
|
*
|
|
11238
11413
|
* @param {String} definitionId Presence Definition ID
|
|
11239
|
-
* deletePresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11240
11414
|
*/_createClass(PresenceApi,[{key:"deletePresenceDefinition0",value:function deletePresenceDefinition0(definitionId){// verify the required parameter 'definitionId' is set
|
|
11241
11415
|
if(definitionId===undefined||definitionId===null){throw'Missing the required parameter "definitionId" when calling deletePresenceDefinition0';}return this.apiClient.callApi('/api/v2/presence/definitions/{definitionId}','DELETE',{'definitionId':definitionId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11242
11416
|
* Delete a Presence Source
|
|
@@ -11254,7 +11428,6 @@ if(presenceId===undefined||presenceId===null){throw'Missing the required paramet
|
|
|
11254
11428
|
* @param {String} definitionId Presence Definition ID
|
|
11255
11429
|
* @param {Object} opts Optional parameters
|
|
11256
11430
|
* @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
11257
|
-
* getPresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11258
11431
|
*/},{key:"getPresenceDefinition0",value:function getPresenceDefinition0(definitionId,opts){opts=opts||{};// verify the required parameter 'definitionId' is set
|
|
11259
11432
|
if(definitionId===undefined||definitionId===null){throw'Missing the required parameter "definitionId" when calling getPresenceDefinition0';}return this.apiClient.callApi('/api/v2/presence/definitions/{definitionId}','GET',{'definitionId':definitionId},{'localeCode':opts['localeCode']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11260
11433
|
* Get a list of Presence Definitions
|
|
@@ -11263,7 +11436,6 @@ if(definitionId===undefined||definitionId===null){throw'Missing the required par
|
|
|
11263
11436
|
* @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
|
|
11264
11437
|
* @param {Array.<String>} opts.divisionId One or more division IDs. If nothing is provided, the definitions associated withthe list of divisions that the user has access to will be returned.
|
|
11265
11438
|
* @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
11266
|
-
* getPresenceDefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11267
11439
|
*/},{key:"getPresenceDefinitions0",value:function getPresenceDefinitions0(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/presence/definitions','GET',{},{'deactivated':opts['deactivated'],'divisionId':this.apiClient.buildCollectionParam(opts['divisionId'],'multi'),'localeCode':opts['localeCode']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11268
11440
|
* Get the presence settings
|
|
11269
11441
|
*
|
|
@@ -11344,7 +11516,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11344
11516
|
* Create a Presence Definition
|
|
11345
11517
|
*
|
|
11346
11518
|
* @param {Object} body The Presence Definition to create
|
|
11347
|
-
* postPresenceDefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11348
11519
|
*/},{key:"postPresenceDefinitions0",value:function postPresenceDefinitions0(body){// verify the required parameter 'body' is set
|
|
11349
11520
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postPresenceDefinitions0';}return this.apiClient.callApi('/api/v2/presence/definitions','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11350
11521
|
* Create a Presence Source
|
|
@@ -11361,7 +11532,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11361
11532
|
*
|
|
11362
11533
|
* @param {String} definitionId Presence Definition ID
|
|
11363
11534
|
* @param {Object} body The updated Presence Definition
|
|
11364
|
-
* putPresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11365
11535
|
*/},{key:"putPresenceDefinition0",value:function putPresenceDefinition0(definitionId,body){// verify the required parameter 'definitionId' is set
|
|
11366
11536
|
if(definitionId===undefined||definitionId===null){throw'Missing the required parameter "definitionId" when calling putPresenceDefinition0';}// verify the required parameter 'body' is set
|
|
11367
11537
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putPresenceDefinition0';}return this.apiClient.callApi('/api/v2/presence/definitions/{definitionId}','PUT',{'definitionId':definitionId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -11398,7 +11568,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11398
11568
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUsersPresencesBulk';}return this.apiClient.callApi('/api/v2/users/presences/bulk','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return PresenceApi;}();var ProcessAutomationApi=/*#__PURE__*/function(){/**
|
|
11399
11569
|
* ProcessAutomation service.
|
|
11400
11570
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
11401
|
-
* @version
|
|
11571
|
+
* @version 184.0.0
|
|
11402
11572
|
*/ /**
|
|
11403
11573
|
* Constructs a new ProcessAutomationApi.
|
|
11404
11574
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -11461,7 +11631,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
11461
11631
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putProcessautomationTrigger';}return this.apiClient.callApi('/api/v2/processautomation/triggers/{triggerId}','PUT',{'triggerId':triggerId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return ProcessAutomationApi;}();var QualityApi=/*#__PURE__*/function(){/**
|
|
11462
11632
|
* Quality service.
|
|
11463
11633
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
11464
|
-
* @version
|
|
11634
|
+
* @version 184.0.0
|
|
11465
11635
|
*/ /**
|
|
11466
11636
|
* Constructs a new QualityApi.
|
|
11467
11637
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -11544,8 +11714,9 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
11544
11714
|
* @param {String} opts.evaluatorUserId user id of the evaluator
|
|
11545
11715
|
* @param {String} opts.name name
|
|
11546
11716
|
* @param {String} opts.group group id
|
|
11717
|
+
* @param {String} opts.agentTeamId team id of agents requested
|
|
11547
11718
|
* @param {String} opts.formContextId shared id between form versions
|
|
11548
|
-
*/},{key:"getQualityAgentsActivity",value:function getQualityAgentsActivity(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/quality/agents/activity','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'nextPage':opts['nextPage'],'previousPage':opts['previousPage'],'startTime':opts['startTime'],'endTime':opts['endTime'],'agentUserId':this.apiClient.buildCollectionParam(opts['agentUserId'],'multi'),'evaluatorUserId':opts['evaluatorUserId'],'name':opts['name'],'group':opts['group'],'formContextId':opts['formContextId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11719
|
+
*/},{key:"getQualityAgentsActivity",value:function getQualityAgentsActivity(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/quality/agents/activity','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'nextPage':opts['nextPage'],'previousPage':opts['previousPage'],'startTime':opts['startTime'],'endTime':opts['endTime'],'agentUserId':this.apiClient.buildCollectionParam(opts['agentUserId'],'multi'),'evaluatorUserId':opts['evaluatorUserId'],'name':opts['name'],'group':opts['group'],'agentTeamId':opts['agentTeamId'],'formContextId':opts['formContextId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11549
11720
|
* Get a calibration by id. Requires either calibrator id or conversation id
|
|
11550
11721
|
*
|
|
11551
11722
|
* @param {String} calibrationId Calibration ID
|
|
@@ -11608,6 +11779,7 @@ if(transactionId===undefined||transactionId===null){throw'Missing the required p
|
|
|
11608
11779
|
* @param {String} opts.previousPage Previous page token
|
|
11609
11780
|
* @param {String} opts.conversationId conversationId specified
|
|
11610
11781
|
* @param {String} opts.agentUserId user id of the agent
|
|
11782
|
+
* @param {String} opts.agentTeamId team id of the agent
|
|
11611
11783
|
* @param {String} opts.evaluatorUserId evaluator user id
|
|
11612
11784
|
* @param {String} opts.assigneeUserId assignee user id
|
|
11613
11785
|
* @param {String} opts.queueId queue id
|
|
@@ -11620,7 +11792,7 @@ if(transactionId===undefined||transactionId===null){throw'Missing the required p
|
|
|
11620
11792
|
* @param {Boolean} opts.expandAnswerTotalScores get the total scores for evaluations
|
|
11621
11793
|
* @param {Number} opts.maximum the maximum number of results to return
|
|
11622
11794
|
* @param {String} opts.sortOrder NOTE: Does not work when conversationId is supplied.
|
|
11623
|
-
*/},{key:"getQualityEvaluationsQuery",value:function getQualityEvaluationsQuery(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/quality/evaluations/query','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'nextPage':opts['nextPage'],'previousPage':opts['previousPage'],'conversationId':opts['conversationId'],'agentUserId':opts['agentUserId'],'evaluatorUserId':opts['evaluatorUserId'],'assigneeUserId':opts['assigneeUserId'],'queueId':opts['queueId'],'startTime':opts['startTime'],'endTime':opts['endTime'],'formContextId':opts['formContextId'],'evaluationState':this.apiClient.buildCollectionParam(opts['evaluationState'],'multi'),'isReleased':opts['isReleased'],'agentHasRead':opts['agentHasRead'],'expandAnswerTotalScores':opts['expandAnswerTotalScores'],'maximum':opts['maximum'],'sortOrder':opts['sortOrder']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11795
|
+
*/},{key:"getQualityEvaluationsQuery",value:function getQualityEvaluationsQuery(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/quality/evaluations/query','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'nextPage':opts['nextPage'],'previousPage':opts['previousPage'],'conversationId':opts['conversationId'],'agentUserId':opts['agentUserId'],'agentTeamId':opts['agentTeamId'],'evaluatorUserId':opts['evaluatorUserId'],'assigneeUserId':opts['assigneeUserId'],'queueId':opts['queueId'],'startTime':opts['startTime'],'endTime':opts['endTime'],'formContextId':opts['formContextId'],'evaluationState':this.apiClient.buildCollectionParam(opts['evaluationState'],'multi'),'isReleased':opts['isReleased'],'agentHasRead':opts['agentHasRead'],'expandAnswerTotalScores':opts['expandAnswerTotalScores'],'maximum':opts['maximum'],'sortOrder':opts['sortOrder']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11624
11796
|
* Get an evaluator activity
|
|
11625
11797
|
*
|
|
11626
11798
|
* @param {Object} opts Optional parameters
|
|
@@ -11635,7 +11807,8 @@ if(transactionId===undefined||transactionId===null){throw'Missing the required p
|
|
|
11635
11807
|
* @param {String} opts.name Evaluator name
|
|
11636
11808
|
* @param {Array.<String>} opts.permission permission strings
|
|
11637
11809
|
* @param {String} opts.group group id
|
|
11638
|
-
|
|
11810
|
+
* @param {String} opts.agentTeamId team id of agents to be considered
|
|
11811
|
+
*/},{key:"getQualityEvaluatorsActivity",value:function getQualityEvaluatorsActivity(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/quality/evaluators/activity','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'nextPage':opts['nextPage'],'previousPage':opts['previousPage'],'startTime':opts['startTime'],'endTime':opts['endTime'],'name':opts['name'],'permission':this.apiClient.buildCollectionParam(opts['permission'],'multi'),'group':opts['group'],'agentTeamId':opts['agentTeamId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
11639
11812
|
* Get an evaluation form
|
|
11640
11813
|
*
|
|
11641
11814
|
* @param {String} formId Form ID
|
|
@@ -11929,7 +12102,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
11929
12102
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putQualitySurveysScorable';}return this.apiClient.callApi('/api/v2/quality/surveys/scorable','PUT',{},{'customerSurveyUrl':customerSurveyUrl},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return QualityApi;}();var RecordingApi=/*#__PURE__*/function(){/**
|
|
11930
12103
|
* Recording service.
|
|
11931
12104
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
11932
|
-
* @version
|
|
12105
|
+
* @version 184.0.0
|
|
11933
12106
|
*/ /**
|
|
11934
12107
|
* Constructs a new RecordingApi.
|
|
11935
12108
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -12336,7 +12509,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12336
12509
|
*/},{key:"putRecordingsDeletionprotection",value:function putRecordingsDeletionprotection(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/recordings/deletionprotection','PUT',{},{'protect':opts['protect']},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return RecordingApi;}();var ResponseManagementApi=/*#__PURE__*/function(){/**
|
|
12337
12510
|
* ResponseManagement service.
|
|
12338
12511
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
12339
|
-
* @version
|
|
12512
|
+
* @version 184.0.0
|
|
12340
12513
|
*/ /**
|
|
12341
12514
|
* Constructs a new ResponseManagementApi.
|
|
12342
12515
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -12452,7 +12625,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
12452
12625
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putResponsemanagementResponseasset';}return this.apiClient.callApi('/api/v2/responsemanagement/responseassets/{responseAssetId}','PUT',{'responseAssetId':responseAssetId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return ResponseManagementApi;}();var RoutingApi=/*#__PURE__*/function(){/**
|
|
12453
12626
|
* Routing service.
|
|
12454
12627
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
12455
|
-
* @version
|
|
12628
|
+
* @version 184.0.0
|
|
12456
12629
|
*/ /**
|
|
12457
12630
|
* Constructs a new RoutingApi.
|
|
12458
12631
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -13358,7 +13531,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
13358
13531
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserRoutingskillsBulk';}return this.apiClient.callApi('/api/v2/users/{userId}/routingskills/bulk','PUT',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return RoutingApi;}();var SCIMApi=/*#__PURE__*/function(){/**
|
|
13359
13532
|
* SCIM service.
|
|
13360
13533
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
13361
|
-
* @version
|
|
13534
|
+
* @version 184.0.0
|
|
13362
13535
|
*/ /**
|
|
13363
13536
|
* Constructs a new SCIMApi.
|
|
13364
13537
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -13583,7 +13756,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
13583
13756
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putScimV2User';}return this.apiClient.callApi('/api/v2/scim/v2/users/{userId}','PUT',{'userId':userId},{},{'If-Match':opts['ifMatch']},{},body,['PureCloud OAuth'],['application/scim+json','application/json'],['application/scim+json','application/json']);}}]);return SCIMApi;}();var ScriptsApi=/*#__PURE__*/function(){/**
|
|
13584
13757
|
* Scripts service.
|
|
13585
13758
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
13586
|
-
* @version
|
|
13759
|
+
* @version 184.0.0
|
|
13587
13760
|
*/ /**
|
|
13588
13761
|
* Constructs a new ScriptsApi.
|
|
13589
13762
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -13719,7 +13892,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
13719
13892
|
*/},{key:"postScriptsPublished",value:function postScriptsPublished(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/scripts/published','POST',{},{'scriptDataVersion':opts['scriptDataVersion']},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return ScriptsApi;}();var SearchApi=/*#__PURE__*/function(){/**
|
|
13720
13893
|
* Search service.
|
|
13721
13894
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
13722
|
-
* @version
|
|
13895
|
+
* @version 184.0.0
|
|
13723
13896
|
*/ /**
|
|
13724
13897
|
* Constructs a new SearchApi.
|
|
13725
13898
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -13879,7 +14052,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13879
14052
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postVoicemailSearch';}return this.apiClient.callApi('/api/v2/voicemail/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return SearchApi;}();var SettingsApi=/*#__PURE__*/function(){/**
|
|
13880
14053
|
* Settings service.
|
|
13881
14054
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
13882
|
-
* @version
|
|
14055
|
+
* @version 184.0.0
|
|
13883
14056
|
*/ /**
|
|
13884
14057
|
* Constructs a new SettingsApi.
|
|
13885
14058
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -13897,7 +14070,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13897
14070
|
*/},{key:"patchEmailsSettings",value:function patchEmailsSettings(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/emails/settings','PATCH',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return SettingsApi;}();var SpeechTextAnalyticsApi=/*#__PURE__*/function(){/**
|
|
13898
14071
|
* SpeechTextAnalytics service.
|
|
13899
14072
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
13900
|
-
* @version
|
|
14073
|
+
* @version 184.0.0
|
|
13901
14074
|
*/ /**
|
|
13902
14075
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
13903
14076
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -14140,7 +14313,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
14140
14313
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putSpeechandtextanalyticsTopic';}return this.apiClient.callApi('/api/v2/speechandtextanalytics/topics/{topicId}','PUT',{'topicId':topicId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return SpeechTextAnalyticsApi;}();var StationsApi=/*#__PURE__*/function(){/**
|
|
14141
14314
|
* Stations service.
|
|
14142
14315
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
14143
|
-
* @version
|
|
14316
|
+
* @version 184.0.0
|
|
14144
14317
|
*/ /**
|
|
14145
14318
|
* Constructs a new StationsApi.
|
|
14146
14319
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -14172,7 +14345,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
14172
14345
|
*/},{key:"getStations",value:function getStations(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/stations','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'name':opts['name'],'userSelectable':opts['userSelectable'],'webRtcUserId':opts['webRtcUserId'],'id':opts['id'],'lineAppearanceId':opts['lineAppearanceId']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return StationsApi;}();var SuggestApi=/*#__PURE__*/function(){/**
|
|
14173
14346
|
* Suggest service.
|
|
14174
14347
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
14175
|
-
* @version
|
|
14348
|
+
* @version 184.0.0
|
|
14176
14349
|
*/ /**
|
|
14177
14350
|
* Constructs a new SuggestApi.
|
|
14178
14351
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -14212,7 +14385,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14212
14385
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postSearchSuggest';}return this.apiClient.callApi('/api/v2/search/suggest','POST',{},{'profile':opts['profile']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return SuggestApi;}();var TaskManagementApi=/*#__PURE__*/function(){/**
|
|
14213
14386
|
* TaskManagement service.
|
|
14214
14387
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
14215
|
-
* @version
|
|
14388
|
+
* @version 184.0.0
|
|
14216
14389
|
*/ /**
|
|
14217
14390
|
* Constructs a new TaskManagementApi.
|
|
14218
14391
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -14554,7 +14727,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
14554
14727
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putTaskmanagementWorkitemsSchema';}return this.apiClient.callApi('/api/v2/taskmanagement/workitems/schemas/{schemaId}','PUT',{'schemaId':schemaId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return TaskManagementApi;}();var TeamsApi=/*#__PURE__*/function(){/**
|
|
14555
14728
|
* Teams service.
|
|
14556
14729
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
14557
|
-
* @version
|
|
14730
|
+
* @version 184.0.0
|
|
14558
14731
|
*/ /**
|
|
14559
14732
|
* Constructs a new TeamsApi.
|
|
14560
14733
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -14633,7 +14806,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14633
14806
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postTeamsSearch';}return this.apiClient.callApi('/api/v2/teams/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return TeamsApi;}();var TelephonyApi=/*#__PURE__*/function(){/**
|
|
14634
14807
|
* Telephony service.
|
|
14635
14808
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
14636
|
-
* @version
|
|
14809
|
+
* @version 184.0.0
|
|
14637
14810
|
*/ /**
|
|
14638
14811
|
* Constructs a new TelephonyApi.
|
|
14639
14812
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -14682,7 +14855,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
14682
14855
|
if(sIPSearchPublicRequest===undefined||sIPSearchPublicRequest===null){throw'Missing the required parameter "sIPSearchPublicRequest" when calling postTelephonySiptracesDownload';}return this.apiClient.callApi('/api/v2/telephony/siptraces/download','POST',{},{},{},{},sIPSearchPublicRequest,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return TelephonyApi;}();var TelephonyProvidersEdgeApi=/*#__PURE__*/function(){/**
|
|
14683
14856
|
* TelephonyProvidersEdge service.
|
|
14684
14857
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
14685
|
-
* @version
|
|
14858
|
+
* @version 184.0.0
|
|
14686
14859
|
*/ /**
|
|
14687
14860
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
14688
14861
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -15501,7 +15674,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
15501
15674
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putTelephonyProvidersEdgesTrunkbasesetting';}return this.apiClient.callApi('/api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId}','PUT',{'trunkBaseSettingsId':trunkBaseSettingsId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return TelephonyProvidersEdgeApi;}();var TextbotsApi=/*#__PURE__*/function(){/**
|
|
15502
15675
|
* Textbots service.
|
|
15503
15676
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
15504
|
-
* @version
|
|
15677
|
+
* @version 184.0.0
|
|
15505
15678
|
*/ /**
|
|
15506
15679
|
* Constructs a new TextbotsApi.
|
|
15507
15680
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -15536,7 +15709,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
15536
15709
|
if(postTextRequest===undefined||postTextRequest===null){throw'Missing the required parameter "postTextRequest" when calling postTextbotsBotsExecute';}return this.apiClient.callApi('/api/v2/textbots/bots/execute','POST',{},{},{},{},postTextRequest,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return TextbotsApi;}();var TokensApi=/*#__PURE__*/function(){/**
|
|
15537
15710
|
* Tokens service.
|
|
15538
15711
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
15539
|
-
* @version
|
|
15712
|
+
* @version 184.0.0
|
|
15540
15713
|
*/ /**
|
|
15541
15714
|
* Constructs a new TokensApi.
|
|
15542
15715
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -15572,7 +15745,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15572
15745
|
*/},{key:"putTokensTimeout",value:function putTokensTimeout(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/tokens/timeout','PUT',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return TokensApi;}();var UploadsApi=/*#__PURE__*/function(){/**
|
|
15573
15746
|
* Uploads service.
|
|
15574
15747
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
15575
|
-
* @version
|
|
15748
|
+
* @version 184.0.0
|
|
15576
15749
|
*/ /**
|
|
15577
15750
|
* Constructs a new UploadsApi.
|
|
15578
15751
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -15614,7 +15787,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15614
15787
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postUploadsWorkforcemanagementHistoricaldataCsv';}return this.apiClient.callApi('/api/v2/uploads/workforcemanagement/historicaldata/csv','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return UploadsApi;}();var UsageApi=/*#__PURE__*/function(){/**
|
|
15615
15788
|
* Usage service.
|
|
15616
15789
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
15617
|
-
* @version
|
|
15790
|
+
* @version 184.0.0
|
|
15618
15791
|
*/ /**
|
|
15619
15792
|
* Constructs a new UsageApi.
|
|
15620
15793
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -15665,7 +15838,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15665
15838
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postUsageSimplesearch';}return this.apiClient.callApi('/api/v2/usage/simplesearch','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return UsageApi;}();var UserRecordingsApi=/*#__PURE__*/function(){/**
|
|
15666
15839
|
* UserRecordings service.
|
|
15667
15840
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
15668
|
-
* @version
|
|
15841
|
+
* @version 184.0.0
|
|
15669
15842
|
*/ /**
|
|
15670
15843
|
* Constructs a new UserRecordingsApi.
|
|
15671
15844
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -15714,7 +15887,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
15714
15887
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserrecording';}return this.apiClient.callApi('/api/v2/userrecordings/{recordingId}','PUT',{'recordingId':recordingId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return UserRecordingsApi;}();var UsersApi=/*#__PURE__*/function(){/**
|
|
15715
15888
|
* Users service.
|
|
15716
15889
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
15717
|
-
* @version
|
|
15890
|
+
* @version 184.0.0
|
|
15718
15891
|
*/ /**
|
|
15719
15892
|
* Constructs a new UsersApi.
|
|
15720
15893
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -16373,7 +16546,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
16373
16546
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putUserVerifier';}return this.apiClient.callApi('/api/v2/users/{userId}/verifiers/{verifierId}','PUT',{'userId':userId,'verifierId':verifierId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return UsersApi;}();var UtilitiesApi=/*#__PURE__*/function(){/**
|
|
16374
16547
|
* Utilities service.
|
|
16375
16548
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
16376
|
-
* @version
|
|
16549
|
+
* @version 184.0.0
|
|
16377
16550
|
*/ /**
|
|
16378
16551
|
* Constructs a new UtilitiesApi.
|
|
16379
16552
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -16400,7 +16573,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16400
16573
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postCertificateDetails';}return this.apiClient.callApi('/api/v2/certificate/details','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return UtilitiesApi;}();var VoicemailApi=/*#__PURE__*/function(){/**
|
|
16401
16574
|
* Voicemail service.
|
|
16402
16575
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
16403
|
-
* @version
|
|
16576
|
+
* @version 184.0.0
|
|
16404
16577
|
*/ /**
|
|
16405
16578
|
* Constructs a new VoicemailApi.
|
|
16406
16579
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -16549,7 +16722,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
16549
16722
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putVoicemailUserpolicy';}return this.apiClient.callApi('/api/v2/voicemail/userpolicies/{userId}','PUT',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return VoicemailApi;}();var WebChatApi=/*#__PURE__*/function(){/**
|
|
16550
16723
|
* WebChat service.
|
|
16551
16724
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
16552
|
-
* @version
|
|
16725
|
+
* @version 184.0.0
|
|
16553
16726
|
*/ /**
|
|
16554
16727
|
* Constructs a new WebChatApi.
|
|
16555
16728
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -16682,7 +16855,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16682
16855
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putWebchatSettings';}return this.apiClient.callApi('/api/v2/webchat/settings','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return WebChatApi;}();var WebDeploymentsApi=/*#__PURE__*/function(){/**
|
|
16683
16856
|
* WebDeployments service.
|
|
16684
16857
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
16685
|
-
* @version
|
|
16858
|
+
* @version 184.0.0
|
|
16686
16859
|
*/ /**
|
|
16687
16860
|
* Constructs a new WebDeploymentsApi.
|
|
16688
16861
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -16803,7 +16976,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
16803
16976
|
if(deployment===undefined||deployment===null){throw'Missing the required parameter "deployment" when calling putWebdeploymentsDeployment';}return this.apiClient.callApi('/api/v2/webdeployments/deployments/{deploymentId}','PUT',{'deploymentId':deploymentId},{},{},{},deployment,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return WebDeploymentsApi;}();var WebMessagingApi=/*#__PURE__*/function(){/**
|
|
16804
16977
|
* WebMessaging service.
|
|
16805
16978
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
16806
|
-
* @version
|
|
16979
|
+
* @version 184.0.0
|
|
16807
16980
|
*/ /**
|
|
16808
16981
|
* Constructs a new WebMessagingApi.
|
|
16809
16982
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -16819,7 +16992,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
16819
16992
|
*/_createClass(WebMessagingApi,[{key:"getWebmessagingMessages",value:function getWebmessagingMessages(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/webmessaging/messages','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return WebMessagingApi;}();var WidgetsApi=/*#__PURE__*/function(){/**
|
|
16820
16993
|
* Widgets service.
|
|
16821
16994
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
16822
|
-
* @version
|
|
16995
|
+
* @version 184.0.0
|
|
16823
16996
|
*/ /**
|
|
16824
16997
|
* Constructs a new WidgetsApi.
|
|
16825
16998
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -16854,7 +17027,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
16854
17027
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putWidgetsDeployment';}return this.apiClient.callApi('/api/v2/widgets/deployments/{deploymentId}','PUT',{'deploymentId':deploymentId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return WidgetsApi;}();var WorkforceManagementApi=/*#__PURE__*/function(){/**
|
|
16855
17028
|
* WorkforceManagement service.
|
|
16856
17029
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
16857
|
-
* @version
|
|
17030
|
+
* @version 184.0.0
|
|
16858
17031
|
*/ /**
|
|
16859
17032
|
* Constructs a new WorkforceManagementApi.
|
|
16860
17033
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -18145,7 +18318,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
18145
18318
|
* </pre>
|
|
18146
18319
|
* </p>
|
|
18147
18320
|
* @module purecloud-platform-client-v2/index
|
|
18148
|
-
* @version
|
|
18321
|
+
* @version 184.0.0
|
|
18149
18322
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
18150
18323
|
* The ApiClient constructor.
|
|
18151
18324
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|
|
@@ -18252,6 +18425,9 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
18252
18425
|
* The LocationsApi service constructor.
|
|
18253
18426
|
* @property {module:purecloud-platform-client-v2/api/LocationsApi}
|
|
18254
18427
|
*/this.LocationsApi=LocationsApi;/**
|
|
18428
|
+
* The LogCaptureApi service constructor.
|
|
18429
|
+
* @property {module:purecloud-platform-client-v2/api/LogCaptureApi}
|
|
18430
|
+
*/this.LogCaptureApi=LogCaptureApi;/**
|
|
18255
18431
|
* The MessagingApi service constructor.
|
|
18256
18432
|
* @property {module:purecloud-platform-client-v2/api/MessagingApi}
|
|
18257
18433
|
*/this.MessagingApi=MessagingApi;/**
|