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
|
@@ -5930,7 +5930,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
5930
5930
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
5931
5931
|
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;}();/**
|
|
5932
5932
|
* @module purecloud-platform-client-v2/ApiClient
|
|
5933
|
-
* @version
|
|
5933
|
+
* @version 184.0.0
|
|
5934
5934
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
5935
5935
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
5936
5936
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -6185,7 +6185,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
6185
6185
|
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(){/**
|
|
6186
6186
|
* Alerting service.
|
|
6187
6187
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
6188
|
-
* @version
|
|
6188
|
+
* @version 184.0.0
|
|
6189
6189
|
*/ /**
|
|
6190
6190
|
* Constructs a new AlertingApi.
|
|
6191
6191
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -6199,13 +6199,15 @@ that.config.logger.log('error',error.response.status,httpMethod,url,request.head
|
|
|
6199
6199
|
*/_createClass(AlertingApi,[{key:"deleteAlertingAlert",value:function deleteAlertingAlert(alertId){// verify the required parameter 'alertId' is set
|
|
6200
6200
|
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']);}/**
|
|
6201
6201
|
* Delete an interaction stats alert
|
|
6202
|
-
*
|
|
6202
|
+
* Apps should migrate to use DELETE /api/v2/alerting/alerts/{alertId}.
|
|
6203
6203
|
* @param {String} alertId Alert ID
|
|
6204
|
+
* @deprecated
|
|
6204
6205
|
*/},{key:"deleteAlertingInteractionstatsAlert",value:function deleteAlertingInteractionstatsAlert(alertId){// verify the required parameter 'alertId' is set
|
|
6205
6206
|
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']);}/**
|
|
6206
|
-
* Delete an interaction stats rule
|
|
6207
|
-
*
|
|
6207
|
+
* Delete an interaction stats rule
|
|
6208
|
+
* Apps should migrate to use DELETE /api/v2/alerting/rules/{ruleId}.
|
|
6208
6209
|
* @param {String} ruleId Rule ID
|
|
6210
|
+
* @deprecated
|
|
6209
6211
|
*/},{key:"deleteAlertingInteractionstatsRule",value:function deleteAlertingInteractionstatsRule(ruleId){// verify the required parameter 'ruleId' is set
|
|
6210
6212
|
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']);}/**
|
|
6211
6213
|
* Delete a rule.
|
|
@@ -6218,35 +6220,41 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
6218
6220
|
* @param {String} alertId Alert ID
|
|
6219
6221
|
*/},{key:"getAlertingAlert",value:function getAlertingAlert(alertId){// verify the required parameter 'alertId' is set
|
|
6220
6222
|
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']);}/**
|
|
6221
|
-
* Gets active alert count for a user
|
|
6222
|
-
*
|
|
6223
|
+
* Gets active alert count for a user
|
|
6224
|
+
* 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.
|
|
6225
|
+
* @deprecated
|
|
6223
6226
|
*/},{key:"getAlertingAlertsActive",value:function getAlertingAlertsActive(){return this.apiClient.callApi('/api/v2/alerting/alerts/active','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6224
6227
|
* Get an interaction stats alert
|
|
6225
|
-
*
|
|
6228
|
+
* Apps should migrate to use GET /api/v2/alerting/alerts/{alertId}.
|
|
6226
6229
|
* @param {String} alertId Alert ID
|
|
6227
6230
|
* @param {Object} opts Optional parameters
|
|
6228
6231
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
6232
|
+
* @deprecated
|
|
6229
6233
|
*/},{key:"getAlertingInteractionstatsAlert",value:function getAlertingInteractionstatsAlert(alertId,opts){opts=opts||{};// verify the required parameter 'alertId' is set
|
|
6230
6234
|
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']);}/**
|
|
6231
|
-
* Get interaction stats alert list
|
|
6232
|
-
*
|
|
6235
|
+
* Get interaction stats alert list
|
|
6236
|
+
* Apps should migrate to use POST /api/v2/alerting/alerts/query.
|
|
6233
6237
|
* @param {Object} opts Optional parameters
|
|
6234
6238
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
6239
|
+
* @deprecated
|
|
6235
6240
|
*/},{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']);}/**
|
|
6236
|
-
* Gets user unread count of interaction stats alerts
|
|
6237
|
-
*
|
|
6241
|
+
* Gets user unread count of interaction stats alerts
|
|
6242
|
+
* 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.
|
|
6243
|
+
* @deprecated
|
|
6238
6244
|
*/},{key:"getAlertingInteractionstatsAlertsUnread",value:function getAlertingInteractionstatsAlertsUnread(){return this.apiClient.callApi('/api/v2/alerting/interactionstats/alerts/unread','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
6239
|
-
* Get an interaction stats rule
|
|
6240
|
-
*
|
|
6245
|
+
* Get an interaction stats rule
|
|
6246
|
+
* Apps should migrate to use GET /api/v2/alerting/rules/{ruleId}.
|
|
6241
6247
|
* @param {String} ruleId Rule ID
|
|
6242
6248
|
* @param {Object} opts Optional parameters
|
|
6243
6249
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
6250
|
+
* @deprecated
|
|
6244
6251
|
*/},{key:"getAlertingInteractionstatsRule",value:function getAlertingInteractionstatsRule(ruleId,opts){opts=opts||{};// verify the required parameter 'ruleId' is set
|
|
6245
6252
|
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']);}/**
|
|
6246
|
-
* Get an interaction stats rule list
|
|
6247
|
-
*
|
|
6253
|
+
* Get an interaction stats rule list
|
|
6254
|
+
* Apps should migrate to use POST /api/v2/alerting/rules/query.
|
|
6248
6255
|
* @param {Object} opts Optional parameters
|
|
6249
6256
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
6257
|
+
* @deprecated
|
|
6250
6258
|
*/},{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']);}/**
|
|
6251
6259
|
* Get a rule.
|
|
6252
6260
|
*
|
|
@@ -6275,11 +6283,12 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6275
6283
|
* @param {Object} opts Optional parameters
|
|
6276
6284
|
* @param {Object} opts.body
|
|
6277
6285
|
*/},{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']);}/**
|
|
6278
|
-
* Create an interaction stats rule
|
|
6279
|
-
*
|
|
6286
|
+
* Create an interaction stats rule
|
|
6287
|
+
* Apps should migrate to use POST /api/v2/alerting/rules.
|
|
6280
6288
|
* @param {Object} body AlertingRule
|
|
6281
6289
|
* @param {Object} opts Optional parameters
|
|
6282
6290
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
6291
|
+
* @deprecated
|
|
6283
6292
|
*/},{key:"postAlertingInteractionstatsRules",value:function postAlertingInteractionstatsRules(body,opts){opts=opts||{};// verify the required parameter 'body' is set
|
|
6284
6293
|
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']);}/**
|
|
6285
6294
|
* Create a Rule.
|
|
@@ -6305,20 +6314,22 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6305
6314
|
*/},{key:"putAlertingAlert",value:function putAlertingAlert(alertId,opts){opts=opts||{};// verify the required parameter 'alertId' is set
|
|
6306
6315
|
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']);}/**
|
|
6307
6316
|
* Update an interaction stats alert read status
|
|
6308
|
-
*
|
|
6317
|
+
* Apps should migrate to use PUT /api/v2/alerting/alerts/{alertId}.
|
|
6309
6318
|
* @param {String} alertId Alert ID
|
|
6310
6319
|
* @param {Object} body InteractionStatsAlert
|
|
6311
6320
|
* @param {Object} opts Optional parameters
|
|
6312
6321
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
6322
|
+
* @deprecated
|
|
6313
6323
|
*/},{key:"putAlertingInteractionstatsAlert",value:function putAlertingInteractionstatsAlert(alertId,body,opts){opts=opts||{};// verify the required parameter 'alertId' is set
|
|
6314
6324
|
if(alertId===undefined||alertId===null){throw'Missing the required parameter "alertId" when calling putAlertingInteractionstatsAlert';}// verify the required parameter 'body' is set
|
|
6315
6325
|
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']);}/**
|
|
6316
6326
|
* Update an interaction stats rule
|
|
6317
|
-
*
|
|
6327
|
+
* Apps should migrate to use PUT /api/v2/alerting/rules/{ruleId}.
|
|
6318
6328
|
* @param {String} ruleId Rule ID
|
|
6319
6329
|
* @param {Object} body AlertingRule
|
|
6320
6330
|
* @param {Object} opts Optional parameters
|
|
6321
6331
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
6332
|
+
* @deprecated
|
|
6322
6333
|
*/},{key:"putAlertingInteractionstatsRule",value:function putAlertingInteractionstatsRule(ruleId,body,opts){opts=opts||{};// verify the required parameter 'ruleId' is set
|
|
6323
6334
|
if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "ruleId" when calling putAlertingInteractionstatsRule';}// verify the required parameter 'body' is set
|
|
6324
6335
|
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']);}/**
|
|
@@ -6331,7 +6342,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
6331
6342
|
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(){/**
|
|
6332
6343
|
* Analytics service.
|
|
6333
6344
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
6334
|
-
* @version
|
|
6345
|
+
* @version 184.0.0
|
|
6335
6346
|
*/ /**
|
|
6336
6347
|
* Constructs a new AnalyticsApi.
|
|
6337
6348
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -6369,7 +6380,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
6369
6380
|
*/},{key:"getAnalyticsActionsAggregatesJobResults",value:function getAnalyticsActionsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
6370
6381
|
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']);}/**
|
|
6371
6382
|
* Get Reporting Turns.
|
|
6372
|
-
* 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
|
|
6383
|
+
* 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.
|
|
6373
6384
|
* @param {String} botFlowId ID of the bot flow.
|
|
6374
6385
|
* @param {Object} opts Optional parameters
|
|
6375
6386
|
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
@@ -6381,6 +6392,17 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
6381
6392
|
* @param {Object} opts.askActionResults Optional case-insensitive comma separated list of ask action results to filter the reporting turns.
|
|
6382
6393
|
*/},{key:"getAnalyticsBotflowReportingturns",value:function getAnalyticsBotflowReportingturns(botFlowId,opts){opts=opts||{};// verify the required parameter 'botFlowId' is set
|
|
6383
6394
|
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']);}/**
|
|
6395
|
+
* Get Bot Flow Sessions.
|
|
6396
|
+
* 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.
|
|
6397
|
+
* @param {String} botFlowId ID of the bot flow.
|
|
6398
|
+
* @param {Object} opts Optional parameters
|
|
6399
|
+
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
6400
|
+
* @param {String} opts.pageSize Max number of entities to return. Maximum of 250 (default to 50)
|
|
6401
|
+
* @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
|
|
6402
|
+
* @param {Object} opts.botResultCategories Optional case-insensitive comma separated list of Bot Result Categories to filter sessions by.
|
|
6403
|
+
* @param {String} opts.endLanguage Optional case-insensitive language code to filter sessions by the language the sessions ended in.
|
|
6404
|
+
*/},{key:"getAnalyticsBotflowSessions",value:function getAnalyticsBotflowSessions(botFlowId,opts){opts=opts||{};// verify the required parameter 'botFlowId' is set
|
|
6405
|
+
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']);}/**
|
|
6384
6406
|
* Get status for async query for bot aggregates
|
|
6385
6407
|
*
|
|
6386
6408
|
* @param {String} jobId jobId
|
|
@@ -6452,6 +6474,20 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
6452
6474
|
* getAnalyticsEvaluationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6453
6475
|
*/},{key:"getAnalyticsEvaluationsAggregatesJobResults",value:function getAnalyticsEvaluationsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
6454
6476
|
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']);}/**
|
|
6477
|
+
* Get status for async query for flow execution aggregates
|
|
6478
|
+
*
|
|
6479
|
+
* @param {String} jobId jobId
|
|
6480
|
+
* getAnalyticsFlowexecutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6481
|
+
*/},{key:"getAnalyticsFlowexecutionsAggregatesJob",value:function getAnalyticsFlowexecutionsAggregatesJob(jobId){// verify the required parameter 'jobId' is set
|
|
6482
|
+
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']);}/**
|
|
6483
|
+
* Fetch a page of results for an async aggregates query
|
|
6484
|
+
*
|
|
6485
|
+
* @param {String} jobId jobId
|
|
6486
|
+
* @param {Object} opts Optional parameters
|
|
6487
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
6488
|
+
* getAnalyticsFlowexecutionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6489
|
+
*/},{key:"getAnalyticsFlowexecutionsAggregatesJobResults",value:function getAnalyticsFlowexecutionsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
6490
|
+
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']);}/**
|
|
6455
6491
|
* Get status for async query for Flow aggregates
|
|
6456
6492
|
*
|
|
6457
6493
|
* @param {String} jobId jobId
|
|
@@ -6723,6 +6759,18 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6723
6759
|
* @param {Object} body query
|
|
6724
6760
|
*/},{key:"postAnalyticsEvaluationsAggregatesQuery",value:function postAnalyticsEvaluationsAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
6725
6761
|
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']);}/**
|
|
6762
|
+
* Query for flow execution aggregates asynchronously
|
|
6763
|
+
*
|
|
6764
|
+
* @param {Object} body query
|
|
6765
|
+
* postAnalyticsFlowexecutionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6766
|
+
*/},{key:"postAnalyticsFlowexecutionsAggregatesJobs",value:function postAnalyticsFlowexecutionsAggregatesJobs(body){// verify the required parameter 'body' is set
|
|
6767
|
+
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']);}/**
|
|
6768
|
+
* Query for flow execution aggregates
|
|
6769
|
+
*
|
|
6770
|
+
* @param {Object} body query
|
|
6771
|
+
* postAnalyticsFlowexecutionsAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6772
|
+
*/},{key:"postAnalyticsFlowexecutionsAggregatesQuery",value:function postAnalyticsFlowexecutionsAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
6773
|
+
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']);}/**
|
|
6726
6774
|
* Query for flow activity observations
|
|
6727
6775
|
*
|
|
6728
6776
|
* @param {Object} body query
|
|
@@ -6782,13 +6830,15 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6782
6830
|
*/},{key:"postAnalyticsReportingExports",value:function postAnalyticsReportingExports(body){// verify the required parameter 'body' is set
|
|
6783
6831
|
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']);}/**
|
|
6784
6832
|
* Place a scheduled report immediately into the reporting queue
|
|
6785
|
-
*
|
|
6833
|
+
* This route is deprecated, please use POST:api/v2/analytics/reporting/exports/{exportId}/execute instead
|
|
6786
6834
|
* @param {String} scheduleId Schedule ID
|
|
6835
|
+
* @deprecated
|
|
6787
6836
|
*/},{key:"postAnalyticsReportingScheduleRunreport",value:function postAnalyticsReportingScheduleRunreport(scheduleId){// verify the required parameter 'scheduleId' is set
|
|
6788
6837
|
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']);}/**
|
|
6789
6838
|
* Create a scheduled report job
|
|
6790
|
-
*
|
|
6839
|
+
* This route is deprecated, please use POST:api/v2/analytics/reporting/exports instead
|
|
6791
6840
|
* @param {Object} body ReportSchedule
|
|
6841
|
+
* @deprecated
|
|
6792
6842
|
*/},{key:"postAnalyticsReportingSchedules",value:function postAnalyticsReportingSchedules(body){// verify the required parameter 'body' is set
|
|
6793
6843
|
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']);}/**
|
|
6794
6844
|
* Query for resolution aggregates asynchronously
|
|
@@ -6890,15 +6940,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6890
6940
|
*/},{key:"putAnalyticsDataretentionSettings",value:function putAnalyticsDataretentionSettings(body){// verify the required parameter 'body' is set
|
|
6891
6941
|
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']);}/**
|
|
6892
6942
|
* Update a scheduled report job.
|
|
6893
|
-
*
|
|
6943
|
+
* This route is deprecated, please use PATCH:api/v2/analytics/reporting/exports/{exportId}/schedule instead
|
|
6894
6944
|
* @param {String} scheduleId Schedule ID
|
|
6895
6945
|
* @param {Object} body ReportSchedule
|
|
6946
|
+
* @deprecated
|
|
6896
6947
|
*/},{key:"putAnalyticsReportingSchedule",value:function putAnalyticsReportingSchedule(scheduleId,body){// verify the required parameter 'scheduleId' is set
|
|
6897
6948
|
if(scheduleId===undefined||scheduleId===null){throw'Missing the required parameter "scheduleId" when calling putAnalyticsReportingSchedule';}// verify the required parameter 'body' is set
|
|
6898
6949
|
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(){/**
|
|
6899
6950
|
* Architect service.
|
|
6900
6951
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6901
|
-
* @version
|
|
6952
|
+
* @version 184.0.0
|
|
6902
6953
|
*/ /**
|
|
6903
6954
|
* Constructs a new ArchitectApi.
|
|
6904
6955
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -7930,7 +7981,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
7930
7981
|
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(){/**
|
|
7931
7982
|
* Audit service.
|
|
7932
7983
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
7933
|
-
* @version
|
|
7984
|
+
* @version 184.0.0
|
|
7934
7985
|
*/ /**
|
|
7935
7986
|
* Constructs a new AuditApi.
|
|
7936
7987
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -7972,7 +8023,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7972
8023
|
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(){/**
|
|
7973
8024
|
* Authorization service.
|
|
7974
8025
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
7975
|
-
* @version
|
|
8026
|
+
* @version 184.0.0
|
|
7976
8027
|
*/ /**
|
|
7977
8028
|
* Constructs a new AuthorizationApi.
|
|
7978
8029
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -8168,10 +8219,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8168
8219
|
* Recreate a previously deleted division.
|
|
8169
8220
|
*
|
|
8170
8221
|
* @param {String} divisionId Division ID
|
|
8171
|
-
* @param {Object}
|
|
8172
|
-
|
|
8173
|
-
|
|
8174
|
-
if(
|
|
8222
|
+
* @param {Object} opts Optional parameters
|
|
8223
|
+
* @param {Object} opts.body Recreated division data
|
|
8224
|
+
*/},{key:"postAuthorizationDivisionRestore",value:function postAuthorizationDivisionRestore(divisionId,opts){opts=opts||{};// verify the required parameter 'divisionId' is set
|
|
8225
|
+
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']);}/**
|
|
8175
8226
|
* Create a division.
|
|
8176
8227
|
*
|
|
8177
8228
|
* @param {Object} body Division
|
|
@@ -8283,7 +8334,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
8283
8334
|
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(){/**
|
|
8284
8335
|
* Billing service.
|
|
8285
8336
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
8286
|
-
* @version
|
|
8337
|
+
* @version 184.0.0
|
|
8287
8338
|
*/ /**
|
|
8288
8339
|
* Constructs a new BillingApi.
|
|
8289
8340
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -8307,7 +8358,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
8307
8358
|
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(){/**
|
|
8308
8359
|
* CarrierServices service.
|
|
8309
8360
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
8310
|
-
* @version
|
|
8361
|
+
* @version 184.0.0
|
|
8311
8362
|
*/ /**
|
|
8312
8363
|
* Constructs a new CarrierServicesApi.
|
|
8313
8364
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -8327,7 +8378,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
8327
8378
|
*/},{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(){/**
|
|
8328
8379
|
* Chat service.
|
|
8329
8380
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
8330
|
-
* @version
|
|
8381
|
+
* @version 184.0.0
|
|
8331
8382
|
*/ /**
|
|
8332
8383
|
* Constructs a new ChatApi.
|
|
8333
8384
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -8524,7 +8575,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8524
8575
|
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(){/**
|
|
8525
8576
|
* Coaching service.
|
|
8526
8577
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
8527
|
-
* @version
|
|
8578
|
+
* @version 184.0.0
|
|
8528
8579
|
*/ /**
|
|
8529
8580
|
* Constructs a new CoachingApi.
|
|
8530
8581
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -8677,7 +8728,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8677
8728
|
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(){/**
|
|
8678
8729
|
* ContentManagement service.
|
|
8679
8730
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8680
|
-
* @version
|
|
8731
|
+
* @version 184.0.0
|
|
8681
8732
|
*/ /**
|
|
8682
8733
|
* Constructs a new ContentManagementApi.
|
|
8683
8734
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -8979,7 +9030,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
8979
9030
|
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(){/**
|
|
8980
9031
|
* Conversations service.
|
|
8981
9032
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
8982
|
-
* @version
|
|
9033
|
+
* @version 184.0.0
|
|
8983
9034
|
*/ /**
|
|
8984
9035
|
* Constructs a new ConversationsApi.
|
|
8985
9036
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -10703,7 +10754,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
10703
10754
|
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(){/**
|
|
10704
10755
|
* DataExtensions service.
|
|
10705
10756
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
10706
|
-
* @version
|
|
10757
|
+
* @version 184.0.0
|
|
10707
10758
|
*/ /**
|
|
10708
10759
|
* Constructs a new DataExtensionsApi.
|
|
10709
10760
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -10724,7 +10775,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
10724
10775
|
*/},{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(){/**
|
|
10725
10776
|
* Downloads service.
|
|
10726
10777
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
10727
|
-
* @version
|
|
10778
|
+
* @version 184.0.0
|
|
10728
10779
|
*/ /**
|
|
10729
10780
|
* Constructs a new DownloadsApi.
|
|
10730
10781
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -10743,7 +10794,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
10743
10794
|
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(){/**
|
|
10744
10795
|
* Emails service.
|
|
10745
10796
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
10746
|
-
* @version
|
|
10797
|
+
* @version 184.0.0
|
|
10747
10798
|
*/ /**
|
|
10748
10799
|
* Constructs a new EmailsApi.
|
|
10749
10800
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -10761,7 +10812,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
10761
10812
|
*/},{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(){/**
|
|
10762
10813
|
* Events service.
|
|
10763
10814
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
10764
|
-
* @version
|
|
10815
|
+
* @version 184.0.0
|
|
10765
10816
|
*/ /**
|
|
10766
10817
|
* Constructs a new EventsApi.
|
|
10767
10818
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -10786,7 +10837,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10786
10837
|
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(){/**
|
|
10787
10838
|
* ExternalContacts service.
|
|
10788
10839
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
10789
|
-
* @version
|
|
10840
|
+
* @version 184.0.0
|
|
10790
10841
|
*/ /**
|
|
10791
10842
|
* Constructs a new ExternalContactsApi.
|
|
10792
10843
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -11241,7 +11292,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
11241
11292
|
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(){/**
|
|
11242
11293
|
* Fax service.
|
|
11243
11294
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
11244
|
-
* @version
|
|
11295
|
+
* @version 184.0.0
|
|
11245
11296
|
*/ /**
|
|
11246
11297
|
* Constructs a new FaxApi.
|
|
11247
11298
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -11282,7 +11333,7 @@ if(documentId===undefined||documentId===null){throw'Missing the required paramet
|
|
|
11282
11333
|
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(){/**
|
|
11283
11334
|
* Flows service.
|
|
11284
11335
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
11285
|
-
* @version
|
|
11336
|
+
* @version 184.0.0
|
|
11286
11337
|
*/ /**
|
|
11287
11338
|
* Constructs a new FlowsApi.
|
|
11288
11339
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -11331,7 +11382,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11331
11382
|
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(){/**
|
|
11332
11383
|
* Gamification service.
|
|
11333
11384
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
11334
|
-
* @version
|
|
11385
|
+
* @version 184.0.0
|
|
11335
11386
|
*/ /**
|
|
11336
11387
|
* Constructs a new GamificationApi.
|
|
11337
11388
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -11871,7 +11922,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11871
11922
|
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(){/**
|
|
11872
11923
|
* GeneralDataProtectionRegulation service.
|
|
11873
11924
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
11874
|
-
* @version
|
|
11925
|
+
* @version 184.0.0
|
|
11875
11926
|
*/ /**
|
|
11876
11927
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
11877
11928
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -11906,7 +11957,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
11906
11957
|
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(){/**
|
|
11907
11958
|
* Geolocation service.
|
|
11908
11959
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
11909
|
-
* @version
|
|
11960
|
+
* @version 184.0.0
|
|
11910
11961
|
*/ /**
|
|
11911
11962
|
* Constructs a new GeolocationApi.
|
|
11912
11963
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -11940,7 +11991,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
11940
11991
|
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(){/**
|
|
11941
11992
|
* Greetings service.
|
|
11942
11993
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
11943
|
-
* @version
|
|
11994
|
+
* @version 184.0.0
|
|
11944
11995
|
*/ /**
|
|
11945
11996
|
* Constructs a new GreetingsApi.
|
|
11946
11997
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -12047,7 +12098,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
12047
12098
|
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(){/**
|
|
12048
12099
|
* Groups service.
|
|
12049
12100
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
12050
|
-
* @version
|
|
12101
|
+
* @version 184.0.0
|
|
12051
12102
|
*/ /**
|
|
12052
12103
|
* Constructs a new GroupsApi.
|
|
12053
12104
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -12180,7 +12231,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
12180
12231
|
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(){/**
|
|
12181
12232
|
* IdentityProvider service.
|
|
12182
12233
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
12183
|
-
* @version
|
|
12234
|
+
* @version 184.0.0
|
|
12184
12235
|
*/ /**
|
|
12185
12236
|
* Constructs a new IdentityProviderApi.
|
|
12186
12237
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -12314,7 +12365,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12314
12365
|
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(){/**
|
|
12315
12366
|
* InfrastructureAsCode service.
|
|
12316
12367
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
12317
|
-
* @version
|
|
12368
|
+
* @version 184.0.0
|
|
12318
12369
|
*/ /**
|
|
12319
12370
|
* Constructs a new InfrastructureAsCodeApi.
|
|
12320
12371
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -12368,7 +12419,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
12368
12419
|
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(){/**
|
|
12369
12420
|
* Integrations service.
|
|
12370
12421
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
12371
|
-
* @version
|
|
12422
|
+
* @version 184.0.0
|
|
12372
12423
|
*/ /**
|
|
12373
12424
|
* Constructs a new IntegrationsApi.
|
|
12374
12425
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -12802,7 +12853,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12802
12853
|
*/},{key:"postIntegrationsActionTest",value:function postIntegrationsActionTest(actionId,body){// verify the required parameter 'actionId' is set
|
|
12803
12854
|
if(actionId===undefined||actionId===null){throw'Missing the required parameter "actionId" when calling postIntegrationsActionTest';}// verify the required parameter 'body' is set
|
|
12804
12855
|
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']);}/**
|
|
12805
|
-
* Create a new Action
|
|
12856
|
+
* 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.
|
|
12806
12857
|
*
|
|
12807
12858
|
* @param {Object} body Input used to create Action.
|
|
12808
12859
|
*/},{key:"postIntegrationsActions",value:function postIntegrationsActions(body){// verify the required parameter 'body' is set
|
|
@@ -12889,7 +12940,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
12889
12940
|
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(){/**
|
|
12890
12941
|
* Journey service.
|
|
12891
12942
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
12892
|
-
* @version
|
|
12943
|
+
* @version 184.0.0
|
|
12893
12944
|
*/ /**
|
|
12894
12945
|
* Constructs a new JourneyApi.
|
|
12895
12946
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -13005,16 +13056,15 @@ if(actionTemplateId===undefined||actionTemplateId===null){throw'Missing the requ
|
|
|
13005
13056
|
*
|
|
13006
13057
|
* @param {String} deploymentId The ID of the deployment sending the ping.
|
|
13007
13058
|
* @param {String} customerCookieId ID of the customer associated with the ping.
|
|
13008
|
-
* @param {String} sessionId UUID of the customer session. Use the same Session Id for all pings, AppEvents and ActionEvents in the session
|
|
13009
13059
|
* @param {Object} opts Optional parameters
|
|
13010
13060
|
* @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.
|
|
13011
13061
|
* @param {String} opts.dt Document Title. A human readable name for the page or screen
|
|
13012
13062
|
* @param {String} opts.appNamespace Namespace of the application (e.g. com.genesys.bancodinero). Used for domain filtering in application sessions
|
|
13063
|
+
* @param {String} opts.sessionId UUID of the customer session. Use the same Session Id for all pings, AppEvents and ActionEvents in the session
|
|
13013
13064
|
* @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.
|
|
13014
|
-
*/},{key:"getJourneyDeploymentCustomerPing",value:function getJourneyDeploymentCustomerPing(deploymentId,customerCookieId,
|
|
13065
|
+
*/},{key:"getJourneyDeploymentCustomerPing",value:function getJourneyDeploymentCustomerPing(deploymentId,customerCookieId,opts){opts=opts||{};// verify the required parameter 'deploymentId' is set
|
|
13015
13066
|
if(deploymentId===undefined||deploymentId===null){throw'Missing the required parameter "deploymentId" when calling getJourneyDeploymentCustomerPing';}// verify the required parameter 'customerCookieId' is set
|
|
13016
|
-
if(customerCookieId===undefined||customerCookieId===null){throw'Missing the required parameter "customerCookieId" when calling getJourneyDeploymentCustomerPing';}
|
|
13017
|
-
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']);}/**
|
|
13067
|
+
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']);}/**
|
|
13018
13068
|
* Retrieve a single outcome.
|
|
13019
13069
|
*
|
|
13020
13070
|
* @param {String} outcomeId ID of the outcome.
|
|
@@ -13194,7 +13244,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
13194
13244
|
*/},{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(){/**
|
|
13195
13245
|
* Knowledge service.
|
|
13196
13246
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
13197
|
-
* @version
|
|
13247
|
+
* @version 184.0.0
|
|
13198
13248
|
*/ /**
|
|
13199
13249
|
* Constructs a new KnowledgeApi.
|
|
13200
13250
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -13991,7 +14041,7 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
13991
14041
|
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(){/**
|
|
13992
14042
|
* LanguageUnderstanding service.
|
|
13993
14043
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
13994
|
-
* @version
|
|
14044
|
+
* @version 184.0.0
|
|
13995
14045
|
*/ /**
|
|
13996
14046
|
* Constructs a new LanguageUnderstandingApi.
|
|
13997
14047
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -14247,7 +14297,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
14247
14297
|
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(){/**
|
|
14248
14298
|
* Languages service.
|
|
14249
14299
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
14250
|
-
* @version
|
|
14300
|
+
* @version 184.0.0
|
|
14251
14301
|
*/ /**
|
|
14252
14302
|
* Constructs a new LanguagesApi.
|
|
14253
14303
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -14302,7 +14352,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
14302
14352
|
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(){/**
|
|
14303
14353
|
* Learning service.
|
|
14304
14354
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
14305
|
-
* @version
|
|
14355
|
+
* @version 184.0.0
|
|
14306
14356
|
*/ /**
|
|
14307
14357
|
* Constructs a new LearningApi.
|
|
14308
14358
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -14405,7 +14455,8 @@ if(versionId===undefined||versionId===null){throw'Missing the required parameter
|
|
|
14405
14455
|
* @param {Array.<String>} opts.expand Fields to expand in response(case insensitive)
|
|
14406
14456
|
* @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)
|
|
14407
14457
|
* @param {Array.<String>} opts.statuses Specifies the module statuses to filter by
|
|
14408
|
-
|
|
14458
|
+
* @param {Array.<String>} opts.externalIds Specifies the module external IDs to filter by. Only one ID is allowed
|
|
14459
|
+
*/},{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']);}/**
|
|
14409
14460
|
* Get all learning modules of an organization including assignments for a specific user
|
|
14410
14461
|
*
|
|
14411
14462
|
* @param {Array.<String>} userIds The IDs of the users to include
|
|
@@ -14437,6 +14488,16 @@ if(assignmentId===undefined||assignmentId===null){throw'Missing the required par
|
|
|
14437
14488
|
* @param {Object} opts.body The Learning assignment reschedule model
|
|
14438
14489
|
*/},{key:"patchLearningAssignmentReschedule",value:function patchLearningAssignmentReschedule(assignmentId,opts){opts=opts||{};// verify the required parameter 'assignmentId' is set
|
|
14439
14490
|
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']);}/**
|
|
14491
|
+
* Update an external assignment for a specific user
|
|
14492
|
+
*
|
|
14493
|
+
* @param {String} moduleId Key identifier for the module
|
|
14494
|
+
* @param {String} userId Key identifier for the user
|
|
14495
|
+
* @param {Object} body The learning request for updating the assignment
|
|
14496
|
+
* patchLearningModuleUserAssignments is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14497
|
+
*/},{key:"patchLearningModuleUserAssignments",value:function patchLearningModuleUserAssignments(moduleId,userId,body){// verify the required parameter 'moduleId' is set
|
|
14498
|
+
if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "moduleId" when calling patchLearningModuleUserAssignments';}// verify the required parameter 'userId' is set
|
|
14499
|
+
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling patchLearningModuleUserAssignments';}// verify the required parameter 'body' is set
|
|
14500
|
+
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']);}/**
|
|
14440
14501
|
* Score learning assessment for preview
|
|
14441
14502
|
*
|
|
14442
14503
|
* @param {Object} body Assessment form and answers to score
|
|
@@ -14521,7 +14582,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
14521
14582
|
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(){/**
|
|
14522
14583
|
* License service.
|
|
14523
14584
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
14524
|
-
* @version
|
|
14585
|
+
* @version 184.0.0
|
|
14525
14586
|
*/ /**
|
|
14526
14587
|
* Constructs a new LicenseApi.
|
|
14527
14588
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -14575,7 +14636,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
14575
14636
|
*/},{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(){/**
|
|
14576
14637
|
* Locations service.
|
|
14577
14638
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
14578
|
-
* @version
|
|
14639
|
+
* @version 184.0.0
|
|
14579
14640
|
*/ /**
|
|
14580
14641
|
* Constructs a new LocationsApi.
|
|
14581
14642
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -14631,10 +14692,30 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14631
14692
|
*
|
|
14632
14693
|
* @param {Object} body Search request options
|
|
14633
14694
|
*/},{key:"postLocationsSearch",value:function postLocationsSearch(body){// verify the required parameter 'body' is set
|
|
14634
|
-
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
|
|
14695
|
+
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(){/**
|
|
14696
|
+
* LogCapture service.
|
|
14697
|
+
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
14698
|
+
* @version 184.0.0
|
|
14699
|
+
*/ /**
|
|
14700
|
+
* Constructs a new LogCaptureApi.
|
|
14701
|
+
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
14702
|
+
* @class
|
|
14703
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
14704
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
14705
|
+
*/function LogCaptureApi(apiClient){_classCallCheck(this,LogCaptureApi);this.apiClient=apiClient||ApiClient.instance;}/**
|
|
14706
|
+
* Gets status of async download execution
|
|
14707
|
+
*
|
|
14708
|
+
* @param {String} jobId Job ID
|
|
14709
|
+
*/_createClass(LogCaptureApi,[{key:"getDiagnosticsLogcaptureBrowserEntriesDownloadJob",value:function getDiagnosticsLogcaptureBrowserEntriesDownloadJob(jobId){// verify the required parameter 'jobId' is set
|
|
14710
|
+
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']);}/**
|
|
14711
|
+
* Creates an async download execution
|
|
14712
|
+
*
|
|
14713
|
+
* @param {Object} opts Optional parameters
|
|
14714
|
+
* @param {Object} opts.body
|
|
14715
|
+
*/},{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(){/**
|
|
14635
14716
|
* Messaging service.
|
|
14636
14717
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
14637
|
-
* @version
|
|
14718
|
+
* @version 184.0.0
|
|
14638
14719
|
*/ /**
|
|
14639
14720
|
* Constructs a new MessagingApi.
|
|
14640
14721
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -14724,7 +14805,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14724
14805
|
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(){/**
|
|
14725
14806
|
* MobileDevices service.
|
|
14726
14807
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
14727
|
-
* @version
|
|
14808
|
+
* @version 184.0.0
|
|
14728
14809
|
*/ /**
|
|
14729
14810
|
* Constructs a new MobileDevicesApi.
|
|
14730
14811
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -14763,7 +14844,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14763
14844
|
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(){/**
|
|
14764
14845
|
* Notifications service.
|
|
14765
14846
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
14766
|
-
* @version
|
|
14847
|
+
* @version 184.0.0
|
|
14767
14848
|
*/ /**
|
|
14768
14849
|
* Constructs a new NotificationsApi.
|
|
14769
14850
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -14820,7 +14901,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
14820
14901
|
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(){/**
|
|
14821
14902
|
* OAuth service.
|
|
14822
14903
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
14823
|
-
* @version
|
|
14904
|
+
* @version 184.0.0
|
|
14824
14905
|
*/ /**
|
|
14825
14906
|
* Constructs a new OAuthApi.
|
|
14826
14907
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -14905,7 +14986,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
14905
14986
|
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(){/**
|
|
14906
14987
|
* Objects service.
|
|
14907
14988
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
14908
|
-
* @version
|
|
14989
|
+
* @version 184.0.0
|
|
14909
14990
|
*/ /**
|
|
14910
14991
|
* Constructs a new ObjectsApi.
|
|
14911
14992
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -14958,10 +15039,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14958
15039
|
* Recreate a previously deleted division.
|
|
14959
15040
|
*
|
|
14960
15041
|
* @param {String} divisionId Division ID
|
|
14961
|
-
* @param {Object}
|
|
14962
|
-
|
|
14963
|
-
|
|
14964
|
-
if(
|
|
15042
|
+
* @param {Object} opts Optional parameters
|
|
15043
|
+
* @param {Object} opts.body Recreated division data
|
|
15044
|
+
*/},{key:"postAuthorizationDivisionRestore",value:function postAuthorizationDivisionRestore(divisionId,opts){opts=opts||{};// verify the required parameter 'divisionId' is set
|
|
15045
|
+
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']);}/**
|
|
14965
15046
|
* Create a division.
|
|
14966
15047
|
*
|
|
14967
15048
|
* @param {Object} body Division
|
|
@@ -14976,7 +15057,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
14976
15057
|
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(){/**
|
|
14977
15058
|
* OperationalEvents service.
|
|
14978
15059
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
14979
|
-
* @version
|
|
15060
|
+
* @version 184.0.0
|
|
14980
15061
|
*/ /**
|
|
14981
15062
|
* Constructs a new OperationalEventsApi.
|
|
14982
15063
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -14994,7 +15075,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
14994
15075
|
*/},{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(){/**
|
|
14995
15076
|
* Organization service.
|
|
14996
15077
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
14997
|
-
* @version
|
|
15078
|
+
* @version 184.0.0
|
|
14998
15079
|
*/ /**
|
|
14999
15080
|
* Constructs a new OrganizationApi.
|
|
15000
15081
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -15096,7 +15177,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15096
15177
|
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(){/**
|
|
15097
15178
|
* OrganizationAuthorization service.
|
|
15098
15179
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
15099
|
-
* @version
|
|
15180
|
+
* @version 184.0.0
|
|
15100
15181
|
*/ /**
|
|
15101
15182
|
* Constructs a new OrganizationAuthorizationApi.
|
|
15102
15183
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -15419,7 +15500,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
15419
15500
|
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(){/**
|
|
15420
15501
|
* Outbound service.
|
|
15421
15502
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
15422
|
-
* @version
|
|
15503
|
+
* @version 184.0.0
|
|
15423
15504
|
*/ /**
|
|
15424
15505
|
* Constructs a new OutboundApi.
|
|
15425
15506
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -15486,6 +15567,16 @@ if(contactListFilterId===undefined||contactListFilterId===null){throw'Missing th
|
|
|
15486
15567
|
* @param {Array.<String>} id contact list id(s) to delete
|
|
15487
15568
|
*/},{key:"deleteOutboundContactlists",value:function deleteOutboundContactlists(id){// verify the required parameter 'id' is set
|
|
15488
15569
|
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']);}/**
|
|
15570
|
+
* Delete Contact List Template
|
|
15571
|
+
*
|
|
15572
|
+
* @param {String} contactListTemplateId ContactListTemplate ID
|
|
15573
|
+
*/},{key:"deleteOutboundContactlisttemplate",value:function deleteOutboundContactlisttemplate(contactListTemplateId){// verify the required parameter 'contactListTemplateId' is set
|
|
15574
|
+
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']);}/**
|
|
15575
|
+
* Delete multiple contact list templates.
|
|
15576
|
+
*
|
|
15577
|
+
* @param {Array.<String>} id contact list template id(s) to delete
|
|
15578
|
+
*/},{key:"deleteOutboundContactlisttemplates",value:function deleteOutboundContactlisttemplates(id){// verify the required parameter 'id' is set
|
|
15579
|
+
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']);}/**
|
|
15489
15580
|
* Delete an Outbound Digital Rule Set
|
|
15490
15581
|
*
|
|
15491
15582
|
* @param {String} digitalRuleSetId The Digital Rule Set ID
|
|
@@ -15517,6 +15608,16 @@ if(dncListId===undefined||dncListId===null){throw'Missing the required parameter
|
|
|
15517
15608
|
* @param {Boolean} opts.expiredOnly Set to true to only remove DNC entries that are expired (default to false)
|
|
15518
15609
|
*/},{key:"deleteOutboundDnclistPhonenumbers",value:function deleteOutboundDnclistPhonenumbers(dncListId,opts){opts=opts||{};// verify the required parameter 'dncListId' is set
|
|
15519
15610
|
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']);}/**
|
|
15611
|
+
* Delete Import Template
|
|
15612
|
+
*
|
|
15613
|
+
* @param {String} importTemplateId Import Template ID
|
|
15614
|
+
*/},{key:"deleteOutboundImporttemplate",value:function deleteOutboundImporttemplate(importTemplateId){// verify the required parameter 'importTemplateId' is set
|
|
15615
|
+
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']);}/**
|
|
15616
|
+
* Delete multiple import templates.
|
|
15617
|
+
*
|
|
15618
|
+
* @param {Array.<String>} id import template id(s) to delete
|
|
15619
|
+
*/},{key:"deleteOutboundImporttemplates",value:function deleteOutboundImporttemplates(id){// verify the required parameter 'id' is set
|
|
15620
|
+
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']);}/**
|
|
15520
15621
|
* Delete an Outbound Messaging Campaign
|
|
15521
15622
|
*
|
|
15522
15623
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
@@ -15791,6 +15892,22 @@ if(contactListId===undefined||contactListId===null){throw'Missing the required p
|
|
|
15791
15892
|
* @param {String} opts.sortBy Sort by
|
|
15792
15893
|
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
15793
15894
|
*/},{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']);}/**
|
|
15895
|
+
* Get Contact List Template
|
|
15896
|
+
*
|
|
15897
|
+
* @param {String} contactListTemplateId ContactListTemplate ID
|
|
15898
|
+
*/},{key:"getOutboundContactlisttemplate",value:function getOutboundContactlisttemplate(contactListTemplateId){// verify the required parameter 'contactListTemplateId' is set
|
|
15899
|
+
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']);}/**
|
|
15900
|
+
* Query a list of contact list templates
|
|
15901
|
+
*
|
|
15902
|
+
* @param {Object} opts Optional parameters
|
|
15903
|
+
* @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
|
|
15904
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
15905
|
+
* @param {Boolean} opts.allowEmptyResult Whether to return an empty page when there are no results for that page (default to false)
|
|
15906
|
+
* @param {Object} opts.filterType Filter type (default to Prefix)
|
|
15907
|
+
* @param {String} opts.name Name
|
|
15908
|
+
* @param {String} opts.sortBy Sort by
|
|
15909
|
+
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
15910
|
+
*/},{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']);}/**
|
|
15794
15911
|
* Get an Outbound Digital Rule Set
|
|
15795
15912
|
*
|
|
15796
15913
|
* @param {String} digitalRuleSetId The Digital Rule Set ID
|
|
@@ -15879,6 +15996,30 @@ if(eventId===undefined||eventId===null){throw'Missing the required parameter "ev
|
|
|
15879
15996
|
* @param {String} opts.sortBy Sort by
|
|
15880
15997
|
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
15881
15998
|
*/},{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']);}/**
|
|
15999
|
+
* Get Import Template
|
|
16000
|
+
*
|
|
16001
|
+
* @param {String} importTemplateId Import Template ID
|
|
16002
|
+
*/},{key:"getOutboundImporttemplate",value:function getOutboundImporttemplate(importTemplateId){// verify the required parameter 'importTemplateId' is set
|
|
16003
|
+
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']);}/**
|
|
16004
|
+
* Get the import status for an import template.
|
|
16005
|
+
*
|
|
16006
|
+
* @param {String} importTemplateId importTemplateId
|
|
16007
|
+
* @param {Object} opts Optional parameters
|
|
16008
|
+
* @param {String} opts.listNamePrefix listNamePrefix
|
|
16009
|
+
*/},{key:"getOutboundImporttemplateImportstatus",value:function getOutboundImporttemplateImportstatus(importTemplateId,opts){opts=opts||{};// verify the required parameter 'importTemplateId' is set
|
|
16010
|
+
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']);}/**
|
|
16011
|
+
* Query Import Templates
|
|
16012
|
+
*
|
|
16013
|
+
* @param {Object} opts Optional parameters
|
|
16014
|
+
* @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
|
|
16015
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
16016
|
+
* @param {Boolean} opts.allowEmptyResult Whether to return an empty page when there are no results for that page (default to false)
|
|
16017
|
+
* @param {Object} opts.filterType Filter type (default to Prefix)
|
|
16018
|
+
* @param {String} opts.name Name
|
|
16019
|
+
* @param {String} opts.sortBy Sort by
|
|
16020
|
+
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
16021
|
+
* @param {String} opts.contactListTemplateId Contact List Template ID
|
|
16022
|
+
*/},{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']);}/**
|
|
15882
16023
|
* Get an Outbound Messaging Campaign
|
|
15883
16024
|
*
|
|
15884
16025
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
@@ -16117,6 +16258,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16117
16258
|
* @param {Object} body ContactList
|
|
16118
16259
|
*/},{key:"postOutboundContactlists",value:function postOutboundContactlists(body){// verify the required parameter 'body' is set
|
|
16119
16260
|
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']);}/**
|
|
16261
|
+
* Create Contact List Template
|
|
16262
|
+
*
|
|
16263
|
+
* @param {Object} body ContactListTemplate
|
|
16264
|
+
*/},{key:"postOutboundContactlisttemplates",value:function postOutboundContactlisttemplates(body){// verify the required parameter 'body' is set
|
|
16265
|
+
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']);}/**
|
|
16266
|
+
* Add multiple contact list templates
|
|
16267
|
+
*
|
|
16268
|
+
* @param {Array.<Object>} body contact list template(s) to add
|
|
16269
|
+
*/},{key:"postOutboundContactlisttemplatesBulkAdd",value:function postOutboundContactlisttemplatesBulkAdd(body){// verify the required parameter 'body' is set
|
|
16270
|
+
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']);}/**
|
|
16120
16271
|
* Add phone numbers to a Dialer DNC list.
|
|
16121
16272
|
*
|
|
16122
16273
|
* @param {String} conversationId Conversation ID
|
|
@@ -16153,6 +16304,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16153
16304
|
* @param {Object} body DncList
|
|
16154
16305
|
*/},{key:"postOutboundDnclists",value:function postOutboundDnclists(body){// verify the required parameter 'body' is set
|
|
16155
16306
|
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']);}/**
|
|
16307
|
+
* Create Import Template
|
|
16308
|
+
*
|
|
16309
|
+
* @param {Object} body ImportTemplate
|
|
16310
|
+
*/},{key:"postOutboundImporttemplates",value:function postOutboundImporttemplates(body){// verify the required parameter 'body' is set
|
|
16311
|
+
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']);}/**
|
|
16312
|
+
* Add multiple import templates
|
|
16313
|
+
*
|
|
16314
|
+
* @param {Array.<Object>} body import template(s) to add
|
|
16315
|
+
*/},{key:"postOutboundImporttemplatesBulkAdd",value:function postOutboundImporttemplatesBulkAdd(body){// verify the required parameter 'body' is set
|
|
16316
|
+
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']);}/**
|
|
16156
16317
|
* Create a Messaging Campaign
|
|
16157
16318
|
*
|
|
16158
16319
|
* @param {Object} body Messaging Campaign
|
|
@@ -16240,6 +16401,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16240
16401
|
*/},{key:"putOutboundContactlistfilter",value:function putOutboundContactlistfilter(contactListFilterId,body){// verify the required parameter 'contactListFilterId' is set
|
|
16241
16402
|
if(contactListFilterId===undefined||contactListFilterId===null){throw'Missing the required parameter "contactListFilterId" when calling putOutboundContactlistfilter';}// verify the required parameter 'body' is set
|
|
16242
16403
|
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']);}/**
|
|
16404
|
+
* Update a contact list template.
|
|
16405
|
+
*
|
|
16406
|
+
* @param {String} contactListTemplateId ContactListTemplate ID
|
|
16407
|
+
* @param {Object} body ContactListTemplate
|
|
16408
|
+
*/},{key:"putOutboundContactlisttemplate",value:function putOutboundContactlisttemplate(contactListTemplateId,body){// verify the required parameter 'contactListTemplateId' is set
|
|
16409
|
+
if(contactListTemplateId===undefined||contactListTemplateId===null){throw'Missing the required parameter "contactListTemplateId" when calling putOutboundContactlisttemplate';}// verify the required parameter 'body' is set
|
|
16410
|
+
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']);}/**
|
|
16243
16411
|
* Update an Outbound Digital Rule Set
|
|
16244
16412
|
*
|
|
16245
16413
|
* @param {String} digitalRuleSetId The Digital Rule Set ID
|
|
@@ -16254,6 +16422,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16254
16422
|
*/},{key:"putOutboundDnclist",value:function putOutboundDnclist(dncListId,body){// verify the required parameter 'dncListId' is set
|
|
16255
16423
|
if(dncListId===undefined||dncListId===null){throw'Missing the required parameter "dncListId" when calling putOutboundDnclist';}// verify the required parameter 'body' is set
|
|
16256
16424
|
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']);}/**
|
|
16425
|
+
* Update Import Template
|
|
16426
|
+
*
|
|
16427
|
+
* @param {String} importTemplateId Import Template ID
|
|
16428
|
+
* @param {Object} body importTemplate
|
|
16429
|
+
*/},{key:"putOutboundImporttemplate",value:function putOutboundImporttemplate(importTemplateId,body){// verify the required parameter 'importTemplateId' is set
|
|
16430
|
+
if(importTemplateId===undefined||importTemplateId===null){throw'Missing the required parameter "importTemplateId" when calling putOutboundImporttemplate';}// verify the required parameter 'body' is set
|
|
16431
|
+
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']);}/**
|
|
16257
16432
|
* Update an Outbound Messaging Campaign
|
|
16258
16433
|
*
|
|
16259
16434
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
@@ -16310,7 +16485,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16310
16485
|
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(){/**
|
|
16311
16486
|
* Presence service.
|
|
16312
16487
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
16313
|
-
* @version
|
|
16488
|
+
* @version 184.0.0
|
|
16314
16489
|
*/ /**
|
|
16315
16490
|
* Constructs a new PresenceApi.
|
|
16316
16491
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -16321,7 +16496,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16321
16496
|
* Delete a Presence Definition
|
|
16322
16497
|
*
|
|
16323
16498
|
* @param {String} definitionId Presence Definition ID
|
|
16324
|
-
* deletePresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16325
16499
|
*/_createClass(PresenceApi,[{key:"deletePresenceDefinition0",value:function deletePresenceDefinition0(definitionId){// verify the required parameter 'definitionId' is set
|
|
16326
16500
|
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']);}/**
|
|
16327
16501
|
* Delete a Presence Source
|
|
@@ -16339,7 +16513,6 @@ if(presenceId===undefined||presenceId===null){throw'Missing the required paramet
|
|
|
16339
16513
|
* @param {String} definitionId Presence Definition ID
|
|
16340
16514
|
* @param {Object} opts Optional parameters
|
|
16341
16515
|
* @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
16342
|
-
* getPresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16343
16516
|
*/},{key:"getPresenceDefinition0",value:function getPresenceDefinition0(definitionId,opts){opts=opts||{};// verify the required parameter 'definitionId' is set
|
|
16344
16517
|
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']);}/**
|
|
16345
16518
|
* Get a list of Presence Definitions
|
|
@@ -16348,7 +16521,6 @@ if(definitionId===undefined||definitionId===null){throw'Missing the required par
|
|
|
16348
16521
|
* @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
|
|
16349
16522
|
* @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.
|
|
16350
16523
|
* @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
16351
|
-
* getPresenceDefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16352
16524
|
*/},{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']);}/**
|
|
16353
16525
|
* Get the presence settings
|
|
16354
16526
|
*
|
|
@@ -16429,7 +16601,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16429
16601
|
* Create a Presence Definition
|
|
16430
16602
|
*
|
|
16431
16603
|
* @param {Object} body The Presence Definition to create
|
|
16432
|
-
* postPresenceDefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16433
16604
|
*/},{key:"postPresenceDefinitions0",value:function postPresenceDefinitions0(body){// verify the required parameter 'body' is set
|
|
16434
16605
|
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']);}/**
|
|
16435
16606
|
* Create a Presence Source
|
|
@@ -16446,7 +16617,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16446
16617
|
*
|
|
16447
16618
|
* @param {String} definitionId Presence Definition ID
|
|
16448
16619
|
* @param {Object} body The updated Presence Definition
|
|
16449
|
-
* putPresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16450
16620
|
*/},{key:"putPresenceDefinition0",value:function putPresenceDefinition0(definitionId,body){// verify the required parameter 'definitionId' is set
|
|
16451
16621
|
if(definitionId===undefined||definitionId===null){throw'Missing the required parameter "definitionId" when calling putPresenceDefinition0';}// verify the required parameter 'body' is set
|
|
16452
16622
|
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']);}/**
|
|
@@ -16483,7 +16653,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16483
16653
|
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(){/**
|
|
16484
16654
|
* ProcessAutomation service.
|
|
16485
16655
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
16486
|
-
* @version
|
|
16656
|
+
* @version 184.0.0
|
|
16487
16657
|
*/ /**
|
|
16488
16658
|
* Constructs a new ProcessAutomationApi.
|
|
16489
16659
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -16546,7 +16716,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
16546
16716
|
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(){/**
|
|
16547
16717
|
* Quality service.
|
|
16548
16718
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
16549
|
-
* @version
|
|
16719
|
+
* @version 184.0.0
|
|
16550
16720
|
*/ /**
|
|
16551
16721
|
* Constructs a new QualityApi.
|
|
16552
16722
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -16629,8 +16799,9 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
16629
16799
|
* @param {String} opts.evaluatorUserId user id of the evaluator
|
|
16630
16800
|
* @param {String} opts.name name
|
|
16631
16801
|
* @param {String} opts.group group id
|
|
16802
|
+
* @param {String} opts.agentTeamId team id of agents requested
|
|
16632
16803
|
* @param {String} opts.formContextId shared id between form versions
|
|
16633
|
-
*/},{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']);}/**
|
|
16804
|
+
*/},{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']);}/**
|
|
16634
16805
|
* Get a calibration by id. Requires either calibrator id or conversation id
|
|
16635
16806
|
*
|
|
16636
16807
|
* @param {String} calibrationId Calibration ID
|
|
@@ -16693,6 +16864,7 @@ if(transactionId===undefined||transactionId===null){throw'Missing the required p
|
|
|
16693
16864
|
* @param {String} opts.previousPage Previous page token
|
|
16694
16865
|
* @param {String} opts.conversationId conversationId specified
|
|
16695
16866
|
* @param {String} opts.agentUserId user id of the agent
|
|
16867
|
+
* @param {String} opts.agentTeamId team id of the agent
|
|
16696
16868
|
* @param {String} opts.evaluatorUserId evaluator user id
|
|
16697
16869
|
* @param {String} opts.assigneeUserId assignee user id
|
|
16698
16870
|
* @param {String} opts.queueId queue id
|
|
@@ -16705,7 +16877,7 @@ if(transactionId===undefined||transactionId===null){throw'Missing the required p
|
|
|
16705
16877
|
* @param {Boolean} opts.expandAnswerTotalScores get the total scores for evaluations
|
|
16706
16878
|
* @param {Number} opts.maximum the maximum number of results to return
|
|
16707
16879
|
* @param {String} opts.sortOrder NOTE: Does not work when conversationId is supplied.
|
|
16708
|
-
*/},{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']);}/**
|
|
16880
|
+
*/},{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']);}/**
|
|
16709
16881
|
* Get an evaluator activity
|
|
16710
16882
|
*
|
|
16711
16883
|
* @param {Object} opts Optional parameters
|
|
@@ -16720,7 +16892,8 @@ if(transactionId===undefined||transactionId===null){throw'Missing the required p
|
|
|
16720
16892
|
* @param {String} opts.name Evaluator name
|
|
16721
16893
|
* @param {Array.<String>} opts.permission permission strings
|
|
16722
16894
|
* @param {String} opts.group group id
|
|
16723
|
-
|
|
16895
|
+
* @param {String} opts.agentTeamId team id of agents to be considered
|
|
16896
|
+
*/},{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']);}/**
|
|
16724
16897
|
* Get an evaluation form
|
|
16725
16898
|
*
|
|
16726
16899
|
* @param {String} formId Form ID
|
|
@@ -17014,7 +17187,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
17014
17187
|
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(){/**
|
|
17015
17188
|
* Recording service.
|
|
17016
17189
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
17017
|
-
* @version
|
|
17190
|
+
* @version 184.0.0
|
|
17018
17191
|
*/ /**
|
|
17019
17192
|
* Constructs a new RecordingApi.
|
|
17020
17193
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -17421,7 +17594,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17421
17594
|
*/},{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(){/**
|
|
17422
17595
|
* ResponseManagement service.
|
|
17423
17596
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
17424
|
-
* @version
|
|
17597
|
+
* @version 184.0.0
|
|
17425
17598
|
*/ /**
|
|
17426
17599
|
* Constructs a new ResponseManagementApi.
|
|
17427
17600
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -17537,7 +17710,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
17537
17710
|
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(){/**
|
|
17538
17711
|
* Routing service.
|
|
17539
17712
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
17540
|
-
* @version
|
|
17713
|
+
* @version 184.0.0
|
|
17541
17714
|
*/ /**
|
|
17542
17715
|
* Constructs a new RoutingApi.
|
|
17543
17716
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -18443,7 +18616,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
18443
18616
|
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(){/**
|
|
18444
18617
|
* SCIM service.
|
|
18445
18618
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
18446
|
-
* @version
|
|
18619
|
+
* @version 184.0.0
|
|
18447
18620
|
*/ /**
|
|
18448
18621
|
* Constructs a new SCIMApi.
|
|
18449
18622
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -18668,7 +18841,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
18668
18841
|
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(){/**
|
|
18669
18842
|
* Scripts service.
|
|
18670
18843
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
18671
|
-
* @version
|
|
18844
|
+
* @version 184.0.0
|
|
18672
18845
|
*/ /**
|
|
18673
18846
|
* Constructs a new ScriptsApi.
|
|
18674
18847
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -18804,7 +18977,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
18804
18977
|
*/},{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(){/**
|
|
18805
18978
|
* Search service.
|
|
18806
18979
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
18807
|
-
* @version
|
|
18980
|
+
* @version 184.0.0
|
|
18808
18981
|
*/ /**
|
|
18809
18982
|
* Constructs a new SearchApi.
|
|
18810
18983
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -18964,7 +19137,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18964
19137
|
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(){/**
|
|
18965
19138
|
* Settings service.
|
|
18966
19139
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
18967
|
-
* @version
|
|
19140
|
+
* @version 184.0.0
|
|
18968
19141
|
*/ /**
|
|
18969
19142
|
* Constructs a new SettingsApi.
|
|
18970
19143
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -18982,7 +19155,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18982
19155
|
*/},{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(){/**
|
|
18983
19156
|
* SpeechTextAnalytics service.
|
|
18984
19157
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
18985
|
-
* @version
|
|
19158
|
+
* @version 184.0.0
|
|
18986
19159
|
*/ /**
|
|
18987
19160
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
18988
19161
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -19225,7 +19398,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
19225
19398
|
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(){/**
|
|
19226
19399
|
* Stations service.
|
|
19227
19400
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
19228
|
-
* @version
|
|
19401
|
+
* @version 184.0.0
|
|
19229
19402
|
*/ /**
|
|
19230
19403
|
* Constructs a new StationsApi.
|
|
19231
19404
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -19257,7 +19430,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
19257
19430
|
*/},{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(){/**
|
|
19258
19431
|
* Suggest service.
|
|
19259
19432
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
19260
|
-
* @version
|
|
19433
|
+
* @version 184.0.0
|
|
19261
19434
|
*/ /**
|
|
19262
19435
|
* Constructs a new SuggestApi.
|
|
19263
19436
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -19297,7 +19470,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19297
19470
|
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(){/**
|
|
19298
19471
|
* TaskManagement service.
|
|
19299
19472
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
19300
|
-
* @version
|
|
19473
|
+
* @version 184.0.0
|
|
19301
19474
|
*/ /**
|
|
19302
19475
|
* Constructs a new TaskManagementApi.
|
|
19303
19476
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -19639,7 +19812,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
19639
19812
|
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(){/**
|
|
19640
19813
|
* Teams service.
|
|
19641
19814
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
19642
|
-
* @version
|
|
19815
|
+
* @version 184.0.0
|
|
19643
19816
|
*/ /**
|
|
19644
19817
|
* Constructs a new TeamsApi.
|
|
19645
19818
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -19718,7 +19891,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19718
19891
|
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(){/**
|
|
19719
19892
|
* Telephony service.
|
|
19720
19893
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
19721
|
-
* @version
|
|
19894
|
+
* @version 184.0.0
|
|
19722
19895
|
*/ /**
|
|
19723
19896
|
* Constructs a new TelephonyApi.
|
|
19724
19897
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -19767,7 +19940,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
19767
19940
|
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(){/**
|
|
19768
19941
|
* TelephonyProvidersEdge service.
|
|
19769
19942
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
19770
|
-
* @version
|
|
19943
|
+
* @version 184.0.0
|
|
19771
19944
|
*/ /**
|
|
19772
19945
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
19773
19946
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -20586,7 +20759,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
20586
20759
|
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(){/**
|
|
20587
20760
|
* Textbots service.
|
|
20588
20761
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
20589
|
-
* @version
|
|
20762
|
+
* @version 184.0.0
|
|
20590
20763
|
*/ /**
|
|
20591
20764
|
* Constructs a new TextbotsApi.
|
|
20592
20765
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -20621,7 +20794,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
20621
20794
|
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(){/**
|
|
20622
20795
|
* Tokens service.
|
|
20623
20796
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
20624
|
-
* @version
|
|
20797
|
+
* @version 184.0.0
|
|
20625
20798
|
*/ /**
|
|
20626
20799
|
* Constructs a new TokensApi.
|
|
20627
20800
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -20657,7 +20830,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
20657
20830
|
*/},{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(){/**
|
|
20658
20831
|
* Uploads service.
|
|
20659
20832
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
20660
|
-
* @version
|
|
20833
|
+
* @version 184.0.0
|
|
20661
20834
|
*/ /**
|
|
20662
20835
|
* Constructs a new UploadsApi.
|
|
20663
20836
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -20699,7 +20872,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20699
20872
|
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(){/**
|
|
20700
20873
|
* Usage service.
|
|
20701
20874
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
20702
|
-
* @version
|
|
20875
|
+
* @version 184.0.0
|
|
20703
20876
|
*/ /**
|
|
20704
20877
|
* Constructs a new UsageApi.
|
|
20705
20878
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -20750,7 +20923,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20750
20923
|
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(){/**
|
|
20751
20924
|
* UserRecordings service.
|
|
20752
20925
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
20753
|
-
* @version
|
|
20926
|
+
* @version 184.0.0
|
|
20754
20927
|
*/ /**
|
|
20755
20928
|
* Constructs a new UserRecordingsApi.
|
|
20756
20929
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -20799,7 +20972,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
20799
20972
|
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(){/**
|
|
20800
20973
|
* Users service.
|
|
20801
20974
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
20802
|
-
* @version
|
|
20975
|
+
* @version 184.0.0
|
|
20803
20976
|
*/ /**
|
|
20804
20977
|
* Constructs a new UsersApi.
|
|
20805
20978
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -21458,7 +21631,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
21458
21631
|
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(){/**
|
|
21459
21632
|
* Utilities service.
|
|
21460
21633
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
21461
|
-
* @version
|
|
21634
|
+
* @version 184.0.0
|
|
21462
21635
|
*/ /**
|
|
21463
21636
|
* Constructs a new UtilitiesApi.
|
|
21464
21637
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -21485,7 +21658,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21485
21658
|
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(){/**
|
|
21486
21659
|
* Voicemail service.
|
|
21487
21660
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
21488
|
-
* @version
|
|
21661
|
+
* @version 184.0.0
|
|
21489
21662
|
*/ /**
|
|
21490
21663
|
* Constructs a new VoicemailApi.
|
|
21491
21664
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -21634,7 +21807,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
21634
21807
|
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(){/**
|
|
21635
21808
|
* WebChat service.
|
|
21636
21809
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
21637
|
-
* @version
|
|
21810
|
+
* @version 184.0.0
|
|
21638
21811
|
*/ /**
|
|
21639
21812
|
* Constructs a new WebChatApi.
|
|
21640
21813
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -21767,7 +21940,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21767
21940
|
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(){/**
|
|
21768
21941
|
* WebDeployments service.
|
|
21769
21942
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
21770
|
-
* @version
|
|
21943
|
+
* @version 184.0.0
|
|
21771
21944
|
*/ /**
|
|
21772
21945
|
* Constructs a new WebDeploymentsApi.
|
|
21773
21946
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -21888,7 +22061,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
21888
22061
|
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(){/**
|
|
21889
22062
|
* WebMessaging service.
|
|
21890
22063
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
21891
|
-
* @version
|
|
22064
|
+
* @version 184.0.0
|
|
21892
22065
|
*/ /**
|
|
21893
22066
|
* Constructs a new WebMessagingApi.
|
|
21894
22067
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -21904,7 +22077,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
21904
22077
|
*/_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(){/**
|
|
21905
22078
|
* Widgets service.
|
|
21906
22079
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
21907
|
-
* @version
|
|
22080
|
+
* @version 184.0.0
|
|
21908
22081
|
*/ /**
|
|
21909
22082
|
* Constructs a new WidgetsApi.
|
|
21910
22083
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -21939,7 +22112,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
21939
22112
|
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(){/**
|
|
21940
22113
|
* WorkforceManagement service.
|
|
21941
22114
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
21942
|
-
* @version
|
|
22115
|
+
* @version 184.0.0
|
|
21943
22116
|
*/ /**
|
|
21944
22117
|
* Constructs a new WorkforceManagementApi.
|
|
21945
22118
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -23230,7 +23403,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
23230
23403
|
* </pre>
|
|
23231
23404
|
* </p>
|
|
23232
23405
|
* @module purecloud-platform-client-v2/index
|
|
23233
|
-
* @version
|
|
23406
|
+
* @version 184.0.0
|
|
23234
23407
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
23235
23408
|
* The ApiClient constructor.
|
|
23236
23409
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|
|
@@ -23337,6 +23510,9 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
23337
23510
|
* The LocationsApi service constructor.
|
|
23338
23511
|
* @property {module:purecloud-platform-client-v2/api/LocationsApi}
|
|
23339
23512
|
*/this.LocationsApi=LocationsApi;/**
|
|
23513
|
+
* The LogCaptureApi service constructor.
|
|
23514
|
+
* @property {module:purecloud-platform-client-v2/api/LogCaptureApi}
|
|
23515
|
+
*/this.LogCaptureApi=LogCaptureApi;/**
|
|
23340
23516
|
* The MessagingApi service constructor.
|
|
23341
23517
|
* @property {module:purecloud-platform-client-v2/api/MessagingApi}
|
|
23342
23518
|
*/this.MessagingApi=MessagingApi;/**
|