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
package/dist/web-cjs/bundle.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
'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(
|
|
1
|
+
'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)
|
|
2
2
|
// if there are two placeholders, than the two characters before it
|
|
3
3
|
// represent one byte
|
|
4
4
|
// if there is only one, then the three characters before it represent 2 bytes
|
|
@@ -845,7 +845,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
845
845
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
846
846
|
if(this.environment.startsWith('https://'))this.environment=this.environment.substring(8);if(this.environment.startsWith('http://'))this.environment=this.environment.substring(7);if(this.environment.startsWith('api.'))this.environment=this.environment.substring(4);this.basePath="https://api.".concat(this.environment);this.authUrl="https://login.".concat(this.environment);}},{key:"getConfigString",value:function getConfigString(section,key){if(this.config._sections[section])return this.config._sections[section][key];}},{key:"getConfigBoolean",value:function getConfigBoolean(section,key){if(this.config._sections[section]&&this.config._sections[section][key]!==undefined){if(typeof this.config._sections[section][key]==='string'){return this.config._sections[section][key]==='true';}else return this.config._sections[section][key];}}},{key:"getConfigInt",value:function getConfigInt(section,key){if(this.config._sections[section]&&this.config._sections[section][key]){if(typeof this.config._sections[section][key]==='string'){return parseInt(this.config._sections[section][key]);}else return this.config._sections[section][key];}}}]);return Configuration;}();/**
|
|
847
847
|
* @module purecloud-platform-client-v2/ApiClient
|
|
848
|
-
* @version
|
|
848
|
+
* @version 185.0.0
|
|
849
849
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
850
850
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
851
851
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -947,47 +947,104 @@ _this3.config.logger.log('trace',response.status,'POST',"https://login.".concat(
|
|
|
947
947
|
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
|
|
948
948
|
resolve(_this3.authData);})["catch"](function(error){// Log error
|
|
949
949
|
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);});});}/**
|
|
950
|
+
* @description Completes the PKCE Code Authorization.
|
|
951
|
+
* @param {string} clientId - The client ID of an OAuth Code Authorization Grant client
|
|
952
|
+
* @param {string} codeVerifier - code verifier used to generate the code challenge
|
|
953
|
+
* @param {string} authCode - Authorization code
|
|
954
|
+
* @param {string} redirectUri - Authorized redirect URI for your Code Authorization client
|
|
955
|
+
*/},{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
|
|
956
|
+
request.then(function(response){// Logging
|
|
957
|
+
_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
|
|
958
|
+
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
|
|
959
|
+
resolve(_this4.authData);})["catch"](function(error){// Log error
|
|
960
|
+
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);});});}/**
|
|
961
|
+
* @description Generate a random string used as PKCE Code Verifier - length = 43 to 128.
|
|
962
|
+
* @param {number} nChar - code length
|
|
963
|
+
*/},{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
|
|
964
|
+
{var unreservedCharacters="0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-._~";var randomString=Array.from(crypto.getRandomValues(new Uint32Array(nChar))).map(function(x){return unreservedCharacters[x%unreservedCharacters.length];}).join('');return randomString;}}/**
|
|
965
|
+
* @description Compute Base64Url PKCE Code Challenge from Code Verifier.
|
|
966
|
+
* @param {string} code - code verifier used to generate the code challenge
|
|
967
|
+
*/},{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
|
|
968
|
+
{// browser
|
|
969
|
+
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
|
|
970
|
+
return reject(new Error("Code Challenge Error ".concat(error)));});});}}/**
|
|
971
|
+
* @description Initiates the pkce auth code grant login flow. Will attempt to load the token from local storage, if enabled.
|
|
972
|
+
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
973
|
+
* @param {string} redirectUri - The redirect URI of the OAuth Implicit Grant client
|
|
974
|
+
* @param {object} opts - (optional) Additional options
|
|
975
|
+
* @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.
|
|
976
|
+
* @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.
|
|
977
|
+
* @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.
|
|
978
|
+
* @param {string} codeVerifier - (optional) code verifier used to generate the code challenge
|
|
979
|
+
*/},{key:"loginPKCEGrant",value:function loginPKCEGrant(clientId,redirectUri,opts,codeVerifier){var _this5=this;// Need Local Storage or non null codeVerifier as parameter
|
|
980
|
+
if(!this.hasLocalStorage&&!codeVerifier){throw new Error("loginPKCEGrant requires Local Storage or codeVerifier as input parameter");}// Check for auth code in query
|
|
981
|
+
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
|
|
982
|
+
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
|
|
983
|
+
if(query&&query.error){// remove codeVerifier from session storage
|
|
984
|
+
if(_this5.hasLocalStorage){sessionStorage.removeItem("genesys_cloud_sdk_pkce_code_verifier");}// reset access token if any was stored
|
|
985
|
+
_this5._saveSettings({accessToken:undefined});return reject(new Error("[".concat(query.error,"] ").concat(query.error_description)));}// Get token on auth code
|
|
986
|
+
if(query&&query.code){if(!_this5.codeVerifier){// load codeVerifier from session storage
|
|
987
|
+
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
|
|
988
|
+
_this5._testTokenAccess().then(function(){if(!_this5.authData.state&&query.state)_this5.authData.state=query.state;// remove codeVerifier from session storage
|
|
989
|
+
if(_this5.hasLocalStorage){sessionStorage.removeItem("genesys_cloud_sdk_pkce_code_verifier");}resolve(_this5.authData);})["catch"](function(error){// Handle failure response
|
|
990
|
+
_this5._saveSettings({accessToken:undefined});// remove codeVerifier from session storage
|
|
991
|
+
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
|
|
992
|
+
_this5._saveSettings({accessToken:undefined});// remove codeVerifier from session storage
|
|
993
|
+
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
|
|
994
|
+
_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
|
|
995
|
+
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,"]")));});});}});}/**
|
|
996
|
+
* @description Parses the URL Query, grabs the code, and clears the query param. If no code is found, no action is taken.
|
|
997
|
+
*/},{key:"_setValuesFromUrlQuery",value:function _setValuesFromUrlQuery(){// Check for window
|
|
998
|
+
if(!(typeof window!=='undefined'&&window.location.search))return;// Process query string
|
|
999
|
+
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
|
|
1000
|
+
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
|
|
1001
|
+
if(code){query.code=code;if(state){query.state=state;}}// Remove code from URL
|
|
1002
|
+
// Credit: https://stackoverflow.com/questions/1397329/how-to-remove-the-hash-from-window-location-with-javascript-without-page-refresh/5298684#5298684
|
|
1003
|
+
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
|
|
1004
|
+
scrollV=document.body.scrollTop;scrollH=document.body.scrollLeft;// Remove code
|
|
1005
|
+
history.pushState('',document.title,loc.pathname);// Restore the scroll offset, should be flicker free
|
|
1006
|
+
document.body.scrollTop=scrollV;document.body.scrollLeft=scrollH;}return query;}/**
|
|
950
1007
|
* @description Initiates the Code Authorization. Only available in node apps.
|
|
951
1008
|
* @param {string} clientId - The client ID of an OAuth Code Authorization Grant client
|
|
952
1009
|
* @param {string} clientSecret - The client secret of an OAuth Code Authorization Grant client
|
|
953
1010
|
* @param {string} authCode - Authorization code
|
|
954
1011
|
* @param {string} redirectUri - Authorized redirect URI for your Code Authorization client
|
|
955
|
-
*/},{key:"loginCodeAuthorizationGrant",value:function loginCodeAuthorizationGrant(clientId,clientSecret,authCode,redirectUri){var
|
|
956
|
-
|
|
1012
|
+
*/},{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
|
|
1013
|
+
_this6._handleCodeAuthorizationResponse(request,bodyParam,resolve,reject);});}/**
|
|
957
1014
|
* @description Requests a new access token for Code Authorization. Only available in node apps.
|
|
958
1015
|
* @param {string} clientId - The client ID of an OAuth Code Authorization Grant client
|
|
959
1016
|
* @param {string} clientSecret - The client secret of an OAuth Code Authorization Grant client
|
|
960
1017
|
* @param {string} authCode - Authorization code
|
|
961
1018
|
* @param {string} redirectUri - Authorized redirect URI for your Code Authorization client
|
|
962
|
-
*/},{key:"refreshCodeAuthorizationGrant",value:function refreshCodeAuthorizationGrant(clientId,clientSecret,refreshToken){var
|
|
963
|
-
|
|
1019
|
+
*/},{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
|
|
1020
|
+
_this7._handleCodeAuthorizationResponse(request,bodyParam,resolve,reject);});}/**
|
|
964
1021
|
* @description Handles the response for code auth requests
|
|
965
1022
|
* @param {object} request - Authorization request object
|
|
966
1023
|
* @param {object} bodyParam - Input body data for authorization request
|
|
967
1024
|
* @param {function} resolve - Promise resolve callback
|
|
968
1025
|
* @param {function} reject - Promise reject callback
|
|
969
|
-
*/},{key:"_handleCodeAuthorizationResponse",value:function _handleCodeAuthorizationResponse(request,bodyParam,resolve,reject){var
|
|
970
|
-
|
|
971
|
-
var access_token=response.data.access_token;var refresh_token=response.data.refresh_token;
|
|
972
|
-
resolve(
|
|
973
|
-
if(error.response){
|
|
1026
|
+
*/},{key:"_handleCodeAuthorizationResponse",value:function _handleCodeAuthorizationResponse(request,bodyParam,resolve,reject){var _this8=this;request.then(function(response){// Logging
|
|
1027
|
+
_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
|
|
1028
|
+
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
|
|
1029
|
+
resolve(_this8.authData);})["catch"](function(error){// Log error
|
|
1030
|
+
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);});}/**
|
|
974
1031
|
* @description Utility function to create the request for auth requests
|
|
975
1032
|
* @param {string} encodedData - Base64 encoded client and clientSecret pair
|
|
976
1033
|
* @param {object} data - data to url form encode
|
|
977
1034
|
*/},{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;}/**
|
|
978
1035
|
* @description Handles an expired access token. Only available in node apps.
|
|
979
1036
|
* @param {string} statusCode - The status code of a request
|
|
980
|
-
*/},{key:"_handleExpiredAccessToken",value:function _handleExpiredAccessToken(){var
|
|
981
|
-
|
|
982
|
-
|
|
1037
|
+
*/},{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
|
|
1038
|
+
_this9.refreshInProgress=false;reject(err);});}else{// Wait refresh_token_wait_max seconds for other thread to complete refresh
|
|
1039
|
+
_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();});}});}/**
|
|
983
1040
|
* @description Sleeps for a defined length
|
|
984
1041
|
* @param {int} millis - Length to sleep in milliseconds
|
|
985
1042
|
*/},{key:"_sleep",value:function _sleep(millis){return new Promise(function(resolve){return setTimeout(resolve,millis);});}/**
|
|
986
1043
|
* @description Loads token from storage, if enabled, and checks to ensure it works.
|
|
987
|
-
*/},{key:"_testTokenAccess",value:function _testTokenAccess(){var
|
|
988
|
-
|
|
989
|
-
if(!
|
|
990
|
-
|
|
1044
|
+
*/},{key:"_testTokenAccess",value:function _testTokenAccess(){var _this10=this;return new Promise(function(resolve,reject){// Load from storage
|
|
1045
|
+
_this10._loadSettings();// Check if there is a token to test
|
|
1046
|
+
if(!_this10.authentications['PureCloud OAuth'].accessToken){reject(new Error('Token is not set'));return;}// Test token
|
|
1047
|
+
_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);});});}/**
|
|
991
1048
|
* @description Parses the URL hash, grabs the access token, and clears the hash. If no access token is found, no action is taken.
|
|
992
1049
|
*/},{key:"_setValuesFromUrlHash",value:function _setValuesFromUrlHash(){// Check for window
|
|
993
1050
|
if(!(typeof window!=='undefined'&&window.location.hash))return;// Process hash string into object
|
|
@@ -1032,7 +1089,7 @@ this.setAccessToken(this.authentications['PureCloud OAuth'].accessToken);}/**
|
|
|
1032
1089
|
* @param {String} path The path to append to the base URL.
|
|
1033
1090
|
* @param {Object} pathParams The parameter values to append.
|
|
1034
1091
|
* @returns {String} The encoded path with parameter values substituted.
|
|
1035
|
-
*/},{key:"buildUrl",value:function buildUrl(path,pathParams){var
|
|
1092
|
+
*/},{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;}/**
|
|
1036
1093
|
* Checks whether the given content type represents JSON.<br>
|
|
1037
1094
|
* JSON content type examples:<br>
|
|
1038
1095
|
* <ul>
|
|
@@ -1073,7 +1130,7 @@ return param.map(this.paramToString);default:throw new Error("Unknown collection
|
|
|
1073
1130
|
* Applies authentication headers to the request.
|
|
1074
1131
|
* @param {Object} request The axios request config object.
|
|
1075
1132
|
* @param {Array.<String>} authNames An array of authentication method names.
|
|
1076
|
-
*/},{key:"applyAuthToRequest",value:function applyAuthToRequest(request,authNames){var
|
|
1133
|
+
*/},{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));}});}/**
|
|
1077
1134
|
* @description Sets the proxy agent axios will use for requests
|
|
1078
1135
|
* @param {any} agent - The proxy agent
|
|
1079
1136
|
*/},{key:"setProxyAgent",value:function setProxyAgent(agent){this.proxyAgent=agent;}/**
|
|
@@ -1090,7 +1147,7 @@ return param.map(this.paramToString);default:throw new Error("Unknown collection
|
|
|
1090
1147
|
* @param {Array.<String>} accepts An array of acceptable response MIME types.types or the
|
|
1091
1148
|
* constructor for a complex type.
|
|
1092
1149
|
* @returns {Promise} A Promise object.
|
|
1093
|
-
*/},{key:"callApi",value:function callApi(path,httpMethod,pathParams,queryParams,headerParams,formParams,bodyParam,authNames,contentTypes,accepts){var
|
|
1150
|
+
*/},{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
|
|
1094
1151
|
that.applyAuthToRequest(request,authNames);// set header parameters
|
|
1095
1152
|
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
|
|
1096
1153
|
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
|
|
@@ -1100,7 +1157,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
1100
1157
|
that.config.logger.log('error',error.response.status,httpMethod,url,request.headers,error.response.headers,bodyParam,error.response.data);data=that.returnExtended===true?{status:error.response.status,statusText:error.response.statusText,headers:error.response.headers,body:error.response.data,text:error.response.text,error:error}:error.response.data?error.response.data:error.response.text;}reject(data);});}});}}]);return ApiClient;}();var AlertingApi=/*#__PURE__*/function(){/**
|
|
1101
1158
|
* Alerting service.
|
|
1102
1159
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1103
|
-
* @version
|
|
1160
|
+
* @version 185.0.0
|
|
1104
1161
|
*/ /**
|
|
1105
1162
|
* Constructs a new AlertingApi.
|
|
1106
1163
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -1257,7 +1314,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
1257
1314
|
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(){/**
|
|
1258
1315
|
* Analytics service.
|
|
1259
1316
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1260
|
-
* @version
|
|
1317
|
+
* @version 185.0.0
|
|
1261
1318
|
*/ /**
|
|
1262
1319
|
* Constructs a new AnalyticsApi.
|
|
1263
1320
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -1389,6 +1446,20 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
1389
1446
|
* getAnalyticsEvaluationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1390
1447
|
*/},{key:"getAnalyticsEvaluationsAggregatesJobResults",value:function getAnalyticsEvaluationsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
1391
1448
|
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']);}/**
|
|
1449
|
+
* Get status for async query for flow execution aggregates
|
|
1450
|
+
*
|
|
1451
|
+
* @param {String} jobId jobId
|
|
1452
|
+
* getAnalyticsFlowexecutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1453
|
+
*/},{key:"getAnalyticsFlowexecutionsAggregatesJob",value:function getAnalyticsFlowexecutionsAggregatesJob(jobId){// verify the required parameter 'jobId' is set
|
|
1454
|
+
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']);}/**
|
|
1455
|
+
* Fetch a page of results for an async aggregates query
|
|
1456
|
+
*
|
|
1457
|
+
* @param {String} jobId jobId
|
|
1458
|
+
* @param {Object} opts Optional parameters
|
|
1459
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
1460
|
+
* getAnalyticsFlowexecutionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1461
|
+
*/},{key:"getAnalyticsFlowexecutionsAggregatesJobResults",value:function getAnalyticsFlowexecutionsAggregatesJobResults(jobId,opts){opts=opts||{};// verify the required parameter 'jobId' is set
|
|
1462
|
+
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']);}/**
|
|
1392
1463
|
* Get status for async query for Flow aggregates
|
|
1393
1464
|
*
|
|
1394
1465
|
* @param {String} jobId jobId
|
|
@@ -1660,6 +1731,18 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
1660
1731
|
* @param {Object} body query
|
|
1661
1732
|
*/},{key:"postAnalyticsEvaluationsAggregatesQuery",value:function postAnalyticsEvaluationsAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
1662
1733
|
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']);}/**
|
|
1734
|
+
* Query for flow execution aggregates asynchronously
|
|
1735
|
+
*
|
|
1736
|
+
* @param {Object} body query
|
|
1737
|
+
* postAnalyticsFlowexecutionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1738
|
+
*/},{key:"postAnalyticsFlowexecutionsAggregatesJobs",value:function postAnalyticsFlowexecutionsAggregatesJobs(body){// verify the required parameter 'body' is set
|
|
1739
|
+
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']);}/**
|
|
1740
|
+
* Query for flow execution aggregates
|
|
1741
|
+
*
|
|
1742
|
+
* @param {Object} body query
|
|
1743
|
+
* postAnalyticsFlowexecutionsAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1744
|
+
*/},{key:"postAnalyticsFlowexecutionsAggregatesQuery",value:function postAnalyticsFlowexecutionsAggregatesQuery(body){// verify the required parameter 'body' is set
|
|
1745
|
+
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']);}/**
|
|
1663
1746
|
* Query for flow activity observations
|
|
1664
1747
|
*
|
|
1665
1748
|
* @param {Object} body query
|
|
@@ -1838,7 +1921,7 @@ if(scheduleId===undefined||scheduleId===null){throw'Missing the required paramet
|
|
|
1838
1921
|
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(){/**
|
|
1839
1922
|
* Architect service.
|
|
1840
1923
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
1841
|
-
* @version
|
|
1924
|
+
* @version 185.0.0
|
|
1842
1925
|
*/ /**
|
|
1843
1926
|
* Constructs a new ArchitectApi.
|
|
1844
1927
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -2731,7 +2814,7 @@ if(datatableId===undefined||datatableId===null){throw'Missing the required param
|
|
|
2731
2814
|
if(datatableId===undefined||datatableId===null){throw'Missing the required parameter "datatableId" when calling postFlowsDatatableImportJobs';}// verify the required parameter 'body' is set
|
|
2732
2815
|
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']);}/**
|
|
2733
2816
|
* Create a new row entry for the datatable.
|
|
2734
|
-
* 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" }
|
|
2817
|
+
* 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" }
|
|
2735
2818
|
* @param {String} datatableId id of datatable
|
|
2736
2819
|
* @param {Object.<String, {String: Object}>} dataTableRow
|
|
2737
2820
|
*/},{key:"postFlowsDatatableRows",value:function postFlowsDatatableRows(datatableId,dataTableRow){// verify the required parameter 'datatableId' is set
|
|
@@ -2846,7 +2929,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2846
2929
|
if(datatableId===undefined||datatableId===null){throw'Missing the required parameter "datatableId" when calling putFlowsDatatable';}// verify the required parameter 'body' is set
|
|
2847
2930
|
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']);}/**
|
|
2848
2931
|
* Update a row entry
|
|
2849
|
-
* 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" }
|
|
2932
|
+
* 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" }
|
|
2850
2933
|
* @param {String} datatableId id of datatable
|
|
2851
2934
|
* @param {String} rowId the key for the row
|
|
2852
2935
|
* @param {Object} opts Optional parameters
|
|
@@ -2870,7 +2953,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
2870
2953
|
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(){/**
|
|
2871
2954
|
* Audit service.
|
|
2872
2955
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
2873
|
-
* @version
|
|
2956
|
+
* @version 185.0.0
|
|
2874
2957
|
*/ /**
|
|
2875
2958
|
* Constructs a new AuditApi.
|
|
2876
2959
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -2912,7 +2995,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2912
2995
|
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(){/**
|
|
2913
2996
|
* Authorization service.
|
|
2914
2997
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
2915
|
-
* @version
|
|
2998
|
+
* @version 185.0.0
|
|
2916
2999
|
*/ /**
|
|
2917
3000
|
* Constructs a new AuthorizationApi.
|
|
2918
3001
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -3017,7 +3100,7 @@ if(permission===undefined||permission===null){throw'Missing the required paramet
|
|
|
3017
3100
|
* Get the organization role specified by its ID.
|
|
3018
3101
|
* @param {String} roleId Role ID
|
|
3019
3102
|
* @param {Object} opts Optional parameters
|
|
3020
|
-
* @param {Object} opts.userCount Fetch the count of users who have this role granted in at least one division (default to true)
|
|
3103
|
+
* @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)
|
|
3021
3104
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand. unusedPermissions returns the permissions not used for the role
|
|
3022
3105
|
*/},{key:"getAuthorizationRole",value:function getAuthorizationRole(roleId,opts){opts=opts||{};// verify the required parameter 'roleId' is set
|
|
3023
3106
|
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']);}/**
|
|
@@ -3108,10 +3191,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3108
3191
|
* Recreate a previously deleted division.
|
|
3109
3192
|
*
|
|
3110
3193
|
* @param {String} divisionId Division ID
|
|
3111
|
-
* @param {Object}
|
|
3112
|
-
|
|
3113
|
-
|
|
3114
|
-
if(
|
|
3194
|
+
* @param {Object} opts Optional parameters
|
|
3195
|
+
* @param {Object} opts.body Recreated division data
|
|
3196
|
+
*/},{key:"postAuthorizationDivisionRestore",value:function postAuthorizationDivisionRestore(divisionId,opts){opts=opts||{};// verify the required parameter 'divisionId' is set
|
|
3197
|
+
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']);}/**
|
|
3115
3198
|
* Create a division.
|
|
3116
3199
|
*
|
|
3117
3200
|
* @param {Object} body Division
|
|
@@ -3223,7 +3306,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
3223
3306
|
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(){/**
|
|
3224
3307
|
* Billing service.
|
|
3225
3308
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
3226
|
-
* @version
|
|
3309
|
+
* @version 185.0.0
|
|
3227
3310
|
*/ /**
|
|
3228
3311
|
* Constructs a new BillingApi.
|
|
3229
3312
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -3247,7 +3330,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
3247
3330
|
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(){/**
|
|
3248
3331
|
* CarrierServices service.
|
|
3249
3332
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
3250
|
-
* @version
|
|
3333
|
+
* @version 185.0.0
|
|
3251
3334
|
*/ /**
|
|
3252
3335
|
* Constructs a new CarrierServicesApi.
|
|
3253
3336
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -3267,7 +3350,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
3267
3350
|
*/},{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(){/**
|
|
3268
3351
|
* Chat service.
|
|
3269
3352
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
3270
|
-
* @version
|
|
3353
|
+
* @version 185.0.0
|
|
3271
3354
|
*/ /**
|
|
3272
3355
|
* Constructs a new ChatApi.
|
|
3273
3356
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -3464,7 +3547,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3464
3547
|
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(){/**
|
|
3465
3548
|
* Coaching service.
|
|
3466
3549
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
3467
|
-
* @version
|
|
3550
|
+
* @version 185.0.0
|
|
3468
3551
|
*/ /**
|
|
3469
3552
|
* Constructs a new CoachingApi.
|
|
3470
3553
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -3617,7 +3700,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3617
3700
|
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(){/**
|
|
3618
3701
|
* ContentManagement service.
|
|
3619
3702
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
3620
|
-
* @version
|
|
3703
|
+
* @version 185.0.0
|
|
3621
3704
|
*/ /**
|
|
3622
3705
|
* Constructs a new ContentManagementApi.
|
|
3623
3706
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -3919,7 +4002,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
3919
4002
|
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(){/**
|
|
3920
4003
|
* Conversations service.
|
|
3921
4004
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
3922
|
-
* @version
|
|
4005
|
+
* @version 185.0.0
|
|
3923
4006
|
*/ /**
|
|
3924
4007
|
* Constructs a new ConversationsApi.
|
|
3925
4008
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -5643,7 +5726,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
5643
5726
|
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(){/**
|
|
5644
5727
|
* DataExtensions service.
|
|
5645
5728
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
5646
|
-
* @version
|
|
5729
|
+
* @version 185.0.0
|
|
5647
5730
|
*/ /**
|
|
5648
5731
|
* Constructs a new DataExtensionsApi.
|
|
5649
5732
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -5664,7 +5747,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
5664
5747
|
*/},{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(){/**
|
|
5665
5748
|
* Downloads service.
|
|
5666
5749
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
5667
|
-
* @version
|
|
5750
|
+
* @version 185.0.0
|
|
5668
5751
|
*/ /**
|
|
5669
5752
|
* Constructs a new DownloadsApi.
|
|
5670
5753
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -5683,7 +5766,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
5683
5766
|
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(){/**
|
|
5684
5767
|
* Emails service.
|
|
5685
5768
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
5686
|
-
* @version
|
|
5769
|
+
* @version 185.0.0
|
|
5687
5770
|
*/ /**
|
|
5688
5771
|
* Constructs a new EmailsApi.
|
|
5689
5772
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -5701,7 +5784,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
5701
5784
|
*/},{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(){/**
|
|
5702
5785
|
* Events service.
|
|
5703
5786
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
5704
|
-
* @version
|
|
5787
|
+
* @version 185.0.0
|
|
5705
5788
|
*/ /**
|
|
5706
5789
|
* Constructs a new EventsApi.
|
|
5707
5790
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -5726,7 +5809,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5726
5809
|
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(){/**
|
|
5727
5810
|
* ExternalContacts service.
|
|
5728
5811
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
5729
|
-
* @version
|
|
5812
|
+
* @version 185.0.0
|
|
5730
5813
|
*/ /**
|
|
5731
5814
|
* Constructs a new ExternalContactsApi.
|
|
5732
5815
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -6181,7 +6264,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
6181
6264
|
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(){/**
|
|
6182
6265
|
* Fax service.
|
|
6183
6266
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
6184
|
-
* @version
|
|
6267
|
+
* @version 185.0.0
|
|
6185
6268
|
*/ /**
|
|
6186
6269
|
* Constructs a new FaxApi.
|
|
6187
6270
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -6222,7 +6305,7 @@ if(documentId===undefined||documentId===null){throw'Missing the required paramet
|
|
|
6222
6305
|
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(){/**
|
|
6223
6306
|
* Flows service.
|
|
6224
6307
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
6225
|
-
* @version
|
|
6308
|
+
* @version 185.0.0
|
|
6226
6309
|
*/ /**
|
|
6227
6310
|
* Constructs a new FlowsApi.
|
|
6228
6311
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -6271,7 +6354,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6271
6354
|
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(){/**
|
|
6272
6355
|
* Gamification service.
|
|
6273
6356
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
6274
|
-
* @version
|
|
6357
|
+
* @version 185.0.0
|
|
6275
6358
|
*/ /**
|
|
6276
6359
|
* Constructs a new GamificationApi.
|
|
6277
6360
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -6811,7 +6894,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6811
6894
|
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(){/**
|
|
6812
6895
|
* GeneralDataProtectionRegulation service.
|
|
6813
6896
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
6814
|
-
* @version
|
|
6897
|
+
* @version 185.0.0
|
|
6815
6898
|
*/ /**
|
|
6816
6899
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
6817
6900
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -6846,7 +6929,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
6846
6929
|
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(){/**
|
|
6847
6930
|
* Geolocation service.
|
|
6848
6931
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
6849
|
-
* @version
|
|
6932
|
+
* @version 185.0.0
|
|
6850
6933
|
*/ /**
|
|
6851
6934
|
* Constructs a new GeolocationApi.
|
|
6852
6935
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -6880,7 +6963,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
6880
6963
|
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(){/**
|
|
6881
6964
|
* Greetings service.
|
|
6882
6965
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
6883
|
-
* @version
|
|
6966
|
+
* @version 185.0.0
|
|
6884
6967
|
*/ /**
|
|
6885
6968
|
* Constructs a new GreetingsApi.
|
|
6886
6969
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -6987,7 +7070,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
6987
7070
|
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(){/**
|
|
6988
7071
|
* Groups service.
|
|
6989
7072
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
6990
|
-
* @version
|
|
7073
|
+
* @version 185.0.0
|
|
6991
7074
|
*/ /**
|
|
6992
7075
|
* Constructs a new GroupsApi.
|
|
6993
7076
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -7120,7 +7203,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
7120
7203
|
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(){/**
|
|
7121
7204
|
* IdentityProvider service.
|
|
7122
7205
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
7123
|
-
* @version
|
|
7206
|
+
* @version 185.0.0
|
|
7124
7207
|
*/ /**
|
|
7125
7208
|
* Constructs a new IdentityProviderApi.
|
|
7126
7209
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -7254,7 +7337,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7254
7337
|
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(){/**
|
|
7255
7338
|
* InfrastructureAsCode service.
|
|
7256
7339
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
7257
|
-
* @version
|
|
7340
|
+
* @version 185.0.0
|
|
7258
7341
|
*/ /**
|
|
7259
7342
|
* Constructs a new InfrastructureAsCodeApi.
|
|
7260
7343
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -7308,7 +7391,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
7308
7391
|
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(){/**
|
|
7309
7392
|
* Integrations service.
|
|
7310
7393
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
7311
|
-
* @version
|
|
7394
|
+
* @version 185.0.0
|
|
7312
7395
|
*/ /**
|
|
7313
7396
|
* Constructs a new IntegrationsApi.
|
|
7314
7397
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -7829,7 +7912,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
7829
7912
|
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(){/**
|
|
7830
7913
|
* Journey service.
|
|
7831
7914
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
7832
|
-
* @version
|
|
7915
|
+
* @version 185.0.0
|
|
7833
7916
|
*/ /**
|
|
7834
7917
|
* Constructs a new JourneyApi.
|
|
7835
7918
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -8133,7 +8216,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
8133
8216
|
*/},{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(){/**
|
|
8134
8217
|
* Knowledge service.
|
|
8135
8218
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
8136
|
-
* @version
|
|
8219
|
+
* @version 185.0.0
|
|
8137
8220
|
*/ /**
|
|
8138
8221
|
* Constructs a new KnowledgeApi.
|
|
8139
8222
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -8930,7 +9013,7 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
8930
9013
|
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(){/**
|
|
8931
9014
|
* LanguageUnderstanding service.
|
|
8932
9015
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
8933
|
-
* @version
|
|
9016
|
+
* @version 185.0.0
|
|
8934
9017
|
*/ /**
|
|
8935
9018
|
* Constructs a new LanguageUnderstandingApi.
|
|
8936
9019
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -9186,7 +9269,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
9186
9269
|
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(){/**
|
|
9187
9270
|
* Languages service.
|
|
9188
9271
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
9189
|
-
* @version
|
|
9272
|
+
* @version 185.0.0
|
|
9190
9273
|
*/ /**
|
|
9191
9274
|
* Constructs a new LanguagesApi.
|
|
9192
9275
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -9241,7 +9324,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
9241
9324
|
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(){/**
|
|
9242
9325
|
* Learning service.
|
|
9243
9326
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
9244
|
-
* @version
|
|
9327
|
+
* @version 185.0.0
|
|
9245
9328
|
*/ /**
|
|
9246
9329
|
* Constructs a new LearningApi.
|
|
9247
9330
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -9471,7 +9554,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
9471
9554
|
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(){/**
|
|
9472
9555
|
* License service.
|
|
9473
9556
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
9474
|
-
* @version
|
|
9557
|
+
* @version 185.0.0
|
|
9475
9558
|
*/ /**
|
|
9476
9559
|
* Constructs a new LicenseApi.
|
|
9477
9560
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -9525,7 +9608,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
9525
9608
|
*/},{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(){/**
|
|
9526
9609
|
* Locations service.
|
|
9527
9610
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
9528
|
-
* @version
|
|
9611
|
+
* @version 185.0.0
|
|
9529
9612
|
*/ /**
|
|
9530
9613
|
* Constructs a new LocationsApi.
|
|
9531
9614
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -9581,10 +9664,30 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9581
9664
|
*
|
|
9582
9665
|
* @param {Object} body Search request options
|
|
9583
9666
|
*/},{key:"postLocationsSearch",value:function postLocationsSearch(body){// verify the required parameter 'body' is set
|
|
9584
|
-
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
|
|
9667
|
+
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(){/**
|
|
9668
|
+
* LogCapture service.
|
|
9669
|
+
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
9670
|
+
* @version 185.0.0
|
|
9671
|
+
*/ /**
|
|
9672
|
+
* Constructs a new LogCaptureApi.
|
|
9673
|
+
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
9674
|
+
* @class
|
|
9675
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
9676
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
9677
|
+
*/function LogCaptureApi(apiClient){_classCallCheck(this,LogCaptureApi);this.apiClient=apiClient||ApiClient.instance;}/**
|
|
9678
|
+
* Gets status of async download execution
|
|
9679
|
+
*
|
|
9680
|
+
* @param {String} jobId Job ID
|
|
9681
|
+
*/_createClass(LogCaptureApi,[{key:"getDiagnosticsLogcaptureBrowserEntriesDownloadJob",value:function getDiagnosticsLogcaptureBrowserEntriesDownloadJob(jobId){// verify the required parameter 'jobId' is set
|
|
9682
|
+
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']);}/**
|
|
9683
|
+
* Creates an async download execution
|
|
9684
|
+
*
|
|
9685
|
+
* @param {Object} opts Optional parameters
|
|
9686
|
+
* @param {Object} opts.body
|
|
9687
|
+
*/},{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(){/**
|
|
9585
9688
|
* Messaging service.
|
|
9586
9689
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
9587
|
-
* @version
|
|
9690
|
+
* @version 185.0.0
|
|
9588
9691
|
*/ /**
|
|
9589
9692
|
* Constructs a new MessagingApi.
|
|
9590
9693
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -9674,7 +9777,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9674
9777
|
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(){/**
|
|
9675
9778
|
* MobileDevices service.
|
|
9676
9779
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
9677
|
-
* @version
|
|
9780
|
+
* @version 185.0.0
|
|
9678
9781
|
*/ /**
|
|
9679
9782
|
* Constructs a new MobileDevicesApi.
|
|
9680
9783
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -9713,7 +9816,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9713
9816
|
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(){/**
|
|
9714
9817
|
* Notifications service.
|
|
9715
9818
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
9716
|
-
* @version
|
|
9819
|
+
* @version 185.0.0
|
|
9717
9820
|
*/ /**
|
|
9718
9821
|
* Constructs a new NotificationsApi.
|
|
9719
9822
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -9770,7 +9873,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
9770
9873
|
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(){/**
|
|
9771
9874
|
* OAuth service.
|
|
9772
9875
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
9773
|
-
* @version
|
|
9876
|
+
* @version 185.0.0
|
|
9774
9877
|
*/ /**
|
|
9775
9878
|
* Constructs a new OAuthApi.
|
|
9776
9879
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -9855,7 +9958,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
9855
9958
|
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(){/**
|
|
9856
9959
|
* Objects service.
|
|
9857
9960
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
9858
|
-
* @version
|
|
9961
|
+
* @version 185.0.0
|
|
9859
9962
|
*/ /**
|
|
9860
9963
|
* Constructs a new ObjectsApi.
|
|
9861
9964
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -9908,10 +10011,10 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9908
10011
|
* Recreate a previously deleted division.
|
|
9909
10012
|
*
|
|
9910
10013
|
* @param {String} divisionId Division ID
|
|
9911
|
-
* @param {Object}
|
|
9912
|
-
|
|
9913
|
-
|
|
9914
|
-
if(
|
|
10014
|
+
* @param {Object} opts Optional parameters
|
|
10015
|
+
* @param {Object} opts.body Recreated division data
|
|
10016
|
+
*/},{key:"postAuthorizationDivisionRestore",value:function postAuthorizationDivisionRestore(divisionId,opts){opts=opts||{};// verify the required parameter 'divisionId' is set
|
|
10017
|
+
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']);}/**
|
|
9915
10018
|
* Create a division.
|
|
9916
10019
|
*
|
|
9917
10020
|
* @param {Object} body Division
|
|
@@ -9926,7 +10029,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
9926
10029
|
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(){/**
|
|
9927
10030
|
* OperationalEvents service.
|
|
9928
10031
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
9929
|
-
* @version
|
|
10032
|
+
* @version 185.0.0
|
|
9930
10033
|
*/ /**
|
|
9931
10034
|
* Constructs a new OperationalEventsApi.
|
|
9932
10035
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -9944,7 +10047,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
9944
10047
|
*/},{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(){/**
|
|
9945
10048
|
* Organization service.
|
|
9946
10049
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
9947
|
-
* @version
|
|
10050
|
+
* @version 185.0.0
|
|
9948
10051
|
*/ /**
|
|
9949
10052
|
* Constructs a new OrganizationApi.
|
|
9950
10053
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -10046,7 +10149,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10046
10149
|
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(){/**
|
|
10047
10150
|
* OrganizationAuthorization service.
|
|
10048
10151
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
10049
|
-
* @version
|
|
10152
|
+
* @version 185.0.0
|
|
10050
10153
|
*/ /**
|
|
10051
10154
|
* Constructs a new OrganizationAuthorizationApi.
|
|
10052
10155
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -10369,7 +10472,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
10369
10472
|
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(){/**
|
|
10370
10473
|
* Outbound service.
|
|
10371
10474
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
10372
|
-
* @version
|
|
10475
|
+
* @version 185.0.0
|
|
10373
10476
|
*/ /**
|
|
10374
10477
|
* Constructs a new OutboundApi.
|
|
10375
10478
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -10436,6 +10539,16 @@ if(contactListFilterId===undefined||contactListFilterId===null){throw'Missing th
|
|
|
10436
10539
|
* @param {Array.<String>} id contact list id(s) to delete
|
|
10437
10540
|
*/},{key:"deleteOutboundContactlists",value:function deleteOutboundContactlists(id){// verify the required parameter 'id' is set
|
|
10438
10541
|
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']);}/**
|
|
10542
|
+
* Delete Contact List Template
|
|
10543
|
+
*
|
|
10544
|
+
* @param {String} contactListTemplateId ContactListTemplate ID
|
|
10545
|
+
*/},{key:"deleteOutboundContactlisttemplate",value:function deleteOutboundContactlisttemplate(contactListTemplateId){// verify the required parameter 'contactListTemplateId' is set
|
|
10546
|
+
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']);}/**
|
|
10547
|
+
* Delete multiple contact list templates.
|
|
10548
|
+
*
|
|
10549
|
+
* @param {Array.<String>} id contact list template id(s) to delete
|
|
10550
|
+
*/},{key:"deleteOutboundContactlisttemplates",value:function deleteOutboundContactlisttemplates(id){// verify the required parameter 'id' is set
|
|
10551
|
+
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']);}/**
|
|
10439
10552
|
* Delete an Outbound Digital Rule Set
|
|
10440
10553
|
*
|
|
10441
10554
|
* @param {String} digitalRuleSetId The Digital Rule Set ID
|
|
@@ -10467,6 +10580,16 @@ if(dncListId===undefined||dncListId===null){throw'Missing the required parameter
|
|
|
10467
10580
|
* @param {Boolean} opts.expiredOnly Set to true to only remove DNC entries that are expired (default to false)
|
|
10468
10581
|
*/},{key:"deleteOutboundDnclistPhonenumbers",value:function deleteOutboundDnclistPhonenumbers(dncListId,opts){opts=opts||{};// verify the required parameter 'dncListId' is set
|
|
10469
10582
|
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']);}/**
|
|
10583
|
+
* Delete Import Template
|
|
10584
|
+
*
|
|
10585
|
+
* @param {String} importTemplateId Import Template ID
|
|
10586
|
+
*/},{key:"deleteOutboundImporttemplate",value:function deleteOutboundImporttemplate(importTemplateId){// verify the required parameter 'importTemplateId' is set
|
|
10587
|
+
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']);}/**
|
|
10588
|
+
* Delete multiple import templates.
|
|
10589
|
+
*
|
|
10590
|
+
* @param {Array.<String>} id import template id(s) to delete
|
|
10591
|
+
*/},{key:"deleteOutboundImporttemplates",value:function deleteOutboundImporttemplates(id){// verify the required parameter 'id' is set
|
|
10592
|
+
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']);}/**
|
|
10470
10593
|
* Delete an Outbound Messaging Campaign
|
|
10471
10594
|
*
|
|
10472
10595
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
@@ -10741,6 +10864,22 @@ if(contactListId===undefined||contactListId===null){throw'Missing the required p
|
|
|
10741
10864
|
* @param {String} opts.sortBy Sort by
|
|
10742
10865
|
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
10743
10866
|
*/},{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']);}/**
|
|
10867
|
+
* Get Contact List Template
|
|
10868
|
+
*
|
|
10869
|
+
* @param {String} contactListTemplateId ContactListTemplate ID
|
|
10870
|
+
*/},{key:"getOutboundContactlisttemplate",value:function getOutboundContactlisttemplate(contactListTemplateId){// verify the required parameter 'contactListTemplateId' is set
|
|
10871
|
+
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']);}/**
|
|
10872
|
+
* Query a list of contact list templates
|
|
10873
|
+
*
|
|
10874
|
+
* @param {Object} opts Optional parameters
|
|
10875
|
+
* @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
|
|
10876
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
10877
|
+
* @param {Boolean} opts.allowEmptyResult Whether to return an empty page when there are no results for that page (default to false)
|
|
10878
|
+
* @param {Object} opts.filterType Filter type (default to Prefix)
|
|
10879
|
+
* @param {String} opts.name Name
|
|
10880
|
+
* @param {String} opts.sortBy Sort by
|
|
10881
|
+
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
10882
|
+
*/},{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']);}/**
|
|
10744
10883
|
* Get an Outbound Digital Rule Set
|
|
10745
10884
|
*
|
|
10746
10885
|
* @param {String} digitalRuleSetId The Digital Rule Set ID
|
|
@@ -10829,6 +10968,30 @@ if(eventId===undefined||eventId===null){throw'Missing the required parameter "ev
|
|
|
10829
10968
|
* @param {String} opts.sortBy Sort by
|
|
10830
10969
|
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
10831
10970
|
*/},{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']);}/**
|
|
10971
|
+
* Get Import Template
|
|
10972
|
+
*
|
|
10973
|
+
* @param {String} importTemplateId Import Template ID
|
|
10974
|
+
*/},{key:"getOutboundImporttemplate",value:function getOutboundImporttemplate(importTemplateId){// verify the required parameter 'importTemplateId' is set
|
|
10975
|
+
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']);}/**
|
|
10976
|
+
* Get the import status for an import template.
|
|
10977
|
+
*
|
|
10978
|
+
* @param {String} importTemplateId importTemplateId
|
|
10979
|
+
* @param {Object} opts Optional parameters
|
|
10980
|
+
* @param {String} opts.listNamePrefix listNamePrefix
|
|
10981
|
+
*/},{key:"getOutboundImporttemplateImportstatus",value:function getOutboundImporttemplateImportstatus(importTemplateId,opts){opts=opts||{};// verify the required parameter 'importTemplateId' is set
|
|
10982
|
+
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']);}/**
|
|
10983
|
+
* Query Import Templates
|
|
10984
|
+
*
|
|
10985
|
+
* @param {Object} opts Optional parameters
|
|
10986
|
+
* @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
|
|
10987
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
10988
|
+
* @param {Boolean} opts.allowEmptyResult Whether to return an empty page when there are no results for that page (default to false)
|
|
10989
|
+
* @param {Object} opts.filterType Filter type (default to Prefix)
|
|
10990
|
+
* @param {String} opts.name Name
|
|
10991
|
+
* @param {String} opts.sortBy Sort by
|
|
10992
|
+
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
10993
|
+
* @param {String} opts.contactListTemplateId Contact List Template ID
|
|
10994
|
+
*/},{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']);}/**
|
|
10832
10995
|
* Get an Outbound Messaging Campaign
|
|
10833
10996
|
*
|
|
10834
10997
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
@@ -11067,6 +11230,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11067
11230
|
* @param {Object} body ContactList
|
|
11068
11231
|
*/},{key:"postOutboundContactlists",value:function postOutboundContactlists(body){// verify the required parameter 'body' is set
|
|
11069
11232
|
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']);}/**
|
|
11233
|
+
* Create Contact List Template
|
|
11234
|
+
*
|
|
11235
|
+
* @param {Object} body ContactListTemplate
|
|
11236
|
+
*/},{key:"postOutboundContactlisttemplates",value:function postOutboundContactlisttemplates(body){// verify the required parameter 'body' is set
|
|
11237
|
+
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']);}/**
|
|
11238
|
+
* Add multiple contact list templates
|
|
11239
|
+
*
|
|
11240
|
+
* @param {Array.<Object>} body contact list template(s) to add
|
|
11241
|
+
*/},{key:"postOutboundContactlisttemplatesBulkAdd",value:function postOutboundContactlisttemplatesBulkAdd(body){// verify the required parameter 'body' is set
|
|
11242
|
+
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']);}/**
|
|
11070
11243
|
* Add phone numbers to a Dialer DNC list.
|
|
11071
11244
|
*
|
|
11072
11245
|
* @param {String} conversationId Conversation ID
|
|
@@ -11103,6 +11276,16 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11103
11276
|
* @param {Object} body DncList
|
|
11104
11277
|
*/},{key:"postOutboundDnclists",value:function postOutboundDnclists(body){// verify the required parameter 'body' is set
|
|
11105
11278
|
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']);}/**
|
|
11279
|
+
* Create Import Template
|
|
11280
|
+
*
|
|
11281
|
+
* @param {Object} body ImportTemplate
|
|
11282
|
+
*/},{key:"postOutboundImporttemplates",value:function postOutboundImporttemplates(body){// verify the required parameter 'body' is set
|
|
11283
|
+
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']);}/**
|
|
11284
|
+
* Add multiple import templates
|
|
11285
|
+
*
|
|
11286
|
+
* @param {Array.<Object>} body import template(s) to add
|
|
11287
|
+
*/},{key:"postOutboundImporttemplatesBulkAdd",value:function postOutboundImporttemplatesBulkAdd(body){// verify the required parameter 'body' is set
|
|
11288
|
+
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']);}/**
|
|
11106
11289
|
* Create a Messaging Campaign
|
|
11107
11290
|
*
|
|
11108
11291
|
* @param {Object} body Messaging Campaign
|
|
@@ -11190,6 +11373,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11190
11373
|
*/},{key:"putOutboundContactlistfilter",value:function putOutboundContactlistfilter(contactListFilterId,body){// verify the required parameter 'contactListFilterId' is set
|
|
11191
11374
|
if(contactListFilterId===undefined||contactListFilterId===null){throw'Missing the required parameter "contactListFilterId" when calling putOutboundContactlistfilter';}// verify the required parameter 'body' is set
|
|
11192
11375
|
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']);}/**
|
|
11376
|
+
* Update a contact list template.
|
|
11377
|
+
*
|
|
11378
|
+
* @param {String} contactListTemplateId ContactListTemplate ID
|
|
11379
|
+
* @param {Object} body ContactListTemplate
|
|
11380
|
+
*/},{key:"putOutboundContactlisttemplate",value:function putOutboundContactlisttemplate(contactListTemplateId,body){// verify the required parameter 'contactListTemplateId' is set
|
|
11381
|
+
if(contactListTemplateId===undefined||contactListTemplateId===null){throw'Missing the required parameter "contactListTemplateId" when calling putOutboundContactlisttemplate';}// verify the required parameter 'body' is set
|
|
11382
|
+
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']);}/**
|
|
11193
11383
|
* Update an Outbound Digital Rule Set
|
|
11194
11384
|
*
|
|
11195
11385
|
* @param {String} digitalRuleSetId The Digital Rule Set ID
|
|
@@ -11204,6 +11394,13 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11204
11394
|
*/},{key:"putOutboundDnclist",value:function putOutboundDnclist(dncListId,body){// verify the required parameter 'dncListId' is set
|
|
11205
11395
|
if(dncListId===undefined||dncListId===null){throw'Missing the required parameter "dncListId" when calling putOutboundDnclist';}// verify the required parameter 'body' is set
|
|
11206
11396
|
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']);}/**
|
|
11397
|
+
* Update Import Template
|
|
11398
|
+
*
|
|
11399
|
+
* @param {String} importTemplateId Import Template ID
|
|
11400
|
+
* @param {Object} body importTemplate
|
|
11401
|
+
*/},{key:"putOutboundImporttemplate",value:function putOutboundImporttemplate(importTemplateId,body){// verify the required parameter 'importTemplateId' is set
|
|
11402
|
+
if(importTemplateId===undefined||importTemplateId===null){throw'Missing the required parameter "importTemplateId" when calling putOutboundImporttemplate';}// verify the required parameter 'body' is set
|
|
11403
|
+
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']);}/**
|
|
11207
11404
|
* Update an Outbound Messaging Campaign
|
|
11208
11405
|
*
|
|
11209
11406
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
@@ -11260,7 +11457,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11260
11457
|
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(){/**
|
|
11261
11458
|
* Presence service.
|
|
11262
11459
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
11263
|
-
* @version
|
|
11460
|
+
* @version 185.0.0
|
|
11264
11461
|
*/ /**
|
|
11265
11462
|
* Constructs a new PresenceApi.
|
|
11266
11463
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -11428,7 +11625,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11428
11625
|
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(){/**
|
|
11429
11626
|
* ProcessAutomation service.
|
|
11430
11627
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
11431
|
-
* @version
|
|
11628
|
+
* @version 185.0.0
|
|
11432
11629
|
*/ /**
|
|
11433
11630
|
* Constructs a new ProcessAutomationApi.
|
|
11434
11631
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -11491,7 +11688,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
11491
11688
|
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(){/**
|
|
11492
11689
|
* Quality service.
|
|
11493
11690
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
11494
|
-
* @version
|
|
11691
|
+
* @version 185.0.0
|
|
11495
11692
|
*/ /**
|
|
11496
11693
|
* Constructs a new QualityApi.
|
|
11497
11694
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -11962,7 +12159,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
11962
12159
|
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(){/**
|
|
11963
12160
|
* Recording service.
|
|
11964
12161
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
11965
|
-
* @version
|
|
12162
|
+
* @version 185.0.0
|
|
11966
12163
|
*/ /**
|
|
11967
12164
|
* Constructs a new RecordingApi.
|
|
11968
12165
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -12369,7 +12566,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12369
12566
|
*/},{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(){/**
|
|
12370
12567
|
* ResponseManagement service.
|
|
12371
12568
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
12372
|
-
* @version
|
|
12569
|
+
* @version 185.0.0
|
|
12373
12570
|
*/ /**
|
|
12374
12571
|
* Constructs a new ResponseManagementApi.
|
|
12375
12572
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -12485,7 +12682,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
12485
12682
|
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(){/**
|
|
12486
12683
|
* Routing service.
|
|
12487
12684
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
12488
|
-
* @version
|
|
12685
|
+
* @version 185.0.0
|
|
12489
12686
|
*/ /**
|
|
12490
12687
|
* Constructs a new RoutingApi.
|
|
12491
12688
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -12585,6 +12782,14 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
12585
12782
|
* Delete the organization-wide max utilization settings and revert to the system default.
|
|
12586
12783
|
*
|
|
12587
12784
|
*/},{key:"deleteRoutingUtilization",value:function deleteRoutingUtilization(){return this.apiClient.callApi('/api/v2/routing/utilization','DELETE',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12785
|
+
* Delete a utilization label
|
|
12786
|
+
*
|
|
12787
|
+
* @param {String} labelId Utilization Label ID
|
|
12788
|
+
* @param {Object} opts Optional parameters
|
|
12789
|
+
* @param {Boolean} opts.forceDelete Remove all label usages (if found) without warning (default to false)
|
|
12790
|
+
* deleteRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12791
|
+
*/},{key:"deleteRoutingUtilizationLabel",value:function deleteRoutingUtilizationLabel(labelId,opts){opts=opts||{};// verify the required parameter 'labelId' is set
|
|
12792
|
+
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']);}/**
|
|
12588
12793
|
* Delete an utilization tag
|
|
12589
12794
|
*
|
|
12590
12795
|
* @param {String} tagId Utilization Tag ID
|
|
@@ -12968,6 +13173,27 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
12968
13173
|
* Get the organization-wide max utilization settings.
|
|
12969
13174
|
*
|
|
12970
13175
|
*/},{key:"getRoutingUtilization",value:function getRoutingUtilization(){return this.apiClient.callApi('/api/v2/routing/utilization','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13176
|
+
* Get details about this utilization label
|
|
13177
|
+
*
|
|
13178
|
+
* @param {String} labelId Utilization Label ID
|
|
13179
|
+
* getRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13180
|
+
*/},{key:"getRoutingUtilizationLabel",value:function getRoutingUtilizationLabel(labelId){// verify the required parameter 'labelId' is set
|
|
13181
|
+
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']);}/**
|
|
13182
|
+
* Get list of agent ids associated with a utilization label
|
|
13183
|
+
*
|
|
13184
|
+
* @param {String} labelId Utilization Label ID
|
|
13185
|
+
* getRoutingUtilizationLabelAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13186
|
+
*/},{key:"getRoutingUtilizationLabelAgents",value:function getRoutingUtilizationLabelAgents(labelId){// verify the required parameter 'labelId' is set
|
|
13187
|
+
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']);}/**
|
|
13188
|
+
* Get list of utilization labels
|
|
13189
|
+
*
|
|
13190
|
+
* @param {Object} opts Optional parameters
|
|
13191
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
13192
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
13193
|
+
* @param {Object} opts.sortOrder Sort order by name (default to ascending)
|
|
13194
|
+
* @param {String} opts.name Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*'
|
|
13195
|
+
* getRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13196
|
+
*/},{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']);}/**
|
|
12971
13197
|
* Get details about this utilization tag
|
|
12972
13198
|
*
|
|
12973
13199
|
* @param {String} tagId Utilization Tag ID
|
|
@@ -13284,6 +13510,12 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13284
13510
|
* postRoutingSmsPhonenumbersImport is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13285
13511
|
*/},{key:"postRoutingSmsPhonenumbersImport",value:function postRoutingSmsPhonenumbersImport(body){// verify the required parameter 'body' is set
|
|
13286
13512
|
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']);}/**
|
|
13513
|
+
* Create a utilization label
|
|
13514
|
+
*
|
|
13515
|
+
* @param {Object} body UtilizationLabel
|
|
13516
|
+
* postRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13517
|
+
*/},{key:"postRoutingUtilizationLabels",value:function postRoutingUtilizationLabels(body){// verify the required parameter 'body' is set
|
|
13518
|
+
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']);}/**
|
|
13287
13519
|
* Create an utilization tag
|
|
13288
13520
|
*
|
|
13289
13521
|
* @param {Object} body UtilizationTag
|
|
@@ -13366,6 +13598,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13366
13598
|
* @param {Object} body utilization
|
|
13367
13599
|
*/},{key:"putRoutingUtilization",value:function putRoutingUtilization(body){// verify the required parameter 'body' is set
|
|
13368
13600
|
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']);}/**
|
|
13601
|
+
* Update a utilization label
|
|
13602
|
+
*
|
|
13603
|
+
* @param {String} labelId Utilization Label ID
|
|
13604
|
+
* @param {Object} body UtilizationLabel
|
|
13605
|
+
* putRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13606
|
+
*/},{key:"putRoutingUtilizationLabel",value:function putRoutingUtilizationLabel(labelId,body){// verify the required parameter 'labelId' is set
|
|
13607
|
+
if(labelId===undefined||labelId===null){throw'Missing the required parameter "labelId" when calling putRoutingUtilizationLabel';}// verify the required parameter 'body' is set
|
|
13608
|
+
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']);}/**
|
|
13369
13609
|
* Update wrap-up code
|
|
13370
13610
|
*
|
|
13371
13611
|
* @param {String} codeId Wrapup Code ID
|
|
@@ -13391,7 +13631,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
13391
13631
|
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(){/**
|
|
13392
13632
|
* SCIM service.
|
|
13393
13633
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
13394
|
-
* @version
|
|
13634
|
+
* @version 185.0.0
|
|
13395
13635
|
*/ /**
|
|
13396
13636
|
* Constructs a new SCIMApi.
|
|
13397
13637
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -13616,7 +13856,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
13616
13856
|
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(){/**
|
|
13617
13857
|
* Scripts service.
|
|
13618
13858
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
13619
|
-
* @version
|
|
13859
|
+
* @version 185.0.0
|
|
13620
13860
|
*/ /**
|
|
13621
13861
|
* Constructs a new ScriptsApi.
|
|
13622
13862
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -13752,7 +13992,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
13752
13992
|
*/},{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(){/**
|
|
13753
13993
|
* Search service.
|
|
13754
13994
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
13755
|
-
* @version
|
|
13995
|
+
* @version 185.0.0
|
|
13756
13996
|
*/ /**
|
|
13757
13997
|
* Constructs a new SearchApi.
|
|
13758
13998
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -13912,7 +14152,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13912
14152
|
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(){/**
|
|
13913
14153
|
* Settings service.
|
|
13914
14154
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
13915
|
-
* @version
|
|
14155
|
+
* @version 185.0.0
|
|
13916
14156
|
*/ /**
|
|
13917
14157
|
* Constructs a new SettingsApi.
|
|
13918
14158
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -13930,7 +14170,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13930
14170
|
*/},{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(){/**
|
|
13931
14171
|
* SpeechTextAnalytics service.
|
|
13932
14172
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
13933
|
-
* @version
|
|
14173
|
+
* @version 185.0.0
|
|
13934
14174
|
*/ /**
|
|
13935
14175
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
13936
14176
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -14173,7 +14413,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
14173
14413
|
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(){/**
|
|
14174
14414
|
* Stations service.
|
|
14175
14415
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
14176
|
-
* @version
|
|
14416
|
+
* @version 185.0.0
|
|
14177
14417
|
*/ /**
|
|
14178
14418
|
* Constructs a new StationsApi.
|
|
14179
14419
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -14205,7 +14445,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
14205
14445
|
*/},{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(){/**
|
|
14206
14446
|
* Suggest service.
|
|
14207
14447
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
14208
|
-
* @version
|
|
14448
|
+
* @version 185.0.0
|
|
14209
14449
|
*/ /**
|
|
14210
14450
|
* Constructs a new SuggestApi.
|
|
14211
14451
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -14245,7 +14485,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14245
14485
|
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(){/**
|
|
14246
14486
|
* TaskManagement service.
|
|
14247
14487
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
14248
|
-
* @version
|
|
14488
|
+
* @version 185.0.0
|
|
14249
14489
|
*/ /**
|
|
14250
14490
|
* Constructs a new TaskManagementApi.
|
|
14251
14491
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -14587,7 +14827,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
14587
14827
|
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(){/**
|
|
14588
14828
|
* Teams service.
|
|
14589
14829
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
14590
|
-
* @version
|
|
14830
|
+
* @version 185.0.0
|
|
14591
14831
|
*/ /**
|
|
14592
14832
|
* Constructs a new TeamsApi.
|
|
14593
14833
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -14666,7 +14906,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14666
14906
|
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(){/**
|
|
14667
14907
|
* Telephony service.
|
|
14668
14908
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
14669
|
-
* @version
|
|
14909
|
+
* @version 185.0.0
|
|
14670
14910
|
*/ /**
|
|
14671
14911
|
* Constructs a new TelephonyApi.
|
|
14672
14912
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -14715,7 +14955,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
14715
14955
|
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(){/**
|
|
14716
14956
|
* TelephonyProvidersEdge service.
|
|
14717
14957
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
14718
|
-
* @version
|
|
14958
|
+
* @version 185.0.0
|
|
14719
14959
|
*/ /**
|
|
14720
14960
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
14721
14961
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -14893,8 +15133,9 @@ if(edgeId===undefined||edgeId===null){throw'Missing the required parameter "edge
|
|
|
14893
15133
|
* @param {Boolean} opts.managed Filter by managed
|
|
14894
15134
|
* @param {Boolean} opts.showCloudMedia True to show the cloud media devices in the result. (default to true)
|
|
14895
15135
|
*/},{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']);}/**
|
|
14896
|
-
* Get the list of available languages.
|
|
15136
|
+
* Get the list of available languages. For never released keyword spotting feature. Deprecated, do not use.
|
|
14897
15137
|
*
|
|
15138
|
+
* @deprecated
|
|
14898
15139
|
*/},{key:"getTelephonyProvidersEdgesAvailablelanguages",value:function getTelephonyProvidersEdgesAvailablelanguages(){return this.apiClient.callApi('/api/v2/telephony/providers/edges/availablelanguages','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14899
15140
|
* Get the list of certificate authorities.
|
|
14900
15141
|
*
|
|
@@ -15534,7 +15775,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
15534
15775
|
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(){/**
|
|
15535
15776
|
* Textbots service.
|
|
15536
15777
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
15537
|
-
* @version
|
|
15778
|
+
* @version 185.0.0
|
|
15538
15779
|
*/ /**
|
|
15539
15780
|
* Constructs a new TextbotsApi.
|
|
15540
15781
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -15569,7 +15810,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
15569
15810
|
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(){/**
|
|
15570
15811
|
* Tokens service.
|
|
15571
15812
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
15572
|
-
* @version
|
|
15813
|
+
* @version 185.0.0
|
|
15573
15814
|
*/ /**
|
|
15574
15815
|
* Constructs a new TokensApi.
|
|
15575
15816
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -15605,7 +15846,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15605
15846
|
*/},{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(){/**
|
|
15606
15847
|
* Uploads service.
|
|
15607
15848
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
15608
|
-
* @version
|
|
15849
|
+
* @version 185.0.0
|
|
15609
15850
|
*/ /**
|
|
15610
15851
|
* Constructs a new UploadsApi.
|
|
15611
15852
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -15647,7 +15888,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15647
15888
|
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(){/**
|
|
15648
15889
|
* Usage service.
|
|
15649
15890
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
15650
|
-
* @version
|
|
15891
|
+
* @version 185.0.0
|
|
15651
15892
|
*/ /**
|
|
15652
15893
|
* Constructs a new UsageApi.
|
|
15653
15894
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -15698,7 +15939,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15698
15939
|
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(){/**
|
|
15699
15940
|
* UserRecordings service.
|
|
15700
15941
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
15701
|
-
* @version
|
|
15942
|
+
* @version 185.0.0
|
|
15702
15943
|
*/ /**
|
|
15703
15944
|
* Constructs a new UserRecordingsApi.
|
|
15704
15945
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -15747,7 +15988,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
15747
15988
|
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(){/**
|
|
15748
15989
|
* Users service.
|
|
15749
15990
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
15750
|
-
* @version
|
|
15991
|
+
* @version 185.0.0
|
|
15751
15992
|
*/ /**
|
|
15752
15993
|
* Constructs a new UsersApi.
|
|
15753
15994
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -16406,7 +16647,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
16406
16647
|
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(){/**
|
|
16407
16648
|
* Utilities service.
|
|
16408
16649
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
16409
|
-
* @version
|
|
16650
|
+
* @version 185.0.0
|
|
16410
16651
|
*/ /**
|
|
16411
16652
|
* Constructs a new UtilitiesApi.
|
|
16412
16653
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -16433,7 +16674,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16433
16674
|
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(){/**
|
|
16434
16675
|
* Voicemail service.
|
|
16435
16676
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
16436
|
-
* @version
|
|
16677
|
+
* @version 185.0.0
|
|
16437
16678
|
*/ /**
|
|
16438
16679
|
* Constructs a new VoicemailApi.
|
|
16439
16680
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -16582,7 +16823,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
16582
16823
|
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(){/**
|
|
16583
16824
|
* WebChat service.
|
|
16584
16825
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
16585
|
-
* @version
|
|
16826
|
+
* @version 185.0.0
|
|
16586
16827
|
*/ /**
|
|
16587
16828
|
* Constructs a new WebChatApi.
|
|
16588
16829
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -16715,7 +16956,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16715
16956
|
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(){/**
|
|
16716
16957
|
* WebDeployments service.
|
|
16717
16958
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
16718
|
-
* @version
|
|
16959
|
+
* @version 185.0.0
|
|
16719
16960
|
*/ /**
|
|
16720
16961
|
* Constructs a new WebDeploymentsApi.
|
|
16721
16962
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -16836,7 +17077,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
16836
17077
|
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(){/**
|
|
16837
17078
|
* WebMessaging service.
|
|
16838
17079
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
16839
|
-
* @version
|
|
17080
|
+
* @version 185.0.0
|
|
16840
17081
|
*/ /**
|
|
16841
17082
|
* Constructs a new WebMessagingApi.
|
|
16842
17083
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -16852,7 +17093,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
16852
17093
|
*/_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(){/**
|
|
16853
17094
|
* Widgets service.
|
|
16854
17095
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
16855
|
-
* @version
|
|
17096
|
+
* @version 185.0.0
|
|
16856
17097
|
*/ /**
|
|
16857
17098
|
* Constructs a new WidgetsApi.
|
|
16858
17099
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -16887,7 +17128,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
16887
17128
|
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(){/**
|
|
16888
17129
|
* WorkforceManagement service.
|
|
16889
17130
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
16890
|
-
* @version
|
|
17131
|
+
* @version 185.0.0
|
|
16891
17132
|
*/ /**
|
|
16892
17133
|
* Constructs a new WorkforceManagementApi.
|
|
16893
17134
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -17156,6 +17397,26 @@ if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required
|
|
|
17156
17397
|
if(weekId===undefined||weekId===null){throw'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent';}// verify the required parameter 'scheduleId' is set
|
|
17157
17398
|
if(scheduleId===undefined||scheduleId===null){throw'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent';}// verify the required parameter 'agentId' is set
|
|
17158
17399
|
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']);}/**
|
|
17400
|
+
* Get the performance prediction for the associated schedule
|
|
17401
|
+
*
|
|
17402
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
17403
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
17404
|
+
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
17405
|
+
*/},{key:"getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions",value:function getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions(businessUnitId,weekId,scheduleId){// verify the required parameter 'businessUnitId' is set
|
|
17406
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';}// verify the required parameter 'weekId' is set
|
|
17407
|
+
if(weekId===undefined||weekId===null){throw'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';}// verify the required parameter 'scheduleId' is set
|
|
17408
|
+
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']);}/**
|
|
17409
|
+
* Get recalculated performance prediction result
|
|
17410
|
+
*
|
|
17411
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
17412
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
17413
|
+
* @param {String} scheduleId The ID of the schedule the recalculation belongs to
|
|
17414
|
+
* @param {String} recalculationId The ID of the recalculation request
|
|
17415
|
+
*/},{key:"getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation",value:function getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation(businessUnitId,weekId,scheduleId,recalculationId){// verify the required parameter 'businessUnitId' is set
|
|
17416
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';}// verify the required parameter 'weekId' is set
|
|
17417
|
+
if(weekId===undefined||weekId===null){throw'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';}// verify the required parameter 'scheduleId' is set
|
|
17418
|
+
if(scheduleId===undefined||scheduleId===null){throw'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';}// verify the required parameter 'recalculationId' is set
|
|
17419
|
+
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']);}/**
|
|
17159
17420
|
* Get the list of week schedules for the specified week
|
|
17160
17421
|
* 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
|
|
17161
17422
|
* @param {String} businessUnitId The ID of the business unit
|
|
@@ -17218,6 +17479,17 @@ if(forecastId===undefined||forecastId===null){throw'Missing the required paramet
|
|
|
17218
17479
|
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups';}// verify the required parameter 'weekDateId' is set
|
|
17219
17480
|
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups';}// verify the required parameter 'forecastId' is set
|
|
17220
17481
|
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']);}/**
|
|
17482
|
+
* Get the staffing requirement by planning group for a forecast
|
|
17483
|
+
*
|
|
17484
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
17485
|
+
* @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
|
|
17486
|
+
* @param {String} forecastId The ID of the forecast
|
|
17487
|
+
* @param {Object} opts Optional parameters
|
|
17488
|
+
* @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
|
|
17489
|
+
*/},{key:"getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement",value:function getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement(businessUnitId,weekDateId,forecastId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
17490
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';}// verify the required parameter 'weekDateId' is set
|
|
17491
|
+
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';}// verify the required parameter 'forecastId' is set
|
|
17492
|
+
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']);}/**
|
|
17221
17493
|
* Get short term forecasts
|
|
17222
17494
|
* 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
|
|
17223
17495
|
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
@@ -17534,6 +17806,13 @@ if(serviceGoalTemplateId===undefined||serviceGoalTemplateId===null){throw'Missin
|
|
|
17534
17806
|
* @param {Object} opts.body body
|
|
17535
17807
|
*/},{key:"patchWorkforcemanagementManagementunit",value:function patchWorkforcemanagementManagementunit(managementUnitId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
17536
17808
|
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']);}/**
|
|
17809
|
+
* Update agent configurations
|
|
17810
|
+
*
|
|
17811
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
17812
|
+
* @param {Object} opts Optional parameters
|
|
17813
|
+
* @param {Object} opts.body body
|
|
17814
|
+
*/},{key:"patchWorkforcemanagementManagementunitAgents",value:function patchWorkforcemanagementManagementunitAgents(managementUnitId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
17815
|
+
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']);}/**
|
|
17537
17816
|
* Updates a time off limit object.
|
|
17538
17817
|
* Updates time off limit object properties, but not daily values.
|
|
17539
17818
|
* @param {String} managementUnitId The ID of the management unit.
|
|
@@ -17745,6 +18024,28 @@ if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required
|
|
|
17745
18024
|
if(weekId===undefined||weekId===null){throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekScheduleCopy';}// verify the required parameter 'scheduleId' is set
|
|
17746
18025
|
if(scheduleId===undefined||scheduleId===null){throw'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekScheduleCopy';}// verify the required parameter 'body' is set
|
|
17747
18026
|
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']);}/**
|
|
18027
|
+
* Request a daily recalculation of the performance prediction for the associated schedule
|
|
18028
|
+
*
|
|
18029
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
18030
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
18031
|
+
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
18032
|
+
* @param {Object} opts Optional parameters
|
|
18033
|
+
* @param {Object} opts.body body
|
|
18034
|
+
*/},{key:"postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations",value:function postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations(businessUnitId,weekId,scheduleId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
18035
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';}// verify the required parameter 'weekId' is set
|
|
18036
|
+
if(weekId===undefined||weekId===null){throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';}// verify the required parameter 'scheduleId' is set
|
|
18037
|
+
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']);}/**
|
|
18038
|
+
* Upload daily activity changes to be able to request a performance prediction recalculation
|
|
18039
|
+
*
|
|
18040
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
18041
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
18042
|
+
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
18043
|
+
* @param {Object} opts Optional parameters
|
|
18044
|
+
* @param {Object} opts.body body
|
|
18045
|
+
*/},{key:"postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl",value:function postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl(businessUnitId,weekId,scheduleId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
18046
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';}// verify the required parameter 'weekId' is set
|
|
18047
|
+
if(weekId===undefined||weekId===null){throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';}// verify the required parameter 'scheduleId' is set
|
|
18048
|
+
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']);}/**
|
|
17748
18049
|
* Start a rescheduling run
|
|
17749
18050
|
*
|
|
17750
18051
|
* @param {String} businessUnitId The ID of the business unit
|
|
@@ -18178,7 +18479,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
18178
18479
|
* </pre>
|
|
18179
18480
|
* </p>
|
|
18180
18481
|
* @module purecloud-platform-client-v2/index
|
|
18181
|
-
* @version
|
|
18482
|
+
* @version 185.0.0
|
|
18182
18483
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
18183
18484
|
* The ApiClient constructor.
|
|
18184
18485
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|
|
@@ -18285,6 +18586,9 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
18285
18586
|
* The LocationsApi service constructor.
|
|
18286
18587
|
* @property {module:purecloud-platform-client-v2/api/LocationsApi}
|
|
18287
18588
|
*/this.LocationsApi=LocationsApi;/**
|
|
18589
|
+
* The LogCaptureApi service constructor.
|
|
18590
|
+
* @property {module:purecloud-platform-client-v2/api/LogCaptureApi}
|
|
18591
|
+
*/this.LogCaptureApi=LogCaptureApi;/**
|
|
18288
18592
|
* The MessagingApi service constructor.
|
|
18289
18593
|
* @property {module:purecloud-platform-client-v2/api/MessagingApi}
|
|
18290
18594
|
*/this.MessagingApi=MessagingApi;/**
|