purecloud-platform-client-v2 183.0.0 → 185.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 +68 -2
- package/dist/node/purecloud-platform-client-v2.js +1395 -92
- package/dist/web-amd/purecloud-platform-client-v2.js +1395 -92
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +411 -107
- package/dist/web-cjs/purecloud-platform-client-v2.js +411 -107
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +823 -54
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +334 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +109 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +8 -9
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/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 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- 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 +168 -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 +3 -2
- 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 +222 -1
- package/src/purecloud-platform-client-v2/index.js +7 -1
|
@@ -5083,7 +5083,7 @@ module.exports = function getSideChannel() {
|
|
|
5083
5083
|
|
|
5084
5084
|
},{"call-bind/callBound":8,"get-intrinsic":13,"object-inspect":20}],"platformClient":[function(require,module,exports){
|
|
5085
5085
|
(function (global,Buffer){(function (){
|
|
5086
|
-
'use strict';function _toConsumableArray(arr){return _arrayWithoutHoles(arr)||_iterableToArray(arr)||_unsupportedIterableToArray(arr)||_nonIterableSpread();}function _nonIterableSpread(){throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");}function _arrayWithoutHoles(arr){if(Array.isArray(arr))return _arrayLikeToArray(arr);}function _toArray(arr){return _arrayWithHoles(arr)||_iterableToArray(arr)||_unsupportedIterableToArray(arr)||_nonIterableRest();}function _iterableToArray(iter){if(typeof Symbol!=="undefined"&&iter[Symbol.iterator]!=null||iter["@@iterator"]!=null)return Array.from(iter);}function _slicedToArray(arr,i){return _arrayWithHoles(arr)||_iterableToArrayLimit(arr,i)||_unsupportedIterableToArray(arr,i)||_nonIterableRest();}function _nonIterableRest(){throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");}function _unsupportedIterableToArray(o,minLen){if(!o)return;if(typeof o==="string")return _arrayLikeToArray(o,minLen);var n=Object.prototype.toString.call(o).slice(8,-1);if(n==="Object"&&o.constructor)n=o.constructor.name;if(n==="Map"||n==="Set")return Array.from(o);if(n==="Arguments"||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n))return _arrayLikeToArray(o,minLen);}function _arrayLikeToArray(arr,len){if(len==null||len>arr.length)len=arr.length;for(var i=0,arr2=new Array(len);i<len;i++)arr2[i]=arr[i];return arr2;}function _iterableToArrayLimit(r,l){var t=null==r?null:"undefined"!=typeof Symbol&&r[Symbol.iterator]||r["@@iterator"];if(null!=t){var e,n,i,u,a=[],f=!0,o=!1;try{if(i=(t=t.call(r)).next,0===l){if(Object(t)!==t)return;f=!1;}else for(;!(f=(e=i.call(t)).done)&&(a.push(e.value),a.length!==l);f=!0);}catch(r){o=!0,n=r;}finally{try{if(!f&&null!=t["return"]&&(u=t["return"](),Object(u)!==u))return;}finally{if(o)throw n;}}return a;}}function _arrayWithHoles(arr){if(Array.isArray(arr))return arr;}function ownKeys(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);r&&(o=o.filter(function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable;})),t.push.apply(t,o);}return t;}function _objectSpread(e){for(var r=1;r<arguments.length;r++){var t=null!=arguments[r]?arguments[r]:{};r%2?ownKeys(Object(t),!0).forEach(function(r){_defineProperty(e,r,t[r]);}):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):ownKeys(Object(t)).forEach(function(r){Object.defineProperty(e,r,Object.getOwnPropertyDescriptor(t,r));});}return e;}function _defineProperty(obj,key,value){key=_toPropertyKey(key);if(key in obj){Object.defineProperty(obj,key,{value:value,enumerable:true,configurable:true,writable:true});}else{obj[key]=value;}return obj;}function _classCallCheck(instance,Constructor){if(!(instance instanceof Constructor)){throw new TypeError("Cannot call a class as a function");}}function _defineProperties(target,props){for(var i=0;i<props.length;i++){var descriptor=props[i];descriptor.enumerable=descriptor.enumerable||false;descriptor.configurable=true;if("value"in descriptor)descriptor.writable=true;Object.defineProperty(target,_toPropertyKey(descriptor.key),descriptor);}}function _createClass(Constructor,protoProps,staticProps){if(protoProps)_defineProperties(Constructor.prototype,protoProps);if(staticProps)_defineProperties(Constructor,staticProps);Object.defineProperty(Constructor,"prototype",{writable:false});return Constructor;}function _toPropertyKey(
|
|
5086
|
+
'use strict';function _toConsumableArray(arr){return _arrayWithoutHoles(arr)||_iterableToArray(arr)||_unsupportedIterableToArray(arr)||_nonIterableSpread();}function _nonIterableSpread(){throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");}function _arrayWithoutHoles(arr){if(Array.isArray(arr))return _arrayLikeToArray(arr);}function _toArray(arr){return _arrayWithHoles(arr)||_iterableToArray(arr)||_unsupportedIterableToArray(arr)||_nonIterableRest();}function _iterableToArray(iter){if(typeof Symbol!=="undefined"&&iter[Symbol.iterator]!=null||iter["@@iterator"]!=null)return Array.from(iter);}function _slicedToArray(arr,i){return _arrayWithHoles(arr)||_iterableToArrayLimit(arr,i)||_unsupportedIterableToArray(arr,i)||_nonIterableRest();}function _nonIterableRest(){throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");}function _unsupportedIterableToArray(o,minLen){if(!o)return;if(typeof o==="string")return _arrayLikeToArray(o,minLen);var n=Object.prototype.toString.call(o).slice(8,-1);if(n==="Object"&&o.constructor)n=o.constructor.name;if(n==="Map"||n==="Set")return Array.from(o);if(n==="Arguments"||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n))return _arrayLikeToArray(o,minLen);}function _arrayLikeToArray(arr,len){if(len==null||len>arr.length)len=arr.length;for(var i=0,arr2=new Array(len);i<len;i++)arr2[i]=arr[i];return arr2;}function _iterableToArrayLimit(r,l){var t=null==r?null:"undefined"!=typeof Symbol&&r[Symbol.iterator]||r["@@iterator"];if(null!=t){var e,n,i,u,a=[],f=!0,o=!1;try{if(i=(t=t.call(r)).next,0===l){if(Object(t)!==t)return;f=!1;}else for(;!(f=(e=i.call(t)).done)&&(a.push(e.value),a.length!==l);f=!0);}catch(r){o=!0,n=r;}finally{try{if(!f&&null!=t["return"]&&(u=t["return"](),Object(u)!==u))return;}finally{if(o)throw n;}}return a;}}function _arrayWithHoles(arr){if(Array.isArray(arr))return arr;}function ownKeys(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);r&&(o=o.filter(function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable;})),t.push.apply(t,o);}return t;}function _objectSpread(e){for(var r=1;r<arguments.length;r++){var t=null!=arguments[r]?arguments[r]:{};r%2?ownKeys(Object(t),!0).forEach(function(r){_defineProperty(e,r,t[r]);}):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):ownKeys(Object(t)).forEach(function(r){Object.defineProperty(e,r,Object.getOwnPropertyDescriptor(t,r));});}return e;}function _defineProperty(obj,key,value){key=_toPropertyKey(key);if(key in obj){Object.defineProperty(obj,key,{value:value,enumerable:true,configurable:true,writable:true});}else{obj[key]=value;}return obj;}function _classCallCheck(instance,Constructor){if(!(instance instanceof Constructor)){throw new TypeError("Cannot call a class as a function");}}function _defineProperties(target,props){for(var i=0;i<props.length;i++){var descriptor=props[i];descriptor.enumerable=descriptor.enumerable||false;descriptor.configurable=true;if("value"in descriptor)descriptor.writable=true;Object.defineProperty(target,_toPropertyKey(descriptor.key),descriptor);}}function _createClass(Constructor,protoProps,staticProps){if(protoProps)_defineProperties(Constructor.prototype,protoProps);if(staticProps)_defineProperties(Constructor,staticProps);Object.defineProperty(Constructor,"prototype",{writable:false});return Constructor;}function _toPropertyKey(t){var i=_toPrimitive(t,"string");return"symbol"==_typeof(i)?i:String(i);}function _toPrimitive(t,r){if("object"!=_typeof(t)||!t)return t;var e=t[Symbol.toPrimitive];if(void 0!==e){var i=e.call(t,r||"default");if("object"!=_typeof(i))return i;throw new TypeError("@@toPrimitive must return a primitive value.");}return("string"===r?String:Number)(t);}function _typeof(o){"@babel/helpers - typeof";return _typeof="function"==typeof Symbol&&"symbol"==typeof Symbol.iterator?function(o){return typeof o;}:function(o){return o&&"function"==typeof Symbol&&o.constructor===Symbol&&o!==Symbol.prototype?"symbol":typeof o;},_typeof(o);}var qs=require('qs');function _interopDefaultLegacy(e){return e&&_typeof(e)==='object'&&'default'in e?e:{'default':e};}var qs__default=/*#__PURE__*/_interopDefaultLegacy(qs);var PureCloudRegionHosts={us_east_1:'mypurecloud.com',eu_west_1:'mypurecloud.ie',ap_southeast_2:'mypurecloud.com.au',ap_northeast_1:'mypurecloud.jp',eu_central_1:'mypurecloud.de',us_west_2:'usw2.pure.cloud',ca_central_1:'cac1.pure.cloud',ap_northeast_2:'apne2.pure.cloud',eu_west_2:'euw2.pure.cloud',ap_south_1:'aps1.pure.cloud',us_east_2:'use2.us-gov-pure.cloud',sa_east_1:'sae1.pure.cloud'};var global$1=typeof global!=="undefined"?global:typeof self!=="undefined"?self:typeof window!=="undefined"?window:{};var lookup=[];var revLookup=[];var Arr=typeof Uint8Array!=='undefined'?Uint8Array:Array;var inited=false;function init(){inited=true;var code='ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/';for(var i=0,len=code.length;i<len;++i){lookup[i]=code[i];revLookup[code.charCodeAt(i)]=i;}revLookup['-'.charCodeAt(0)]=62;revLookup['_'.charCodeAt(0)]=63;}function toByteArray(b64){if(!inited){init();}var i,j,l,tmp,placeHolders,arr;var len=b64.length;if(len%4>0){throw new Error('Invalid string. Length must be a multiple of 4');}// the number of equal signs (place holders)
|
|
5087
5087
|
// if there are two placeholders, than the two characters before it
|
|
5088
5088
|
// represent one byte
|
|
5089
5089
|
// if there is only one, then the three characters before it represent 2 bytes
|
|
@@ -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 185.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
|
|
@@ -6032,47 +6032,104 @@ _this3.config.logger.log('trace',response.status,'POST',"https://login.".concat(
|
|
|
6032
6032
|
var access_token=response.data.access_token;_this3.setAccessToken(access_token);_this3.authData.tokenExpiryTime=new Date().getTime()+response.data['expires_in']*1000;_this3.authData.tokenExpiryTimeString=new Date(_this3.authData.tokenExpiryTime).toUTCString();// Return auth data
|
|
6033
6033
|
resolve(_this3.authData);})["catch"](function(error){// Log error
|
|
6034
6034
|
if(error.response){_this3.config.logger.log('error',error.response.status,'POST',"https://login.".concat(_this3.config.environment,"/oauth/token"),request.headers,error.response.headers,bodyParam,error.response.data);}reject(error);});});}/**
|
|
6035
|
+
* @description Completes the PKCE Code Authorization.
|
|
6036
|
+
* @param {string} clientId - The client ID of an OAuth Code Authorization Grant client
|
|
6037
|
+
* @param {string} codeVerifier - code verifier used to generate the code challenge
|
|
6038
|
+
* @param {string} authCode - Authorization code
|
|
6039
|
+
* @param {string} redirectUri - Authorized redirect URI for your Code Authorization client
|
|
6040
|
+
*/},{key:"authorizePKCEGrant",value:function authorizePKCEGrant(clientId,codeVerifier,authCode,redirectUri){var _this4=this;this.clientId=clientId;return new Promise(function(resolve,reject){var request=axios$1({method:"POST",url:"https://login.".concat(_this4.config.environment,"/oauth/token"),headers:{'Content-Type':'application/x-www-form-urlencoded'},data:qs__default["default"].stringify({grant_type:'authorization_code',code:authCode,code_verifier:codeVerifier,client_id:clientId,redirect_uri:redirectUri})});request.proxy=_this4.proxy;var bodyParam={grant_type:'authorization_code',code:authCode,code_verifier:codeVerifier,client_id:clientId,redirect_uri:redirectUri};// Handle response
|
|
6041
|
+
request.then(function(response){// Logging
|
|
6042
|
+
_this4.config.logger.log('trace',response.status,'POST',"https://login.".concat(_this4.config.environment,"/oauth/token"),request.headers,response.headers,bodyParam,undefined);_this4.config.logger.log('debug',response.status,'POST',"https://login.".concat(_this4.config.environment,"/oauth/token"),request.headers,undefined,bodyParam,undefined);// Get access token from response
|
|
6043
|
+
var access_token=response.data.access_token;_this4.setAccessToken(access_token);_this4.authData.tokenExpiryTime=new Date().getTime()+response.data['expires_in']*1000;_this4.authData.tokenExpiryTimeString=new Date(_this4.authData.tokenExpiryTime).toUTCString();// Return auth data
|
|
6044
|
+
resolve(_this4.authData);})["catch"](function(error){// Log error
|
|
6045
|
+
if(error.response){_this4.config.logger.log('error',error.response.status,'POST',"https://login.".concat(_this4.config.environment,"/oauth/token"),request.headers,error.response.headers,bodyParam,error.response.data);}reject(error);});});}/**
|
|
6046
|
+
* @description Generate a random string used as PKCE Code Verifier - length = 43 to 128.
|
|
6047
|
+
* @param {number} nChar - code length
|
|
6048
|
+
*/},{key:"generatePKCECodeVerifier",value:function generatePKCECodeVerifier(nChar){if(nChar<43||nChar>128){throw new Error("PKCE Code Verifier (length) must be between 43 and 128 characters");}// Check for window
|
|
6049
|
+
{var unreservedCharacters="0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-._~";var randomString=Array.from(crypto.getRandomValues(new Uint32Array(nChar))).map(function(x){return unreservedCharacters[x%unreservedCharacters.length];}).join('');return randomString;}}/**
|
|
6050
|
+
* @description Compute Base64Url PKCE Code Challenge from Code Verifier.
|
|
6051
|
+
* @param {string} code - code verifier used to generate the code challenge
|
|
6052
|
+
*/},{key:"computePKCECodeChallenge",value:function computePKCECodeChallenge(code){if(code.length<43||code.length>128){throw new Error("PKCE Code Verifier (length) must be between 43 and 128 characters");}// Check for window
|
|
6053
|
+
{// browser
|
|
6054
|
+
var utf8=new TextEncoder().encode(code);return new Promise(function(resolve,reject){window.crypto.subtle.digest("SHA-256",utf8).then(function(hashBuffer){var hashBase64=Buffer.from(hashBuffer).toString('base64');var hashBase64Url=hashBase64.replaceAll("+","-").replaceAll("/","_");hashBase64Url=hashBase64Url.split("=")[0];resolve(hashBase64Url);})["catch"](function(error){// Handle failure
|
|
6055
|
+
return reject(new Error("Code Challenge Error ".concat(error)));});});}}/**
|
|
6056
|
+
* @description Initiates the pkce auth code grant login flow. Will attempt to load the token from local storage, if enabled.
|
|
6057
|
+
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
6058
|
+
* @param {string} redirectUri - The redirect URI of the OAuth Implicit Grant client
|
|
6059
|
+
* @param {object} opts - (optional) Additional options
|
|
6060
|
+
* @param {string} opts.state - (optional) An arbitrary string to be passed back with the login response. Used for client apps to associate login responses with a request.
|
|
6061
|
+
* @param {string} opts.org - (optional) The organization name that would normally used when specifying an organization name when logging in. This is only used when a provider is also specified.
|
|
6062
|
+
* @param {string} opts.provider - (optional) Authentication provider to log in with e.g. okta, adfs, salesforce, onelogin. This is only used when an org is also specified.
|
|
6063
|
+
* @param {string} codeVerifier - (optional) code verifier used to generate the code challenge
|
|
6064
|
+
*/},{key:"loginPKCEGrant",value:function loginPKCEGrant(clientId,redirectUri,opts,codeVerifier){var _this5=this;// Need Local Storage or non null codeVerifier as parameter
|
|
6065
|
+
if(!this.hasLocalStorage&&!codeVerifier){throw new Error("loginPKCEGrant requires Local Storage or codeVerifier as input parameter");}// Check for auth code in query
|
|
6066
|
+
var query=this._setValuesFromUrlQuery();this.clientId=clientId;this.redirectUri=redirectUri;this.codeVerifier=codeVerifier;if(!opts)opts={};return new Promise(function(resolve,reject){// Abort if org and provider are not set together
|
|
6067
|
+
if(opts.org&&!opts.provider){reject(new Error('opts.provider must be set if opts.org is set'));}else if(opts.provider&&!opts.org){reject(new Error('opts.org must be set if opts.provider is set'));}// Abort on auth error
|
|
6068
|
+
if(query&&query.error){// remove codeVerifier from session storage
|
|
6069
|
+
if(_this5.hasLocalStorage){sessionStorage.removeItem("genesys_cloud_sdk_pkce_code_verifier");}// reset access token if any was stored
|
|
6070
|
+
_this5._saveSettings({accessToken:undefined});return reject(new Error("[".concat(query.error,"] ").concat(query.error_description)));}// Get token on auth code
|
|
6071
|
+
if(query&&query.code){if(!_this5.codeVerifier){// load codeVerifier from session storage
|
|
6072
|
+
if(_this5.hasLocalStorage){_this5.codeVerifier=sessionStorage.getItem("genesys_cloud_sdk_pkce_code_verifier");}}_this5.authorizePKCEGrant(_this5.clientId,_this5.codeVerifier,query.code,_this5.redirectUri).then(function(){// Do authenticated things
|
|
6073
|
+
_this5._testTokenAccess().then(function(){if(!_this5.authData.state&&query.state)_this5.authData.state=query.state;// remove codeVerifier from session storage
|
|
6074
|
+
if(_this5.hasLocalStorage){sessionStorage.removeItem("genesys_cloud_sdk_pkce_code_verifier");}resolve(_this5.authData);})["catch"](function(error){// Handle failure response
|
|
6075
|
+
_this5._saveSettings({accessToken:undefined});// remove codeVerifier from session storage
|
|
6076
|
+
if(_this5.hasLocalStorage){sessionStorage.removeItem("genesys_cloud_sdk_pkce_code_verifier");}return reject(new Error("[".concat(error.name,"] ").concat(error.msg)));});})["catch"](function(error){// Handle failure response
|
|
6077
|
+
_this5._saveSettings({accessToken:undefined});// remove codeVerifier from session storage
|
|
6078
|
+
if(_this5.hasLocalStorage){sessionStorage.removeItem("genesys_cloud_sdk_pkce_code_verifier");}return reject(new Error("[".concat(error.name,"] ").concat(error.msg)));});}else{// Test token (if previously stored) and proceed with login
|
|
6079
|
+
_this5._testTokenAccess().then(function(){if(!_this5.authData.state&&opts.state)_this5.authData.state=opts.state;resolve(_this5.authData);})["catch"](function(error){if(!_this5.codeVerifier){_this5.codeVerifier=_this5.generatePKCECodeVerifier(128);// save codeVerifier in session storage
|
|
6080
|
+
if(_this5.hasLocalStorage){sessionStorage.setItem("genesys_cloud_sdk_pkce_code_verifier",_this5.codeVerifier);}}_this5.computePKCECodeChallenge(_this5.codeVerifier).then(function(codeChallenge){var tokenQuery={client_id:encodeURIComponent(_this5.clientId),redirect_uri:encodeURIComponent(_this5.redirectUri),code_challenge:encodeURIComponent(codeChallenge),response_type:'code',code_challenge_method:'S256'};if(opts.state)tokenQuery.state=encodeURIComponent(opts.state);if(opts.org)tokenQuery.org=encodeURIComponent(opts.org);if(opts.provider)tokenQuery.provider=encodeURIComponent(opts.provider);var url=_this5._buildAuthUrl('oauth/authorize',tokenQuery);window.location.replace(url);})["catch"](function(err){return reject(new Error("[".concat(err.name,"]")));});});}});}/**
|
|
6081
|
+
* @description Parses the URL Query, grabs the code, and clears the query param. If no code is found, no action is taken.
|
|
6082
|
+
*/},{key:"_setValuesFromUrlQuery",value:function _setValuesFromUrlQuery(){// Check for window
|
|
6083
|
+
if(!(typeof window!=='undefined'&&window.location.search))return;// Process query string
|
|
6084
|
+
var query={};var queryParams=new URLSearchParams(window.location.search);var code=queryParams.get('code');var error=queryParams.get('error');var errorDescription=queryParams.get('error_description');var state=queryParams.get('state');// Check for error
|
|
6085
|
+
if(error){query.error=error;if(errorDescription){query.error_description=errorDescription;}return query;}// Everything goes in here because we only want to act if we found an access token
|
|
6086
|
+
if(code){query.code=code;if(state){query.state=state;}}// Remove code from URL
|
|
6087
|
+
// Credit: https://stackoverflow.com/questions/1397329/how-to-remove-the-hash-from-window-location-with-javascript-without-page-refresh/5298684#5298684
|
|
6088
|
+
var scrollV,scrollH,loc=window.location;if('replaceState'in history){history.replaceState('',document.title,loc.pathname);}else{// Prevent scrolling by storing the page's current scroll offset
|
|
6089
|
+
scrollV=document.body.scrollTop;scrollH=document.body.scrollLeft;// Remove code
|
|
6090
|
+
history.pushState('',document.title,loc.pathname);// Restore the scroll offset, should be flicker free
|
|
6091
|
+
document.body.scrollTop=scrollV;document.body.scrollLeft=scrollH;}return query;}/**
|
|
6035
6092
|
* @description Initiates the Code Authorization. Only available in node apps.
|
|
6036
6093
|
* @param {string} clientId - The client ID of an OAuth Code Authorization Grant client
|
|
6037
6094
|
* @param {string} clientSecret - The client secret of an OAuth Code Authorization Grant client
|
|
6038
6095
|
* @param {string} authCode - Authorization code
|
|
6039
6096
|
* @param {string} redirectUri - Authorized redirect URI for your Code Authorization client
|
|
6040
|
-
*/},{key:"loginCodeAuthorizationGrant",value:function loginCodeAuthorizationGrant(clientId,clientSecret,authCode,redirectUri){var
|
|
6041
|
-
|
|
6097
|
+
*/},{key:"loginCodeAuthorizationGrant",value:function loginCodeAuthorizationGrant(clientId,clientSecret,authCode,redirectUri){var _this6=this;this.clientId=clientId;this.clientSecret=clientSecret;return new Promise(function(resolve,reject){if(typeof window!=='undefined'){reject(new Error('The Code Authorization grant is not supported in a browser.'));return;}var encodedData=Buffer.from(clientId+':'+clientSecret).toString('base64');var request=_this6._formAuthRequest(encodedData,{grant_type:'authorization_code',code:authCode,redirect_uri:redirectUri});request.proxy=_this6.proxy;var bodyParam={grant_type:'authorization_code',code:authCode,redirect_uri:redirectUri};// Handle response
|
|
6098
|
+
_this6._handleCodeAuthorizationResponse(request,bodyParam,resolve,reject);});}/**
|
|
6042
6099
|
* @description Requests a new access token for Code Authorization. Only available in node apps.
|
|
6043
6100
|
* @param {string} clientId - The client ID of an OAuth Code Authorization Grant client
|
|
6044
6101
|
* @param {string} clientSecret - The client secret of an OAuth Code Authorization Grant client
|
|
6045
6102
|
* @param {string} authCode - Authorization code
|
|
6046
6103
|
* @param {string} redirectUri - Authorized redirect URI for your Code Authorization client
|
|
6047
|
-
*/},{key:"refreshCodeAuthorizationGrant",value:function refreshCodeAuthorizationGrant(clientId,clientSecret,refreshToken){var
|
|
6048
|
-
|
|
6104
|
+
*/},{key:"refreshCodeAuthorizationGrant",value:function refreshCodeAuthorizationGrant(clientId,clientSecret,refreshToken){var _this7=this;return new Promise(function(resolve,reject){if(typeof window!=='undefined'){reject(new Error('The Code Authorization grant is not supported in a browser.'));return;}var encodedData=Buffer.from(clientId+':'+clientSecret).toString('base64');var request=_this7._formAuthRequest(encodedData,{grant_type:'refresh_token',refresh_token:refreshToken});request.proxy=_this7.proxy;var bodyParam={grant_type:'refresh_token',refresh_token:refreshToken};// Handle response
|
|
6105
|
+
_this7._handleCodeAuthorizationResponse(request,bodyParam,resolve,reject);});}/**
|
|
6049
6106
|
* @description Handles the response for code auth requests
|
|
6050
6107
|
* @param {object} request - Authorization request object
|
|
6051
6108
|
* @param {object} bodyParam - Input body data for authorization request
|
|
6052
6109
|
* @param {function} resolve - Promise resolve callback
|
|
6053
6110
|
* @param {function} reject - Promise reject callback
|
|
6054
|
-
*/},{key:"_handleCodeAuthorizationResponse",value:function _handleCodeAuthorizationResponse(request,bodyParam,resolve,reject){var
|
|
6055
|
-
|
|
6056
|
-
var access_token=response.data.access_token;var refresh_token=response.data.refresh_token;
|
|
6057
|
-
resolve(
|
|
6058
|
-
if(error.response){
|
|
6111
|
+
*/},{key:"_handleCodeAuthorizationResponse",value:function _handleCodeAuthorizationResponse(request,bodyParam,resolve,reject){var _this8=this;request.then(function(response){// Logging
|
|
6112
|
+
_this8.config.logger.log('trace',response.status,'POST',"https://login.".concat(_this8.config.environment,"/oauth/token"),request.headers,response.headers,bodyParam,undefined);_this8.config.logger.log('debug',response.status,'POST',"https://login.".concat(_this8.config.environment,"/oauth/token"),request.headers,undefined,bodyParam,undefined);// Get access token from response
|
|
6113
|
+
var access_token=response.data.access_token;var refresh_token=response.data.refresh_token;_this8.setAccessToken(access_token);_this8.authData.refreshToken=refresh_token;_this8.authData.tokenExpiryTime=new Date().getTime()+response.data['expires_in']*1000;_this8.authData.tokenExpiryTimeString=new Date(_this8.authData.tokenExpiryTime).toUTCString();// Return auth data
|
|
6114
|
+
resolve(_this8.authData);})["catch"](function(error){// Log error
|
|
6115
|
+
if(error.response){_this8.config.logger.log('error',error.response.status,'POST',"https://login.".concat(_this8.config.environment,"/oauth/token"),request.headers,error.response.headers,bodyParam,error.response.data);}reject(error);});}/**
|
|
6059
6116
|
* @description Utility function to create the request for auth requests
|
|
6060
6117
|
* @param {string} encodedData - Base64 encoded client and clientSecret pair
|
|
6061
6118
|
* @param {object} data - data to url form encode
|
|
6062
6119
|
*/},{key:"_formAuthRequest",value:function _formAuthRequest(encodedData,data){var request=axios$1({method:"POST",url:"https://login.".concat(this.config.environment,"/oauth/token"),headers:{'Authorization':'Basic '+encodedData,'Content-Type':'application/x-www-form-urlencoded'},data:qs__default["default"].stringify(data)});return request;}/**
|
|
6063
6120
|
* @description Handles an expired access token. Only available in node apps.
|
|
6064
6121
|
* @param {string} statusCode - The status code of a request
|
|
6065
|
-
*/},{key:"_handleExpiredAccessToken",value:function _handleExpiredAccessToken(){var
|
|
6066
|
-
|
|
6067
|
-
|
|
6122
|
+
*/},{key:"_handleExpiredAccessToken",value:function _handleExpiredAccessToken(){var _this9=this;return new Promise(function(resolve,reject){if(typeof window!=='undefined'){reject(new Error('This method is not supported in a browser.'));return;}if(!_this9.refreshInProgress){_this9.refreshInProgress=true;_this9.refreshCodeAuthorizationGrant(_this9.clientId,_this9.clientSecret,_this9.authData.refreshToken).then(function(){_this9.refreshInProgress=false;resolve();})["catch"](function(err){// Handle failure response
|
|
6123
|
+
_this9.refreshInProgress=false;reject(err);});}else{// Wait refresh_token_wait_max seconds for other thread to complete refresh
|
|
6124
|
+
_this9._sleep(_this9.config.refresh_token_wait_max).then(function(){if(_this9.refreshInProgress)reject(new Error("Token refresh took longer than ".concat(_this9.config.refresh_token_wait_max," seconds")));else resolve();});}});}/**
|
|
6068
6125
|
* @description Sleeps for a defined length
|
|
6069
6126
|
* @param {int} millis - Length to sleep in milliseconds
|
|
6070
6127
|
*/},{key:"_sleep",value:function _sleep(millis){return new Promise(function(resolve){return setTimeout(resolve,millis);});}/**
|
|
6071
6128
|
* @description Loads token from storage, if enabled, and checks to ensure it works.
|
|
6072
|
-
*/},{key:"_testTokenAccess",value:function _testTokenAccess(){var
|
|
6073
|
-
|
|
6074
|
-
if(!
|
|
6075
|
-
|
|
6129
|
+
*/},{key:"_testTokenAccess",value:function _testTokenAccess(){var _this10=this;return new Promise(function(resolve,reject){// Load from storage
|
|
6130
|
+
_this10._loadSettings();// Check if there is a token to test
|
|
6131
|
+
if(!_this10.authentications['PureCloud OAuth'].accessToken){reject(new Error('Token is not set'));return;}// Test token
|
|
6132
|
+
_this10.callApi('/api/v2/tokens/me','GET',null,null,null,null,null,['PureCloud OAuth'],['application/json'],['application/json']).then(function(){resolve();})["catch"](function(error){_this10._saveSettings({accessToken:undefined});reject(error);});});}/**
|
|
6076
6133
|
* @description Parses the URL hash, grabs the access token, and clears the hash. If no access token is found, no action is taken.
|
|
6077
6134
|
*/},{key:"_setValuesFromUrlHash",value:function _setValuesFromUrlHash(){// Check for window
|
|
6078
6135
|
if(!(typeof window!=='undefined'&&window.location.hash))return;// Process hash string into object
|
|
@@ -6117,7 +6174,7 @@ this.setAccessToken(this.authentications['PureCloud OAuth'].accessToken);}/**
|
|
|
6117
6174
|
* @param {String} path The path to append to the base URL.
|
|
6118
6175
|
* @param {Object} pathParams The parameter values to append.
|
|
6119
6176
|
* @returns {String} The encoded path with parameter values substituted.
|
|
6120
|
-
*/},{key:"buildUrl",value:function buildUrl(path,pathParams){var
|
|
6177
|
+
*/},{key:"buildUrl",value:function buildUrl(path,pathParams){var _this11=this;if(!path.match(/^\//)){path="/".concat(path);}var url=this.config.basePath+path;url=url.replace(/\{([\w-]+)\}/g,function(fullMatch,key){var value;if(pathParams.hasOwnProperty(key)){value=_this11.paramToString(pathParams[key]);}else{value=fullMatch;}return encodeURIComponent(value);});return url;}/**
|
|
6121
6178
|
* Checks whether the given content type represents JSON.<br>
|
|
6122
6179
|
* JSON content type examples:<br>
|
|
6123
6180
|
* <ul>
|
|
@@ -6158,7 +6215,7 @@ return param.map(this.paramToString);default:throw new Error("Unknown collection
|
|
|
6158
6215
|
* Applies authentication headers to the request.
|
|
6159
6216
|
* @param {Object} request The axios request config object.
|
|
6160
6217
|
* @param {Array.<String>} authNames An array of authentication method names.
|
|
6161
|
-
*/},{key:"applyAuthToRequest",value:function applyAuthToRequest(request,authNames){var
|
|
6218
|
+
*/},{key:"applyAuthToRequest",value:function applyAuthToRequest(request,authNames){var _this12=this;authNames.forEach(function(authName){var auth=_this12.authentications[authName];switch(auth.type){case'basic':if(auth.username||auth.password){request.auth={username:auth.username||'',password:auth.password||''};}break;case'apiKey':if(auth.apiKey){var data={};if(auth.apiKeyPrefix){data[auth.name]="".concat(auth.apiKeyPrefix," ").concat(auth.apiKey);}else{data[auth.name]=auth.apiKey;}if(auth['in']==='header'){request.headers=_this12.addHeaders(request.headers,data);}else{request.params=_this12.serialize(data);}}break;case'oauth2':if(auth.accessToken){request.headers=_this12.addHeaders(request.headers,{'Authorization':"Bearer ".concat(auth.accessToken)});}break;default:throw new Error("Unknown authentication type: ".concat(auth.type));}});}/**
|
|
6162
6219
|
* @description Sets the proxy agent axios will use for requests
|
|
6163
6220
|
* @param {any} agent - The proxy agent
|
|
6164
6221
|
*/},{key:"setProxyAgent",value:function setProxyAgent(agent){this.proxyAgent=agent;}/**
|
|
@@ -6175,7 +6232,7 @@ return param.map(this.paramToString);default:throw new Error("Unknown collection
|
|
|
6175
6232
|
* @param {Array.<String>} accepts An array of acceptable response MIME types.types or the
|
|
6176
6233
|
* constructor for a complex type.
|
|
6177
6234
|
* @returns {Promise} A Promise object.
|
|
6178
|
-
*/},{key:"callApi",value:function callApi(path,httpMethod,pathParams,queryParams,headerParams,formParams,bodyParam,authNames,contentTypes,accepts){var
|
|
6235
|
+
*/},{key:"callApi",value:function callApi(path,httpMethod,pathParams,queryParams,headerParams,formParams,bodyParam,authNames,contentTypes,accepts){var _this13=this;return new Promise(function(resolve,reject){sendRequest(_this13);function sendRequest(that){var url=that.buildUrl(path,pathParams);var request={method:httpMethod,url:url,httpsAgent:that.proxyAgent,timeout:that.timeout,params:that.serialize(queryParams)};// apply authentications
|
|
6179
6236
|
that.applyAuthToRequest(request,authNames);// set header parameters
|
|
6180
6237
|
var defaultHeaders=that.defaultHeaders;var normalizedHeaderParams=that.normalizeParams(headerParams);request.headers=that.addHeaders(request.headers,defaultHeaders,normalizedHeaderParams);var contentType=that.jsonPreferredMime(contentTypes);if(contentType){request.headers['Content-Type']=contentType;}else if(!request.headers['Content-Type']){request.headers['Content-Type']='application/json';}if(contentType==='application/x-www-form-urlencoded'){request.data=that.normalizeParams(formParams);}else if(contentType=='multipart/form-data'){var _formParams=that.normalizeParams(formParams);for(var key in _formParams){if(_formParams.hasOwnProperty(key)){// Looks like axios handles files and forms the same way
|
|
6181
6238
|
var formData=new FormData();formData.set(key,_formParams[key]);request.data=formData;}}}else if(bodyParam){request.data=bodyParam;}var accept=that.jsonPreferredMime(accepts);if(accept){request.headers['Accept']=accept;}axios$1.request(request).then(function(response){// Build response object
|
|
@@ -6185,7 +6242,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
6185
6242
|
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
6243
|
* Alerting service.
|
|
6187
6244
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
6188
|
-
* @version
|
|
6245
|
+
* @version 185.0.0
|
|
6189
6246
|
*/ /**
|
|
6190
6247
|
* Constructs a new AlertingApi.
|
|
6191
6248
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -6342,7 +6399,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
6342
6399
|
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(){/**
|
|
6343
6400
|
* Analytics service.
|
|
6344
6401
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
6345
|
-
* @version
|
|
6402
|
+
* @version 185.0.0
|
|
6346
6403
|
*/ /**
|
|
6347
6404
|
* Constructs a new AnalyticsApi.
|
|
6348
6405
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -6474,6 +6531,20 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
6474
6531
|
* getAnalyticsEvaluationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6475
6532
|
*/},{key:"getAnalyticsEvaluationsAggregatesJobResults",value:function getAnalyticsEvaluationsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
6476
6533
|
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']);}/**
|
|
6534
|
+
* Get status for async query for flow execution aggregates
|
|
6535
|
+
*
|
|
6536
|
+
* @param {String} jobId jobId
|
|
6537
|
+
* getAnalyticsFlowexecutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6538
|
+
*/},{key:"getAnalyticsFlowexecutionsAggregatesJob",value:function getAnalyticsFlowexecutionsAggregatesJob(jobId){// verify the required parameter 'jobId' is set
|
|
6539
|
+
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']);}/**
|
|
6540
|
+
* Fetch a page of results for an async aggregates query
|
|
6541
|
+
*
|
|
6542
|
+
* @param {String} jobId jobId
|
|
6543
|
+
* @param {Object} opts Optional parameters
|
|
6544
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
6545
|
+
* getAnalyticsFlowexecutionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6546
|
+
*/},{key:"getAnalyticsFlowexecutionsAggregatesJobResults",value:function getAnalyticsFlowexecutionsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
6547
|
+
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']);}/**
|
|
6477
6548
|
* Get status for async query for Flow aggregates
|
|
6478
6549
|
*
|
|
6479
6550
|
* @param {String} jobId jobId
|
|
@@ -6745,6 +6816,18 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6745
6816
|
* @param {Object} body query
|
|
6746
6817
|
*/},{key:"postAnalyticsEvaluationsAggregatesQuery",value:function postAnalyticsEvaluationsAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
6747
6818
|
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']);}/**
|
|
6819
|
+
* Query for flow execution aggregates asynchronously
|
|
6820
|
+
*
|
|
6821
|
+
* @param {Object} body query
|
|
6822
|
+
* postAnalyticsFlowexecutionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6823
|
+
*/},{key:"postAnalyticsFlowexecutionsAggregatesJobs",value:function postAnalyticsFlowexecutionsAggregatesJobs(body){// verify the required parameter 'body' is set
|
|
6824
|
+
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']);}/**
|
|
6825
|
+
* Query for flow execution aggregates
|
|
6826
|
+
*
|
|
6827
|
+
* @param {Object} body query
|
|
6828
|
+
* postAnalyticsFlowexecutionsAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6829
|
+
*/},{key:"postAnalyticsFlowexecutionsAggregatesQuery",value:function postAnalyticsFlowexecutionsAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
6830
|
+
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']);}/**
|
|
6748
6831
|
* Query for flow activity observations
|
|
6749
6832
|
*
|
|
6750
6833
|
* @param {Object} body query
|
|
@@ -6923,7 +7006,7 @@ if(scheduleId===undefined||scheduleId===null){throw'Missing the required paramet
|
|
|
6923
7006
|
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(){/**
|
|
6924
7007
|
* Architect service.
|
|
6925
7008
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6926
|
-
* @version
|
|
7009
|
+
* @version 185.0.0
|
|
6927
7010
|
*/ /**
|
|
6928
7011
|
* Constructs a new ArchitectApi.
|
|
6929
7012
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -7816,7 +7899,7 @@ if(datatableId===undefined||datatableId===null){throw'Missing the required param
|
|
|
7816
7899
|
if(datatableId===undefined||datatableId===null){throw'Missing the required parameter "datatableId" when calling postFlowsDatatableImportJobs';}// verify the required parameter 'body' is set
|
|
7817
7900
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postFlowsDatatableImportJobs';}return this.apiClient.callApi('/api/v2/flows/datatables/{datatableId}/import/jobs','POST',{'datatableId':datatableId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7818
7901
|
* Create a new row entry for the datatable.
|
|
7819
|
-
* Will add the passed in row entry to the datatable with the given datatableId after verifying it against the schema. The DataTableRow should be a json-ized stream of key -> value pairs { "Field1": "XYZZY", "Field2": false, "KEY": "27272" }
|
|
7902
|
+
* Will add the passed in row entry to the datatable with the given datatableId after verifying it against the schema. When building the request body within API Explorer, Pro mode should be used. The DataTableRow should be a json-ized stream of key -> value pairs { "Field1": "XYZZY", "Field2": false, "KEY": "27272" }
|
|
7820
7903
|
* @param {String} datatableId id of datatable
|
|
7821
7904
|
* @param {Object.<String, {String: Object}>} dataTableRow
|
|
7822
7905
|
*/},{key:"postFlowsDatatableRows",value:function postFlowsDatatableRows(datatableId,dataTableRow){// verify the required parameter 'datatableId' is set
|
|
@@ -7931,7 +8014,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7931
8014
|
if(datatableId===undefined||datatableId===null){throw'Missing the required parameter "datatableId" when calling putFlowsDatatable';}// verify the required parameter 'body' is set
|
|
7932
8015
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putFlowsDatatable';}return this.apiClient.callApi('/api/v2/flows/datatables/{datatableId}','PUT',{'datatableId':datatableId},{'expand':opts['expand']},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7933
8016
|
* Update a row entry
|
|
7934
|
-
* Updates a row with the given rowId (the value of the key field) to the new values. The DataTableRow should be a json-ized stream of key -> value pairs { "Field1": "XYZZY", "Field2": false, "KEY": "27272" }
|
|
8017
|
+
* Updates a row with the given rowId (the value of the key field) to the new values. When building the request body within API Explorer, Pro mode should be used. The DataTableRow should be a json-ized stream of key -> value pairs { "Field1": "XYZZY", "Field2": false, "KEY": "27272" }
|
|
7935
8018
|
* @param {String} datatableId id of datatable
|
|
7936
8019
|
* @param {String} rowId the key for the row
|
|
7937
8020
|
* @param {Object} opts Optional parameters
|
|
@@ -7955,7 +8038,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
7955
8038
|
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(){/**
|
|
7956
8039
|
* Audit service.
|
|
7957
8040
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
7958
|
-
* @version
|
|
8041
|
+
* @version 185.0.0
|
|
7959
8042
|
*/ /**
|
|
7960
8043
|
* Constructs a new AuditApi.
|
|
7961
8044
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -7997,7 +8080,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7997
8080
|
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(){/**
|
|
7998
8081
|
* Authorization service.
|
|
7999
8082
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8000
|
-
* @version
|
|
8083
|
+
* @version 185.0.0
|
|
8001
8084
|
*/ /**
|
|
8002
8085
|
* Constructs a new AuthorizationApi.
|
|
8003
8086
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -8102,7 +8185,7 @@ if(permission===undefined||permission===null){throw'Missing the required paramet
|
|
|
8102
8185
|
* Get the organization role specified by its ID.
|
|
8103
8186
|
* @param {String} roleId Role ID
|
|
8104
8187
|
* @param {Object} opts Optional parameters
|
|
8105
|
-
* @param {Object} opts.userCount Fetch the count of users who have this role granted in at least one division (default to true)
|
|
8188
|
+
* @param {Object} opts.userCount Fetch the count of users who have this role granted in at least one division. Setting this value or defaulting to 'true' can lead to slower load times or timeouts for role queries with large member counts. (default to true)
|
|
8106
8189
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand. unusedPermissions returns the permissions not used for the role
|
|
8107
8190
|
*/},{key:"getAuthorizationRole",value:function getAuthorizationRole(roleId,opts){opts=opts||{};// verify the required parameter 'roleId' is set
|
|
8108
8191
|
if(roleId===undefined||roleId===null){throw'Missing the required parameter "roleId" when calling getAuthorizationRole';}return this.apiClient.callApi('/api/v2/authorization/roles/{roleId}','GET',{'roleId':roleId},{'userCount':opts['userCount'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -8193,10 +8276,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8193
8276
|
* Recreate a previously deleted division.
|
|
8194
8277
|
*
|
|
8195
8278
|
* @param {String} divisionId Division ID
|
|
8196
|
-
* @param {Object}
|
|
8197
|
-
|
|
8198
|
-
|
|
8199
|
-
if(
|
|
8279
|
+
* @param {Object} opts Optional parameters
|
|
8280
|
+
* @param {Object} opts.body Recreated division data
|
|
8281
|
+
*/},{key:"postAuthorizationDivisionRestore",value:function postAuthorizationDivisionRestore(divisionId,opts){opts=opts||{};// verify the required parameter 'divisionId' is set
|
|
8282
|
+
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']);}/**
|
|
8200
8283
|
* Create a division.
|
|
8201
8284
|
*
|
|
8202
8285
|
* @param {Object} body Division
|
|
@@ -8308,7 +8391,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
8308
8391
|
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(){/**
|
|
8309
8392
|
* Billing service.
|
|
8310
8393
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
8311
|
-
* @version
|
|
8394
|
+
* @version 185.0.0
|
|
8312
8395
|
*/ /**
|
|
8313
8396
|
* Constructs a new BillingApi.
|
|
8314
8397
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -8332,7 +8415,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
8332
8415
|
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(){/**
|
|
8333
8416
|
* CarrierServices service.
|
|
8334
8417
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
8335
|
-
* @version
|
|
8418
|
+
* @version 185.0.0
|
|
8336
8419
|
*/ /**
|
|
8337
8420
|
* Constructs a new CarrierServicesApi.
|
|
8338
8421
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -8352,7 +8435,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
8352
8435
|
*/},{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(){/**
|
|
8353
8436
|
* Chat service.
|
|
8354
8437
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
8355
|
-
* @version
|
|
8438
|
+
* @version 185.0.0
|
|
8356
8439
|
*/ /**
|
|
8357
8440
|
* Constructs a new ChatApi.
|
|
8358
8441
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -8549,7 +8632,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8549
8632
|
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(){/**
|
|
8550
8633
|
* Coaching service.
|
|
8551
8634
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
8552
|
-
* @version
|
|
8635
|
+
* @version 185.0.0
|
|
8553
8636
|
*/ /**
|
|
8554
8637
|
* Constructs a new CoachingApi.
|
|
8555
8638
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -8702,7 +8785,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8702
8785
|
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(){/**
|
|
8703
8786
|
* ContentManagement service.
|
|
8704
8787
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8705
|
-
* @version
|
|
8788
|
+
* @version 185.0.0
|
|
8706
8789
|
*/ /**
|
|
8707
8790
|
* Constructs a new ContentManagementApi.
|
|
8708
8791
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -9004,7 +9087,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
9004
9087
|
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(){/**
|
|
9005
9088
|
* Conversations service.
|
|
9006
9089
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9007
|
-
* @version
|
|
9090
|
+
* @version 185.0.0
|
|
9008
9091
|
*/ /**
|
|
9009
9092
|
* Constructs a new ConversationsApi.
|
|
9010
9093
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -10728,7 +10811,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
10728
10811
|
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(){/**
|
|
10729
10812
|
* DataExtensions service.
|
|
10730
10813
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
10731
|
-
* @version
|
|
10814
|
+
* @version 185.0.0
|
|
10732
10815
|
*/ /**
|
|
10733
10816
|
* Constructs a new DataExtensionsApi.
|
|
10734
10817
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -10749,7 +10832,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
10749
10832
|
*/},{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(){/**
|
|
10750
10833
|
* Downloads service.
|
|
10751
10834
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
10752
|
-
* @version
|
|
10835
|
+
* @version 185.0.0
|
|
10753
10836
|
*/ /**
|
|
10754
10837
|
* Constructs a new DownloadsApi.
|
|
10755
10838
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -10768,7 +10851,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
10768
10851
|
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(){/**
|
|
10769
10852
|
* Emails service.
|
|
10770
10853
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
10771
|
-
* @version
|
|
10854
|
+
* @version 185.0.0
|
|
10772
10855
|
*/ /**
|
|
10773
10856
|
* Constructs a new EmailsApi.
|
|
10774
10857
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -10786,7 +10869,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
10786
10869
|
*/},{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(){/**
|
|
10787
10870
|
* Events service.
|
|
10788
10871
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
10789
|
-
* @version
|
|
10872
|
+
* @version 185.0.0
|
|
10790
10873
|
*/ /**
|
|
10791
10874
|
* Constructs a new EventsApi.
|
|
10792
10875
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -10811,7 +10894,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10811
10894
|
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(){/**
|
|
10812
10895
|
* ExternalContacts service.
|
|
10813
10896
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
10814
|
-
* @version
|
|
10897
|
+
* @version 185.0.0
|
|
10815
10898
|
*/ /**
|
|
10816
10899
|
* Constructs a new ExternalContactsApi.
|
|
10817
10900
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -11266,7 +11349,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
11266
11349
|
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(){/**
|
|
11267
11350
|
* Fax service.
|
|
11268
11351
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
11269
|
-
* @version
|
|
11352
|
+
* @version 185.0.0
|
|
11270
11353
|
*/ /**
|
|
11271
11354
|
* Constructs a new FaxApi.
|
|
11272
11355
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -11307,7 +11390,7 @@ if(documentId===undefined||documentId===null){throw'Missing the required paramet
|
|
|
11307
11390
|
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(){/**
|
|
11308
11391
|
* Flows service.
|
|
11309
11392
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
11310
|
-
* @version
|
|
11393
|
+
* @version 185.0.0
|
|
11311
11394
|
*/ /**
|
|
11312
11395
|
* Constructs a new FlowsApi.
|
|
11313
11396
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -11356,7 +11439,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11356
11439
|
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(){/**
|
|
11357
11440
|
* Gamification service.
|
|
11358
11441
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
11359
|
-
* @version
|
|
11442
|
+
* @version 185.0.0
|
|
11360
11443
|
*/ /**
|
|
11361
11444
|
* Constructs a new GamificationApi.
|
|
11362
11445
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -11896,7 +11979,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11896
11979
|
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(){/**
|
|
11897
11980
|
* GeneralDataProtectionRegulation service.
|
|
11898
11981
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
11899
|
-
* @version
|
|
11982
|
+
* @version 185.0.0
|
|
11900
11983
|
*/ /**
|
|
11901
11984
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
11902
11985
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -11931,7 +12014,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
11931
12014
|
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(){/**
|
|
11932
12015
|
* Geolocation service.
|
|
11933
12016
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
11934
|
-
* @version
|
|
12017
|
+
* @version 185.0.0
|
|
11935
12018
|
*/ /**
|
|
11936
12019
|
* Constructs a new GeolocationApi.
|
|
11937
12020
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -11965,7 +12048,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
11965
12048
|
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(){/**
|
|
11966
12049
|
* Greetings service.
|
|
11967
12050
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
11968
|
-
* @version
|
|
12051
|
+
* @version 185.0.0
|
|
11969
12052
|
*/ /**
|
|
11970
12053
|
* Constructs a new GreetingsApi.
|
|
11971
12054
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -12072,7 +12155,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
12072
12155
|
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(){/**
|
|
12073
12156
|
* Groups service.
|
|
12074
12157
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
12075
|
-
* @version
|
|
12158
|
+
* @version 185.0.0
|
|
12076
12159
|
*/ /**
|
|
12077
12160
|
* Constructs a new GroupsApi.
|
|
12078
12161
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -12205,7 +12288,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
12205
12288
|
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(){/**
|
|
12206
12289
|
* IdentityProvider service.
|
|
12207
12290
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
12208
|
-
* @version
|
|
12291
|
+
* @version 185.0.0
|
|
12209
12292
|
*/ /**
|
|
12210
12293
|
* Constructs a new IdentityProviderApi.
|
|
12211
12294
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -12339,7 +12422,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12339
12422
|
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(){/**
|
|
12340
12423
|
* InfrastructureAsCode service.
|
|
12341
12424
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
12342
|
-
* @version
|
|
12425
|
+
* @version 185.0.0
|
|
12343
12426
|
*/ /**
|
|
12344
12427
|
* Constructs a new InfrastructureAsCodeApi.
|
|
12345
12428
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -12393,7 +12476,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
12393
12476
|
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(){/**
|
|
12394
12477
|
* Integrations service.
|
|
12395
12478
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
12396
|
-
* @version
|
|
12479
|
+
* @version 185.0.0
|
|
12397
12480
|
*/ /**
|
|
12398
12481
|
* Constructs a new IntegrationsApi.
|
|
12399
12482
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -12914,7 +12997,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
12914
12997
|
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(){/**
|
|
12915
12998
|
* Journey service.
|
|
12916
12999
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
12917
|
-
* @version
|
|
13000
|
+
* @version 185.0.0
|
|
12918
13001
|
*/ /**
|
|
12919
13002
|
* Constructs a new JourneyApi.
|
|
12920
13003
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -13218,7 +13301,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
13218
13301
|
*/},{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(){/**
|
|
13219
13302
|
* Knowledge service.
|
|
13220
13303
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
13221
|
-
* @version
|
|
13304
|
+
* @version 185.0.0
|
|
13222
13305
|
*/ /**
|
|
13223
13306
|
* Constructs a new KnowledgeApi.
|
|
13224
13307
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -14015,7 +14098,7 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
14015
14098
|
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(){/**
|
|
14016
14099
|
* LanguageUnderstanding service.
|
|
14017
14100
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
14018
|
-
* @version
|
|
14101
|
+
* @version 185.0.0
|
|
14019
14102
|
*/ /**
|
|
14020
14103
|
* Constructs a new LanguageUnderstandingApi.
|
|
14021
14104
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -14271,7 +14354,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
14271
14354
|
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(){/**
|
|
14272
14355
|
* Languages service.
|
|
14273
14356
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
14274
|
-
* @version
|
|
14357
|
+
* @version 185.0.0
|
|
14275
14358
|
*/ /**
|
|
14276
14359
|
* Constructs a new LanguagesApi.
|
|
14277
14360
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -14326,7 +14409,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
14326
14409
|
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(){/**
|
|
14327
14410
|
* Learning service.
|
|
14328
14411
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
14329
|
-
* @version
|
|
14412
|
+
* @version 185.0.0
|
|
14330
14413
|
*/ /**
|
|
14331
14414
|
* Constructs a new LearningApi.
|
|
14332
14415
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -14556,7 +14639,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
14556
14639
|
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(){/**
|
|
14557
14640
|
* License service.
|
|
14558
14641
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
14559
|
-
* @version
|
|
14642
|
+
* @version 185.0.0
|
|
14560
14643
|
*/ /**
|
|
14561
14644
|
* Constructs a new LicenseApi.
|
|
14562
14645
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -14610,7 +14693,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
14610
14693
|
*/},{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(){/**
|
|
14611
14694
|
* Locations service.
|
|
14612
14695
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
14613
|
-
* @version
|
|
14696
|
+
* @version 185.0.0
|
|
14614
14697
|
*/ /**
|
|
14615
14698
|
* Constructs a new LocationsApi.
|
|
14616
14699
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -14666,10 +14749,30 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14666
14749
|
*
|
|
14667
14750
|
* @param {Object} body Search request options
|
|
14668
14751
|
*/},{key:"postLocationsSearch",value:function postLocationsSearch(body){// verify the required parameter 'body' is set
|
|
14669
|
-
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
|
|
14752
|
+
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(){/**
|
|
14753
|
+
* LogCapture service.
|
|
14754
|
+
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
14755
|
+
* @version 185.0.0
|
|
14756
|
+
*/ /**
|
|
14757
|
+
* Constructs a new LogCaptureApi.
|
|
14758
|
+
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
14759
|
+
* @class
|
|
14760
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
14761
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
14762
|
+
*/function LogCaptureApi(apiClient){_classCallCheck(this,LogCaptureApi);this.apiClient=apiClient||ApiClient.instance;}/**
|
|
14763
|
+
* Gets status of async download execution
|
|
14764
|
+
*
|
|
14765
|
+
* @param {String} jobId Job ID
|
|
14766
|
+
*/_createClass(LogCaptureApi,[{key:"getDiagnosticsLogcaptureBrowserEntriesDownloadJob",value:function getDiagnosticsLogcaptureBrowserEntriesDownloadJob(jobId){// verify the required parameter 'jobId' is set
|
|
14767
|
+
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']);}/**
|
|
14768
|
+
* Creates an async download execution
|
|
14769
|
+
*
|
|
14770
|
+
* @param {Object} opts Optional parameters
|
|
14771
|
+
* @param {Object} opts.body
|
|
14772
|
+
*/},{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(){/**
|
|
14670
14773
|
* Messaging service.
|
|
14671
14774
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
14672
|
-
* @version
|
|
14775
|
+
* @version 185.0.0
|
|
14673
14776
|
*/ /**
|
|
14674
14777
|
* Constructs a new MessagingApi.
|
|
14675
14778
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -14759,7 +14862,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14759
14862
|
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(){/**
|
|
14760
14863
|
* MobileDevices service.
|
|
14761
14864
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
14762
|
-
* @version
|
|
14865
|
+
* @version 185.0.0
|
|
14763
14866
|
*/ /**
|
|
14764
14867
|
* Constructs a new MobileDevicesApi.
|
|
14765
14868
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -14798,7 +14901,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14798
14901
|
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(){/**
|
|
14799
14902
|
* Notifications service.
|
|
14800
14903
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
14801
|
-
* @version
|
|
14904
|
+
* @version 185.0.0
|
|
14802
14905
|
*/ /**
|
|
14803
14906
|
* Constructs a new NotificationsApi.
|
|
14804
14907
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -14855,7 +14958,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
14855
14958
|
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(){/**
|
|
14856
14959
|
* OAuth service.
|
|
14857
14960
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
14858
|
-
* @version
|
|
14961
|
+
* @version 185.0.0
|
|
14859
14962
|
*/ /**
|
|
14860
14963
|
* Constructs a new OAuthApi.
|
|
14861
14964
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -14940,7 +15043,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
14940
15043
|
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(){/**
|
|
14941
15044
|
* Objects service.
|
|
14942
15045
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
14943
|
-
* @version
|
|
15046
|
+
* @version 185.0.0
|
|
14944
15047
|
*/ /**
|
|
14945
15048
|
* Constructs a new ObjectsApi.
|
|
14946
15049
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -14993,10 +15096,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14993
15096
|
* Recreate a previously deleted division.
|
|
14994
15097
|
*
|
|
14995
15098
|
* @param {String} divisionId Division ID
|
|
14996
|
-
* @param {Object}
|
|
14997
|
-
|
|
14998
|
-
|
|
14999
|
-
if(
|
|
15099
|
+
* @param {Object} opts Optional parameters
|
|
15100
|
+
* @param {Object} opts.body Recreated division data
|
|
15101
|
+
*/},{key:"postAuthorizationDivisionRestore",value:function postAuthorizationDivisionRestore(divisionId,opts){opts=opts||{};// verify the required parameter 'divisionId' is set
|
|
15102
|
+
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']);}/**
|
|
15000
15103
|
* Create a division.
|
|
15001
15104
|
*
|
|
15002
15105
|
* @param {Object} body Division
|
|
@@ -15011,7 +15114,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
15011
15114
|
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(){/**
|
|
15012
15115
|
* OperationalEvents service.
|
|
15013
15116
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
15014
|
-
* @version
|
|
15117
|
+
* @version 185.0.0
|
|
15015
15118
|
*/ /**
|
|
15016
15119
|
* Constructs a new OperationalEventsApi.
|
|
15017
15120
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -15029,7 +15132,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
15029
15132
|
*/},{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(){/**
|
|
15030
15133
|
* Organization service.
|
|
15031
15134
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
15032
|
-
* @version
|
|
15135
|
+
* @version 185.0.0
|
|
15033
15136
|
*/ /**
|
|
15034
15137
|
* Constructs a new OrganizationApi.
|
|
15035
15138
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -15131,7 +15234,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15131
15234
|
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(){/**
|
|
15132
15235
|
* OrganizationAuthorization service.
|
|
15133
15236
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
15134
|
-
* @version
|
|
15237
|
+
* @version 185.0.0
|
|
15135
15238
|
*/ /**
|
|
15136
15239
|
* Constructs a new OrganizationAuthorizationApi.
|
|
15137
15240
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -15454,7 +15557,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
15454
15557
|
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(){/**
|
|
15455
15558
|
* Outbound service.
|
|
15456
15559
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
15457
|
-
* @version
|
|
15560
|
+
* @version 185.0.0
|
|
15458
15561
|
*/ /**
|
|
15459
15562
|
* Constructs a new OutboundApi.
|
|
15460
15563
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -15521,6 +15624,16 @@ if(contactListFilterId===undefined||contactListFilterId===null){throw'Missing th
|
|
|
15521
15624
|
* @param {Array.<String>} id contact list id(s) to delete
|
|
15522
15625
|
*/},{key:"deleteOutboundContactlists",value:function deleteOutboundContactlists(id){// verify the required parameter 'id' is set
|
|
15523
15626
|
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']);}/**
|
|
15627
|
+
* Delete Contact List Template
|
|
15628
|
+
*
|
|
15629
|
+
* @param {String} contactListTemplateId ContactListTemplate ID
|
|
15630
|
+
*/},{key:"deleteOutboundContactlisttemplate",value:function deleteOutboundContactlisttemplate(contactListTemplateId){// verify the required parameter 'contactListTemplateId' is set
|
|
15631
|
+
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']);}/**
|
|
15632
|
+
* Delete multiple contact list templates.
|
|
15633
|
+
*
|
|
15634
|
+
* @param {Array.<String>} id contact list template id(s) to delete
|
|
15635
|
+
*/},{key:"deleteOutboundContactlisttemplates",value:function deleteOutboundContactlisttemplates(id){// verify the required parameter 'id' is set
|
|
15636
|
+
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']);}/**
|
|
15524
15637
|
* Delete an Outbound Digital Rule Set
|
|
15525
15638
|
*
|
|
15526
15639
|
* @param {String} digitalRuleSetId The Digital Rule Set ID
|
|
@@ -15552,6 +15665,16 @@ if(dncListId===undefined||dncListId===null){throw'Missing the required parameter
|
|
|
15552
15665
|
* @param {Boolean} opts.expiredOnly Set to true to only remove DNC entries that are expired (default to false)
|
|
15553
15666
|
*/},{key:"deleteOutboundDnclistPhonenumbers",value:function deleteOutboundDnclistPhonenumbers(dncListId,opts){opts=opts||{};// verify the required parameter 'dncListId' is set
|
|
15554
15667
|
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']);}/**
|
|
15668
|
+
* Delete Import Template
|
|
15669
|
+
*
|
|
15670
|
+
* @param {String} importTemplateId Import Template ID
|
|
15671
|
+
*/},{key:"deleteOutboundImporttemplate",value:function deleteOutboundImporttemplate(importTemplateId){// verify the required parameter 'importTemplateId' is set
|
|
15672
|
+
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']);}/**
|
|
15673
|
+
* Delete multiple import templates.
|
|
15674
|
+
*
|
|
15675
|
+
* @param {Array.<String>} id import template id(s) to delete
|
|
15676
|
+
*/},{key:"deleteOutboundImporttemplates",value:function deleteOutboundImporttemplates(id){// verify the required parameter 'id' is set
|
|
15677
|
+
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']);}/**
|
|
15555
15678
|
* Delete an Outbound Messaging Campaign
|
|
15556
15679
|
*
|
|
15557
15680
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
@@ -15826,6 +15949,22 @@ if(contactListId===undefined||contactListId===null){throw'Missing the required p
|
|
|
15826
15949
|
* @param {String} opts.sortBy Sort by
|
|
15827
15950
|
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
15828
15951
|
*/},{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']);}/**
|
|
15952
|
+
* Get Contact List Template
|
|
15953
|
+
*
|
|
15954
|
+
* @param {String} contactListTemplateId ContactListTemplate ID
|
|
15955
|
+
*/},{key:"getOutboundContactlisttemplate",value:function getOutboundContactlisttemplate(contactListTemplateId){// verify the required parameter 'contactListTemplateId' is set
|
|
15956
|
+
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']);}/**
|
|
15957
|
+
* Query a list of contact list templates
|
|
15958
|
+
*
|
|
15959
|
+
* @param {Object} opts Optional parameters
|
|
15960
|
+
* @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
|
|
15961
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
15962
|
+
* @param {Boolean} opts.allowEmptyResult Whether to return an empty page when there are no results for that page (default to false)
|
|
15963
|
+
* @param {Object} opts.filterType Filter type (default to Prefix)
|
|
15964
|
+
* @param {String} opts.name Name
|
|
15965
|
+
* @param {String} opts.sortBy Sort by
|
|
15966
|
+
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
15967
|
+
*/},{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']);}/**
|
|
15829
15968
|
* Get an Outbound Digital Rule Set
|
|
15830
15969
|
*
|
|
15831
15970
|
* @param {String} digitalRuleSetId The Digital Rule Set ID
|
|
@@ -15914,6 +16053,30 @@ if(eventId===undefined||eventId===null){throw'Missing the required parameter "ev
|
|
|
15914
16053
|
* @param {String} opts.sortBy Sort by
|
|
15915
16054
|
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
15916
16055
|
*/},{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']);}/**
|
|
16056
|
+
* Get Import Template
|
|
16057
|
+
*
|
|
16058
|
+
* @param {String} importTemplateId Import Template ID
|
|
16059
|
+
*/},{key:"getOutboundImporttemplate",value:function getOutboundImporttemplate(importTemplateId){// verify the required parameter 'importTemplateId' is set
|
|
16060
|
+
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']);}/**
|
|
16061
|
+
* Get the import status for an import template.
|
|
16062
|
+
*
|
|
16063
|
+
* @param {String} importTemplateId importTemplateId
|
|
16064
|
+
* @param {Object} opts Optional parameters
|
|
16065
|
+
* @param {String} opts.listNamePrefix listNamePrefix
|
|
16066
|
+
*/},{key:"getOutboundImporttemplateImportstatus",value:function getOutboundImporttemplateImportstatus(importTemplateId,opts){opts=opts||{};// verify the required parameter 'importTemplateId' is set
|
|
16067
|
+
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']);}/**
|
|
16068
|
+
* Query Import Templates
|
|
16069
|
+
*
|
|
16070
|
+
* @param {Object} opts Optional parameters
|
|
16071
|
+
* @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
|
|
16072
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
16073
|
+
* @param {Boolean} opts.allowEmptyResult Whether to return an empty page when there are no results for that page (default to false)
|
|
16074
|
+
* @param {Object} opts.filterType Filter type (default to Prefix)
|
|
16075
|
+
* @param {String} opts.name Name
|
|
16076
|
+
* @param {String} opts.sortBy Sort by
|
|
16077
|
+
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
16078
|
+
* @param {String} opts.contactListTemplateId Contact List Template ID
|
|
16079
|
+
*/},{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']);}/**
|
|
15917
16080
|
* Get an Outbound Messaging Campaign
|
|
15918
16081
|
*
|
|
15919
16082
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
@@ -16152,6 +16315,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16152
16315
|
* @param {Object} body ContactList
|
|
16153
16316
|
*/},{key:"postOutboundContactlists",value:function postOutboundContactlists(body){// verify the required parameter 'body' is set
|
|
16154
16317
|
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']);}/**
|
|
16318
|
+
* Create Contact List Template
|
|
16319
|
+
*
|
|
16320
|
+
* @param {Object} body ContactListTemplate
|
|
16321
|
+
*/},{key:"postOutboundContactlisttemplates",value:function postOutboundContactlisttemplates(body){// verify the required parameter 'body' is set
|
|
16322
|
+
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']);}/**
|
|
16323
|
+
* Add multiple contact list templates
|
|
16324
|
+
*
|
|
16325
|
+
* @param {Array.<Object>} body contact list template(s) to add
|
|
16326
|
+
*/},{key:"postOutboundContactlisttemplatesBulkAdd",value:function postOutboundContactlisttemplatesBulkAdd(body){// verify the required parameter 'body' is set
|
|
16327
|
+
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']);}/**
|
|
16155
16328
|
* Add phone numbers to a Dialer DNC list.
|
|
16156
16329
|
*
|
|
16157
16330
|
* @param {String} conversationId Conversation ID
|
|
@@ -16188,6 +16361,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16188
16361
|
* @param {Object} body DncList
|
|
16189
16362
|
*/},{key:"postOutboundDnclists",value:function postOutboundDnclists(body){// verify the required parameter 'body' is set
|
|
16190
16363
|
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']);}/**
|
|
16364
|
+
* Create Import Template
|
|
16365
|
+
*
|
|
16366
|
+
* @param {Object} body ImportTemplate
|
|
16367
|
+
*/},{key:"postOutboundImporttemplates",value:function postOutboundImporttemplates(body){// verify the required parameter 'body' is set
|
|
16368
|
+
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']);}/**
|
|
16369
|
+
* Add multiple import templates
|
|
16370
|
+
*
|
|
16371
|
+
* @param {Array.<Object>} body import template(s) to add
|
|
16372
|
+
*/},{key:"postOutboundImporttemplatesBulkAdd",value:function postOutboundImporttemplatesBulkAdd(body){// verify the required parameter 'body' is set
|
|
16373
|
+
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']);}/**
|
|
16191
16374
|
* Create a Messaging Campaign
|
|
16192
16375
|
*
|
|
16193
16376
|
* @param {Object} body Messaging Campaign
|
|
@@ -16275,6 +16458,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16275
16458
|
*/},{key:"putOutboundContactlistfilter",value:function putOutboundContactlistfilter(contactListFilterId,body){// verify the required parameter 'contactListFilterId' is set
|
|
16276
16459
|
if(contactListFilterId===undefined||contactListFilterId===null){throw'Missing the required parameter "contactListFilterId" when calling putOutboundContactlistfilter';}// verify the required parameter 'body' is set
|
|
16277
16460
|
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']);}/**
|
|
16461
|
+
* Update a contact list template.
|
|
16462
|
+
*
|
|
16463
|
+
* @param {String} contactListTemplateId ContactListTemplate ID
|
|
16464
|
+
* @param {Object} body ContactListTemplate
|
|
16465
|
+
*/},{key:"putOutboundContactlisttemplate",value:function putOutboundContactlisttemplate(contactListTemplateId,body){// verify the required parameter 'contactListTemplateId' is set
|
|
16466
|
+
if(contactListTemplateId===undefined||contactListTemplateId===null){throw'Missing the required parameter "contactListTemplateId" when calling putOutboundContactlisttemplate';}// verify the required parameter 'body' is set
|
|
16467
|
+
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']);}/**
|
|
16278
16468
|
* Update an Outbound Digital Rule Set
|
|
16279
16469
|
*
|
|
16280
16470
|
* @param {String} digitalRuleSetId The Digital Rule Set ID
|
|
@@ -16289,6 +16479,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16289
16479
|
*/},{key:"putOutboundDnclist",value:function putOutboundDnclist(dncListId,body){// verify the required parameter 'dncListId' is set
|
|
16290
16480
|
if(dncListId===undefined||dncListId===null){throw'Missing the required parameter "dncListId" when calling putOutboundDnclist';}// verify the required parameter 'body' is set
|
|
16291
16481
|
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']);}/**
|
|
16482
|
+
* Update Import Template
|
|
16483
|
+
*
|
|
16484
|
+
* @param {String} importTemplateId Import Template ID
|
|
16485
|
+
* @param {Object} body importTemplate
|
|
16486
|
+
*/},{key:"putOutboundImporttemplate",value:function putOutboundImporttemplate(importTemplateId,body){// verify the required parameter 'importTemplateId' is set
|
|
16487
|
+
if(importTemplateId===undefined||importTemplateId===null){throw'Missing the required parameter "importTemplateId" when calling putOutboundImporttemplate';}// verify the required parameter 'body' is set
|
|
16488
|
+
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']);}/**
|
|
16292
16489
|
* Update an Outbound Messaging Campaign
|
|
16293
16490
|
*
|
|
16294
16491
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
@@ -16345,7 +16542,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16345
16542
|
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(){/**
|
|
16346
16543
|
* Presence service.
|
|
16347
16544
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
16348
|
-
* @version
|
|
16545
|
+
* @version 185.0.0
|
|
16349
16546
|
*/ /**
|
|
16350
16547
|
* Constructs a new PresenceApi.
|
|
16351
16548
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -16513,7 +16710,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16513
16710
|
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(){/**
|
|
16514
16711
|
* ProcessAutomation service.
|
|
16515
16712
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
16516
|
-
* @version
|
|
16713
|
+
* @version 185.0.0
|
|
16517
16714
|
*/ /**
|
|
16518
16715
|
* Constructs a new ProcessAutomationApi.
|
|
16519
16716
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -16576,7 +16773,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
16576
16773
|
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(){/**
|
|
16577
16774
|
* Quality service.
|
|
16578
16775
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
16579
|
-
* @version
|
|
16776
|
+
* @version 185.0.0
|
|
16580
16777
|
*/ /**
|
|
16581
16778
|
* Constructs a new QualityApi.
|
|
16582
16779
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -17047,7 +17244,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
17047
17244
|
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(){/**
|
|
17048
17245
|
* Recording service.
|
|
17049
17246
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
17050
|
-
* @version
|
|
17247
|
+
* @version 185.0.0
|
|
17051
17248
|
*/ /**
|
|
17052
17249
|
* Constructs a new RecordingApi.
|
|
17053
17250
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -17454,7 +17651,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17454
17651
|
*/},{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(){/**
|
|
17455
17652
|
* ResponseManagement service.
|
|
17456
17653
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
17457
|
-
* @version
|
|
17654
|
+
* @version 185.0.0
|
|
17458
17655
|
*/ /**
|
|
17459
17656
|
* Constructs a new ResponseManagementApi.
|
|
17460
17657
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -17570,7 +17767,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
17570
17767
|
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(){/**
|
|
17571
17768
|
* Routing service.
|
|
17572
17769
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
17573
|
-
* @version
|
|
17770
|
+
* @version 185.0.0
|
|
17574
17771
|
*/ /**
|
|
17575
17772
|
* Constructs a new RoutingApi.
|
|
17576
17773
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -17670,6 +17867,14 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
17670
17867
|
* Delete the organization-wide max utilization settings and revert to the system default.
|
|
17671
17868
|
*
|
|
17672
17869
|
*/},{key:"deleteRoutingUtilization",value:function deleteRoutingUtilization(){return this.apiClient.callApi('/api/v2/routing/utilization','DELETE',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17870
|
+
* Delete a utilization label
|
|
17871
|
+
*
|
|
17872
|
+
* @param {String} labelId Utilization Label ID
|
|
17873
|
+
* @param {Object} opts Optional parameters
|
|
17874
|
+
* @param {Boolean} opts.forceDelete Remove all label usages (if found) without warning (default to false)
|
|
17875
|
+
* deleteRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17876
|
+
*/},{key:"deleteRoutingUtilizationLabel",value:function deleteRoutingUtilizationLabel(labelId,opts){opts=opts||{};// verify the required parameter 'labelId' is set
|
|
17877
|
+
if(labelId===undefined||labelId===null){throw'Missing the required parameter "labelId" when calling deleteRoutingUtilizationLabel';}return this.apiClient.callApi('/api/v2/routing/utilization/labels/{labelId}','DELETE',{'labelId':labelId},{'forceDelete':opts['forceDelete']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17673
17878
|
* Delete an utilization tag
|
|
17674
17879
|
*
|
|
17675
17880
|
* @param {String} tagId Utilization Tag ID
|
|
@@ -18053,6 +18258,27 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
18053
18258
|
* Get the organization-wide max utilization settings.
|
|
18054
18259
|
*
|
|
18055
18260
|
*/},{key:"getRoutingUtilization",value:function getRoutingUtilization(){return this.apiClient.callApi('/api/v2/routing/utilization','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18261
|
+
* Get details about this utilization label
|
|
18262
|
+
*
|
|
18263
|
+
* @param {String} labelId Utilization Label ID
|
|
18264
|
+
* getRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18265
|
+
*/},{key:"getRoutingUtilizationLabel",value:function getRoutingUtilizationLabel(labelId){// verify the required parameter 'labelId' is set
|
|
18266
|
+
if(labelId===undefined||labelId===null){throw'Missing the required parameter "labelId" when calling getRoutingUtilizationLabel';}return this.apiClient.callApi('/api/v2/routing/utilization/labels/{labelId}','GET',{'labelId':labelId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18267
|
+
* Get list of agent ids associated with a utilization label
|
|
18268
|
+
*
|
|
18269
|
+
* @param {String} labelId Utilization Label ID
|
|
18270
|
+
* getRoutingUtilizationLabelAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18271
|
+
*/},{key:"getRoutingUtilizationLabelAgents",value:function getRoutingUtilizationLabelAgents(labelId){// verify the required parameter 'labelId' is set
|
|
18272
|
+
if(labelId===undefined||labelId===null){throw'Missing the required parameter "labelId" when calling getRoutingUtilizationLabelAgents';}return this.apiClient.callApi('/api/v2/routing/utilization/labels/{labelId}/agents','GET',{'labelId':labelId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18273
|
+
* Get list of utilization labels
|
|
18274
|
+
*
|
|
18275
|
+
* @param {Object} opts Optional parameters
|
|
18276
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
18277
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
18278
|
+
* @param {Object} opts.sortOrder Sort order by name (default to ascending)
|
|
18279
|
+
* @param {String} opts.name Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*'
|
|
18280
|
+
* getRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18281
|
+
*/},{key:"getRoutingUtilizationLabels",value:function getRoutingUtilizationLabels(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/routing/utilization/labels','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortOrder':opts['sortOrder'],'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18056
18282
|
* Get details about this utilization tag
|
|
18057
18283
|
*
|
|
18058
18284
|
* @param {String} tagId Utilization Tag ID
|
|
@@ -18369,6 +18595,12 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18369
18595
|
* postRoutingSmsPhonenumbersImport is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18370
18596
|
*/},{key:"postRoutingSmsPhonenumbersImport",value:function postRoutingSmsPhonenumbersImport(body){// verify the required parameter 'body' is set
|
|
18371
18597
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postRoutingSmsPhonenumbersImport';}return this.apiClient.callApi('/api/v2/routing/sms/phonenumbers/import','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18598
|
+
* Create a utilization label
|
|
18599
|
+
*
|
|
18600
|
+
* @param {Object} body UtilizationLabel
|
|
18601
|
+
* postRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18602
|
+
*/},{key:"postRoutingUtilizationLabels",value:function postRoutingUtilizationLabels(body){// verify the required parameter 'body' is set
|
|
18603
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postRoutingUtilizationLabels';}return this.apiClient.callApi('/api/v2/routing/utilization/labels','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18372
18604
|
* Create an utilization tag
|
|
18373
18605
|
*
|
|
18374
18606
|
* @param {Object} body UtilizationTag
|
|
@@ -18451,6 +18683,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18451
18683
|
* @param {Object} body utilization
|
|
18452
18684
|
*/},{key:"putRoutingUtilization",value:function putRoutingUtilization(body){// verify the required parameter 'body' is set
|
|
18453
18685
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putRoutingUtilization';}return this.apiClient.callApi('/api/v2/routing/utilization','PUT',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18686
|
+
* Update a utilization label
|
|
18687
|
+
*
|
|
18688
|
+
* @param {String} labelId Utilization Label ID
|
|
18689
|
+
* @param {Object} body UtilizationLabel
|
|
18690
|
+
* putRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18691
|
+
*/},{key:"putRoutingUtilizationLabel",value:function putRoutingUtilizationLabel(labelId,body){// verify the required parameter 'labelId' is set
|
|
18692
|
+
if(labelId===undefined||labelId===null){throw'Missing the required parameter "labelId" when calling putRoutingUtilizationLabel';}// verify the required parameter 'body' is set
|
|
18693
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putRoutingUtilizationLabel';}return this.apiClient.callApi('/api/v2/routing/utilization/labels/{labelId}','PUT',{'labelId':labelId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18454
18694
|
* Update wrap-up code
|
|
18455
18695
|
*
|
|
18456
18696
|
* @param {String} codeId Wrapup Code ID
|
|
@@ -18476,7 +18716,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
18476
18716
|
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(){/**
|
|
18477
18717
|
* SCIM service.
|
|
18478
18718
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
18479
|
-
* @version
|
|
18719
|
+
* @version 185.0.0
|
|
18480
18720
|
*/ /**
|
|
18481
18721
|
* Constructs a new SCIMApi.
|
|
18482
18722
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -18701,7 +18941,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
18701
18941
|
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(){/**
|
|
18702
18942
|
* Scripts service.
|
|
18703
18943
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
18704
|
-
* @version
|
|
18944
|
+
* @version 185.0.0
|
|
18705
18945
|
*/ /**
|
|
18706
18946
|
* Constructs a new ScriptsApi.
|
|
18707
18947
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -18837,7 +19077,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
18837
19077
|
*/},{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(){/**
|
|
18838
19078
|
* Search service.
|
|
18839
19079
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
18840
|
-
* @version
|
|
19080
|
+
* @version 185.0.0
|
|
18841
19081
|
*/ /**
|
|
18842
19082
|
* Constructs a new SearchApi.
|
|
18843
19083
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -18997,7 +19237,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18997
19237
|
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(){/**
|
|
18998
19238
|
* Settings service.
|
|
18999
19239
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
19000
|
-
* @version
|
|
19240
|
+
* @version 185.0.0
|
|
19001
19241
|
*/ /**
|
|
19002
19242
|
* Constructs a new SettingsApi.
|
|
19003
19243
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -19015,7 +19255,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19015
19255
|
*/},{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(){/**
|
|
19016
19256
|
* SpeechTextAnalytics service.
|
|
19017
19257
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
19018
|
-
* @version
|
|
19258
|
+
* @version 185.0.0
|
|
19019
19259
|
*/ /**
|
|
19020
19260
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
19021
19261
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -19258,7 +19498,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
19258
19498
|
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(){/**
|
|
19259
19499
|
* Stations service.
|
|
19260
19500
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
19261
|
-
* @version
|
|
19501
|
+
* @version 185.0.0
|
|
19262
19502
|
*/ /**
|
|
19263
19503
|
* Constructs a new StationsApi.
|
|
19264
19504
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -19290,7 +19530,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
19290
19530
|
*/},{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(){/**
|
|
19291
19531
|
* Suggest service.
|
|
19292
19532
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
19293
|
-
* @version
|
|
19533
|
+
* @version 185.0.0
|
|
19294
19534
|
*/ /**
|
|
19295
19535
|
* Constructs a new SuggestApi.
|
|
19296
19536
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -19330,7 +19570,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19330
19570
|
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(){/**
|
|
19331
19571
|
* TaskManagement service.
|
|
19332
19572
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
19333
|
-
* @version
|
|
19573
|
+
* @version 185.0.0
|
|
19334
19574
|
*/ /**
|
|
19335
19575
|
* Constructs a new TaskManagementApi.
|
|
19336
19576
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -19672,7 +19912,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
19672
19912
|
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(){/**
|
|
19673
19913
|
* Teams service.
|
|
19674
19914
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
19675
|
-
* @version
|
|
19915
|
+
* @version 185.0.0
|
|
19676
19916
|
*/ /**
|
|
19677
19917
|
* Constructs a new TeamsApi.
|
|
19678
19918
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -19751,7 +19991,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19751
19991
|
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(){/**
|
|
19752
19992
|
* Telephony service.
|
|
19753
19993
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
19754
|
-
* @version
|
|
19994
|
+
* @version 185.0.0
|
|
19755
19995
|
*/ /**
|
|
19756
19996
|
* Constructs a new TelephonyApi.
|
|
19757
19997
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -19800,7 +20040,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
19800
20040
|
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(){/**
|
|
19801
20041
|
* TelephonyProvidersEdge service.
|
|
19802
20042
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
19803
|
-
* @version
|
|
20043
|
+
* @version 185.0.0
|
|
19804
20044
|
*/ /**
|
|
19805
20045
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
19806
20046
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -19978,8 +20218,9 @@ if(edgeId===undefined||edgeId===null){throw'Missing the required parameter "edge
|
|
|
19978
20218
|
* @param {Boolean} opts.managed Filter by managed
|
|
19979
20219
|
* @param {Boolean} opts.showCloudMedia True to show the cloud media devices in the result. (default to true)
|
|
19980
20220
|
*/},{key:"getTelephonyProvidersEdges",value:function getTelephonyProvidersEdges(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/telephony/providers/edges','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'name':opts['name'],'site.id':opts['siteId'],'edgeGroup.id':opts['edgeGroupId'],'sortBy':opts['sortBy'],'managed':opts['managed'],'showCloudMedia':opts['showCloudMedia']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19981
|
-
* Get the list of available languages.
|
|
20221
|
+
* Get the list of available languages. For never released keyword spotting feature. Deprecated, do not use.
|
|
19982
20222
|
*
|
|
20223
|
+
* @deprecated
|
|
19983
20224
|
*/},{key:"getTelephonyProvidersEdgesAvailablelanguages",value:function getTelephonyProvidersEdgesAvailablelanguages(){return this.apiClient.callApi('/api/v2/telephony/providers/edges/availablelanguages','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
19984
20225
|
* Get the list of certificate authorities.
|
|
19985
20226
|
*
|
|
@@ -20619,7 +20860,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
20619
20860
|
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(){/**
|
|
20620
20861
|
* Textbots service.
|
|
20621
20862
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
20622
|
-
* @version
|
|
20863
|
+
* @version 185.0.0
|
|
20623
20864
|
*/ /**
|
|
20624
20865
|
* Constructs a new TextbotsApi.
|
|
20625
20866
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -20654,7 +20895,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
20654
20895
|
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(){/**
|
|
20655
20896
|
* Tokens service.
|
|
20656
20897
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
20657
|
-
* @version
|
|
20898
|
+
* @version 185.0.0
|
|
20658
20899
|
*/ /**
|
|
20659
20900
|
* Constructs a new TokensApi.
|
|
20660
20901
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -20690,7 +20931,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
20690
20931
|
*/},{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(){/**
|
|
20691
20932
|
* Uploads service.
|
|
20692
20933
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
20693
|
-
* @version
|
|
20934
|
+
* @version 185.0.0
|
|
20694
20935
|
*/ /**
|
|
20695
20936
|
* Constructs a new UploadsApi.
|
|
20696
20937
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -20732,7 +20973,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20732
20973
|
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(){/**
|
|
20733
20974
|
* Usage service.
|
|
20734
20975
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
20735
|
-
* @version
|
|
20976
|
+
* @version 185.0.0
|
|
20736
20977
|
*/ /**
|
|
20737
20978
|
* Constructs a new UsageApi.
|
|
20738
20979
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -20783,7 +21024,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20783
21024
|
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(){/**
|
|
20784
21025
|
* UserRecordings service.
|
|
20785
21026
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
20786
|
-
* @version
|
|
21027
|
+
* @version 185.0.0
|
|
20787
21028
|
*/ /**
|
|
20788
21029
|
* Constructs a new UserRecordingsApi.
|
|
20789
21030
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -20832,7 +21073,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
20832
21073
|
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(){/**
|
|
20833
21074
|
* Users service.
|
|
20834
21075
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
20835
|
-
* @version
|
|
21076
|
+
* @version 185.0.0
|
|
20836
21077
|
*/ /**
|
|
20837
21078
|
* Constructs a new UsersApi.
|
|
20838
21079
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -21491,7 +21732,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
21491
21732
|
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(){/**
|
|
21492
21733
|
* Utilities service.
|
|
21493
21734
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
21494
|
-
* @version
|
|
21735
|
+
* @version 185.0.0
|
|
21495
21736
|
*/ /**
|
|
21496
21737
|
* Constructs a new UtilitiesApi.
|
|
21497
21738
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -21518,7 +21759,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21518
21759
|
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(){/**
|
|
21519
21760
|
* Voicemail service.
|
|
21520
21761
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
21521
|
-
* @version
|
|
21762
|
+
* @version 185.0.0
|
|
21522
21763
|
*/ /**
|
|
21523
21764
|
* Constructs a new VoicemailApi.
|
|
21524
21765
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -21667,7 +21908,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
21667
21908
|
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(){/**
|
|
21668
21909
|
* WebChat service.
|
|
21669
21910
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
21670
|
-
* @version
|
|
21911
|
+
* @version 185.0.0
|
|
21671
21912
|
*/ /**
|
|
21672
21913
|
* Constructs a new WebChatApi.
|
|
21673
21914
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -21800,7 +22041,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21800
22041
|
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(){/**
|
|
21801
22042
|
* WebDeployments service.
|
|
21802
22043
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
21803
|
-
* @version
|
|
22044
|
+
* @version 185.0.0
|
|
21804
22045
|
*/ /**
|
|
21805
22046
|
* Constructs a new WebDeploymentsApi.
|
|
21806
22047
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -21921,7 +22162,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
21921
22162
|
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(){/**
|
|
21922
22163
|
* WebMessaging service.
|
|
21923
22164
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
21924
|
-
* @version
|
|
22165
|
+
* @version 185.0.0
|
|
21925
22166
|
*/ /**
|
|
21926
22167
|
* Constructs a new WebMessagingApi.
|
|
21927
22168
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -21937,7 +22178,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
21937
22178
|
*/_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(){/**
|
|
21938
22179
|
* Widgets service.
|
|
21939
22180
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
21940
|
-
* @version
|
|
22181
|
+
* @version 185.0.0
|
|
21941
22182
|
*/ /**
|
|
21942
22183
|
* Constructs a new WidgetsApi.
|
|
21943
22184
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -21972,7 +22213,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
21972
22213
|
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(){/**
|
|
21973
22214
|
* WorkforceManagement service.
|
|
21974
22215
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
21975
|
-
* @version
|
|
22216
|
+
* @version 185.0.0
|
|
21976
22217
|
*/ /**
|
|
21977
22218
|
* Constructs a new WorkforceManagementApi.
|
|
21978
22219
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -22241,6 +22482,26 @@ if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required
|
|
|
22241
22482
|
if(weekId===undefined||weekId===null){throw'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent';}// verify the required parameter 'scheduleId' is set
|
|
22242
22483
|
if(scheduleId===undefined||scheduleId===null){throw'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent';}// verify the required parameter 'agentId' is set
|
|
22243
22484
|
if(agentId===undefined||agentId===null){throw'Missing the required parameter "agentId" when calling getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/history/agents/{agentId}','GET',{'businessUnitId':businessUnitId,'weekId':weekId,'scheduleId':scheduleId,'agentId':agentId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22485
|
+
* Get the performance prediction for the associated schedule
|
|
22486
|
+
*
|
|
22487
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
22488
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
22489
|
+
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
22490
|
+
*/},{key:"getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions",value:function getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions(businessUnitId,weekId,scheduleId){// verify the required parameter 'businessUnitId' is set
|
|
22491
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';}// verify the required parameter 'weekId' is set
|
|
22492
|
+
if(weekId===undefined||weekId===null){throw'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';}// verify the required parameter 'scheduleId' is set
|
|
22493
|
+
if(scheduleId===undefined||scheduleId===null){throw'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions','GET',{'businessUnitId':businessUnitId,'weekId':weekId,'scheduleId':scheduleId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22494
|
+
* Get recalculated performance prediction result
|
|
22495
|
+
*
|
|
22496
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
22497
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
22498
|
+
* @param {String} scheduleId The ID of the schedule the recalculation belongs to
|
|
22499
|
+
* @param {String} recalculationId The ID of the recalculation request
|
|
22500
|
+
*/},{key:"getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation",value:function getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation(businessUnitId,weekId,scheduleId,recalculationId){// verify the required parameter 'businessUnitId' is set
|
|
22501
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';}// verify the required parameter 'weekId' is set
|
|
22502
|
+
if(weekId===undefined||weekId===null){throw'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';}// verify the required parameter 'scheduleId' is set
|
|
22503
|
+
if(scheduleId===undefined||scheduleId===null){throw'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';}// verify the required parameter 'recalculationId' is set
|
|
22504
|
+
if(recalculationId===undefined||recalculationId===null){throw'Missing the required parameter "recalculationId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/{recalculationId}','GET',{'businessUnitId':businessUnitId,'weekId':weekId,'scheduleId':scheduleId,'recalculationId':recalculationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22244
22505
|
* Get the list of week schedules for the specified week
|
|
22245
22506
|
* Use "recent" (without quotes) for the `weekId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any schedule which spans the specified week
|
|
22246
22507
|
* @param {String} businessUnitId The ID of the business unit
|
|
@@ -22303,6 +22564,17 @@ if(forecastId===undefined||forecastId===null){throw'Missing the required paramet
|
|
|
22303
22564
|
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups';}// verify the required parameter 'weekDateId' is set
|
|
22304
22565
|
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups';}// verify the required parameter 'forecastId' is set
|
|
22305
22566
|
if(forecastId===undefined||forecastId===null){throw'Missing the required parameter "forecastId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/planninggroups','GET',{'businessUnitId':businessUnitId,'weekDateId':weekDateId,'forecastId':forecastId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22567
|
+
* Get the staffing requirement by planning group for a forecast
|
|
22568
|
+
*
|
|
22569
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
22570
|
+
* @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
22571
|
+
* @param {String} forecastId The ID of the forecast
|
|
22572
|
+
* @param {Object} opts Optional parameters
|
|
22573
|
+
* @param {Array.<String>} opts.weekNumbers The week numbers to fetch (for multi-week forecasts) staffing requirements. Returns all week data if the list is not specified
|
|
22574
|
+
*/},{key:"getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement",value:function getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement(businessUnitId,weekDateId,forecastId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
22575
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';}// verify the required parameter 'weekDateId' is set
|
|
22576
|
+
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';}// verify the required parameter 'forecastId' is set
|
|
22577
|
+
if(forecastId===undefined||forecastId===null){throw'Missing the required parameter "forecastId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/staffingrequirement','GET',{'businessUnitId':businessUnitId,'weekDateId':weekDateId,'forecastId':forecastId},{'weekNumbers':this.apiClient.buildCollectionParam(opts['weekNumbers'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22306
22578
|
* Get short term forecasts
|
|
22307
22579
|
* Use "recent" (without quotes) for the `weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any forecast which spans the specified week
|
|
22308
22580
|
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
@@ -22619,6 +22891,13 @@ if(serviceGoalTemplateId===undefined||serviceGoalTemplateId===null){throw'Missin
|
|
|
22619
22891
|
* @param {Object} opts.body body
|
|
22620
22892
|
*/},{key:"patchWorkforcemanagementManagementunit",value:function patchWorkforcemanagementManagementunit(managementUnitId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
22621
22893
|
if(managementUnitId===undefined||managementUnitId===null){throw'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunit';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}','PATCH',{'managementUnitId':managementUnitId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22894
|
+
* Update agent configurations
|
|
22895
|
+
*
|
|
22896
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
22897
|
+
* @param {Object} opts Optional parameters
|
|
22898
|
+
* @param {Object} opts.body body
|
|
22899
|
+
*/},{key:"patchWorkforcemanagementManagementunitAgents",value:function patchWorkforcemanagementManagementunitAgents(managementUnitId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
22900
|
+
if(managementUnitId===undefined||managementUnitId===null){throw'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitAgents';}return this.apiClient.callApi('/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents','PATCH',{'managementUnitId':managementUnitId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22622
22901
|
* Updates a time off limit object.
|
|
22623
22902
|
* Updates time off limit object properties, but not daily values.
|
|
22624
22903
|
* @param {String} managementUnitId The ID of the management unit.
|
|
@@ -22830,6 +23109,28 @@ if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required
|
|
|
22830
23109
|
if(weekId===undefined||weekId===null){throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekScheduleCopy';}// verify the required parameter 'scheduleId' is set
|
|
22831
23110
|
if(scheduleId===undefined||scheduleId===null){throw'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekScheduleCopy';}// verify the required parameter 'body' is set
|
|
22832
23111
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekScheduleCopy';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy','POST',{'businessUnitId':businessUnitId,'weekId':weekId,'scheduleId':scheduleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23112
|
+
* Request a daily recalculation of the performance prediction for the associated schedule
|
|
23113
|
+
*
|
|
23114
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
23115
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
23116
|
+
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
23117
|
+
* @param {Object} opts Optional parameters
|
|
23118
|
+
* @param {Object} opts.body body
|
|
23119
|
+
*/},{key:"postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations",value:function postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations(businessUnitId,weekId,scheduleId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23120
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';}// verify the required parameter 'weekId' is set
|
|
23121
|
+
if(weekId===undefined||weekId===null){throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';}// verify the required parameter 'scheduleId' is set
|
|
23122
|
+
if(scheduleId===undefined||scheduleId===null){throw'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations','POST',{'businessUnitId':businessUnitId,'weekId':weekId,'scheduleId':scheduleId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
23123
|
+
* Upload daily activity changes to be able to request a performance prediction recalculation
|
|
23124
|
+
*
|
|
23125
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
23126
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
23127
|
+
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
23128
|
+
* @param {Object} opts Optional parameters
|
|
23129
|
+
* @param {Object} opts.body body
|
|
23130
|
+
*/},{key:"postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl",value:function postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl(businessUnitId,weekId,scheduleId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23131
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';}// verify the required parameter 'weekId' is set
|
|
23132
|
+
if(weekId===undefined||weekId===null){throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';}// verify the required parameter 'scheduleId' is set
|
|
23133
|
+
if(scheduleId===undefined||scheduleId===null){throw'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';}return this.apiClient.callApi('/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/uploadurl','POST',{'businessUnitId':businessUnitId,'weekId':weekId,'scheduleId':scheduleId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
22833
23134
|
* Start a rescheduling run
|
|
22834
23135
|
*
|
|
22835
23136
|
* @param {String} businessUnitId The ID of the business unit
|
|
@@ -23263,7 +23564,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
23263
23564
|
* </pre>
|
|
23264
23565
|
* </p>
|
|
23265
23566
|
* @module purecloud-platform-client-v2/index
|
|
23266
|
-
* @version
|
|
23567
|
+
* @version 185.0.0
|
|
23267
23568
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
23268
23569
|
* The ApiClient constructor.
|
|
23269
23570
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|
|
@@ -23370,6 +23671,9 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
23370
23671
|
* The LocationsApi service constructor.
|
|
23371
23672
|
* @property {module:purecloud-platform-client-v2/api/LocationsApi}
|
|
23372
23673
|
*/this.LocationsApi=LocationsApi;/**
|
|
23674
|
+
* The LogCaptureApi service constructor.
|
|
23675
|
+
* @property {module:purecloud-platform-client-v2/api/LogCaptureApi}
|
|
23676
|
+
*/this.LogCaptureApi=LogCaptureApi;/**
|
|
23373
23677
|
* The MessagingApi service constructor.
|
|
23374
23678
|
* @property {module:purecloud-platform-client-v2/api/MessagingApi}
|
|
23375
23679
|
*/this.MessagingApi=MessagingApi;/**
|