purecloud-platform-client-v2 184.0.0 → 186.0.1
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 +1103 -156
- package/dist/web-amd/purecloud-platform-client-v2.js +1103 -156
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +349 -140
- package/dist/web-cjs/purecloud-platform-client-v2.js +354 -142
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +711 -161
- package/package.json +2 -2
- 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 +1 -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 +3 -4
- 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 +58 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -62
- 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 +7 -7
- 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 +26 -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 +131 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +2 -3
- 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 +1 -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 +2 -2
- 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 +247 -2
- 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 -3
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +5 -4
- 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 +1 -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(arg){var key=_toPrimitive(arg,"string");return _typeof(key)==="symbol"?key:String(key);}function _toPrimitive(input,hint){if(_typeof(input)!=="object"||input===null)return input;var prim=input[Symbol.toPrimitive];if(prim!==undefined){var res=prim.call(input,hint||"default");if(_typeof(res)!=="object")return res;throw new TypeError("@@toPrimitive must return a primitive value.");}return(hint==="string"?String:Number)(input);}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)
|
|
1
|
+
'use strict';function _regeneratorRuntime(){"use strict";/*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */_regeneratorRuntime=function _regeneratorRuntime(){return e;};var t,e={},r=Object.prototype,n=r.hasOwnProperty,o=Object.defineProperty||function(t,e,r){t[e]=r.value;},i="function"==typeof Symbol?Symbol:{},a=i.iterator||"@@iterator",c=i.asyncIterator||"@@asyncIterator",u=i.toStringTag||"@@toStringTag";function define(t,e,r){return Object.defineProperty(t,e,{value:r,enumerable:!0,configurable:!0,writable:!0}),t[e];}try{define({},"");}catch(t){define=function define(t,e,r){return t[e]=r;};}function wrap(t,e,r,n){var i=e&&e.prototype instanceof Generator?e:Generator,a=Object.create(i.prototype),c=new Context(n||[]);return o(a,"_invoke",{value:makeInvokeMethod(t,r,c)}),a;}function tryCatch(t,e,r){try{return{type:"normal",arg:t.call(e,r)};}catch(t){return{type:"throw",arg:t};}}e.wrap=wrap;var h="suspendedStart",l="suspendedYield",f="executing",s="completed",y={};function Generator(){}function GeneratorFunction(){}function GeneratorFunctionPrototype(){}var p={};define(p,a,function(){return this;});var d=Object.getPrototypeOf,v=d&&d(d(values([])));v&&v!==r&&n.call(v,a)&&(p=v);var g=GeneratorFunctionPrototype.prototype=Generator.prototype=Object.create(p);function defineIteratorMethods(t){["next","throw","return"].forEach(function(e){define(t,e,function(t){return this._invoke(e,t);});});}function AsyncIterator(t,e){function invoke(r,o,i,a){var c=tryCatch(t[r],t,o);if("throw"!==c.type){var u=c.arg,h=u.value;return h&&"object"==_typeof(h)&&n.call(h,"__await")?e.resolve(h.__await).then(function(t){invoke("next",t,i,a);},function(t){invoke("throw",t,i,a);}):e.resolve(h).then(function(t){u.value=t,i(u);},function(t){return invoke("throw",t,i,a);});}a(c.arg);}var r;o(this,"_invoke",{value:function value(t,n){function callInvokeWithMethodAndArg(){return new e(function(e,r){invoke(t,n,e,r);});}return r=r?r.then(callInvokeWithMethodAndArg,callInvokeWithMethodAndArg):callInvokeWithMethodAndArg();}});}function makeInvokeMethod(e,r,n){var o=h;return function(i,a){if(o===f)throw new Error("Generator is already running");if(o===s){if("throw"===i)throw a;return{value:t,done:!0};}for(n.method=i,n.arg=a;;){var c=n.delegate;if(c){var u=maybeInvokeDelegate(c,n);if(u){if(u===y)continue;return u;}}if("next"===n.method)n.sent=n._sent=n.arg;else if("throw"===n.method){if(o===h)throw o=s,n.arg;n.dispatchException(n.arg);}else"return"===n.method&&n.abrupt("return",n.arg);o=f;var p=tryCatch(e,r,n);if("normal"===p.type){if(o=n.done?s:l,p.arg===y)continue;return{value:p.arg,done:n.done};}"throw"===p.type&&(o=s,n.method="throw",n.arg=p.arg);}};}function maybeInvokeDelegate(e,r){var n=r.method,o=e.iterator[n];if(o===t)return r.delegate=null,"throw"===n&&e.iterator["return"]&&(r.method="return",r.arg=t,maybeInvokeDelegate(e,r),"throw"===r.method)||"return"!==n&&(r.method="throw",r.arg=new TypeError("The iterator does not provide a '"+n+"' method")),y;var i=tryCatch(o,e.iterator,r.arg);if("throw"===i.type)return r.method="throw",r.arg=i.arg,r.delegate=null,y;var a=i.arg;return a?a.done?(r[e.resultName]=a.value,r.next=e.nextLoc,"return"!==r.method&&(r.method="next",r.arg=t),r.delegate=null,y):a:(r.method="throw",r.arg=new TypeError("iterator result is not an object"),r.delegate=null,y);}function pushTryEntry(t){var e={tryLoc:t[0]};1 in t&&(e.catchLoc=t[1]),2 in t&&(e.finallyLoc=t[2],e.afterLoc=t[3]),this.tryEntries.push(e);}function resetTryEntry(t){var e=t.completion||{};e.type="normal",delete e.arg,t.completion=e;}function Context(t){this.tryEntries=[{tryLoc:"root"}],t.forEach(pushTryEntry,this),this.reset(!0);}function values(e){if(e||""===e){var r=e[a];if(r)return r.call(e);if("function"==typeof e.next)return e;if(!isNaN(e.length)){var o=-1,i=function next(){for(;++o<e.length;)if(n.call(e,o))return next.value=e[o],next.done=!1,next;return next.value=t,next.done=!0,next;};return i.next=i;}}throw new TypeError(_typeof(e)+" is not iterable");}return GeneratorFunction.prototype=GeneratorFunctionPrototype,o(g,"constructor",{value:GeneratorFunctionPrototype,configurable:!0}),o(GeneratorFunctionPrototype,"constructor",{value:GeneratorFunction,configurable:!0}),GeneratorFunction.displayName=define(GeneratorFunctionPrototype,u,"GeneratorFunction"),e.isGeneratorFunction=function(t){var e="function"==typeof t&&t.constructor;return!!e&&(e===GeneratorFunction||"GeneratorFunction"===(e.displayName||e.name));},e.mark=function(t){return Object.setPrototypeOf?Object.setPrototypeOf(t,GeneratorFunctionPrototype):(t.__proto__=GeneratorFunctionPrototype,define(t,u,"GeneratorFunction")),t.prototype=Object.create(g),t;},e.awrap=function(t){return{__await:t};},defineIteratorMethods(AsyncIterator.prototype),define(AsyncIterator.prototype,c,function(){return this;}),e.AsyncIterator=AsyncIterator,e.async=function(t,r,n,o,i){void 0===i&&(i=Promise);var a=new AsyncIterator(wrap(t,r,n,o),i);return e.isGeneratorFunction(r)?a:a.next().then(function(t){return t.done?t.value:a.next();});},defineIteratorMethods(g),define(g,u,"Generator"),define(g,a,function(){return this;}),define(g,"toString",function(){return"[object Generator]";}),e.keys=function(t){var e=Object(t),r=[];for(var n in e)r.push(n);return r.reverse(),function next(){for(;r.length;){var t=r.pop();if(t in e)return next.value=t,next.done=!1,next;}return next.done=!0,next;};},e.values=values,Context.prototype={constructor:Context,reset:function reset(e){if(this.prev=0,this.next=0,this.sent=this._sent=t,this.done=!1,this.delegate=null,this.method="next",this.arg=t,this.tryEntries.forEach(resetTryEntry),!e)for(var r in this)"t"===r.charAt(0)&&n.call(this,r)&&!isNaN(+r.slice(1))&&(this[r]=t);},stop:function stop(){this.done=!0;var t=this.tryEntries[0].completion;if("throw"===t.type)throw t.arg;return this.rval;},dispatchException:function dispatchException(e){if(this.done)throw e;var r=this;function handle(n,o){return a.type="throw",a.arg=e,r.next=n,o&&(r.method="next",r.arg=t),!!o;}for(var o=this.tryEntries.length-1;o>=0;--o){var i=this.tryEntries[o],a=i.completion;if("root"===i.tryLoc)return handle("end");if(i.tryLoc<=this.prev){var c=n.call(i,"catchLoc"),u=n.call(i,"finallyLoc");if(c&&u){if(this.prev<i.catchLoc)return handle(i.catchLoc,!0);if(this.prev<i.finallyLoc)return handle(i.finallyLoc);}else if(c){if(this.prev<i.catchLoc)return handle(i.catchLoc,!0);}else{if(!u)throw new Error("try statement without catch or finally");if(this.prev<i.finallyLoc)return handle(i.finallyLoc);}}}},abrupt:function abrupt(t,e){for(var r=this.tryEntries.length-1;r>=0;--r){var o=this.tryEntries[r];if(o.tryLoc<=this.prev&&n.call(o,"finallyLoc")&&this.prev<o.finallyLoc){var i=o;break;}}i&&("break"===t||"continue"===t)&&i.tryLoc<=e&&e<=i.finallyLoc&&(i=null);var a=i?i.completion:{};return a.type=t,a.arg=e,i?(this.method="next",this.next=i.finallyLoc,y):this.complete(a);},complete:function complete(t,e){if("throw"===t.type)throw t.arg;return"break"===t.type||"continue"===t.type?this.next=t.arg:"return"===t.type?(this.rval=this.arg=t.arg,this.method="return",this.next="end"):"normal"===t.type&&e&&(this.next=e),y;},finish:function finish(t){for(var e=this.tryEntries.length-1;e>=0;--e){var r=this.tryEntries[e];if(r.finallyLoc===t)return this.complete(r.completion,r.afterLoc),resetTryEntry(r),y;}},"catch":function _catch(t){for(var e=this.tryEntries.length-1;e>=0;--e){var r=this.tryEntries[e];if(r.tryLoc===t){var n=r.completion;if("throw"===n.type){var o=n.arg;resetTryEntry(r);}return o;}}throw new Error("illegal catch attempt");},delegateYield:function delegateYield(e,r,n){return this.delegate={iterator:values(e),resultName:r,nextLoc:n},"next"===this.method&&(this.arg=t),y;}},e;}function asyncGeneratorStep(gen,resolve,reject,_next,_throw,key,arg){try{var info=gen[key](arg);var value=info.value;}catch(error){reject(error);return;}if(info.done){resolve(value);}else{Promise.resolve(value).then(_next,_throw);}}function _asyncToGenerator(fn){return function(){var self=this,args=arguments;return new Promise(function(resolve,reject){var gen=fn.apply(self,args);function _next(value){asyncGeneratorStep(gen,resolve,reject,_next,_throw,"next",value);}function _throw(err){asyncGeneratorStep(gen,resolve,reject,_next,_throw,"throw",err);}_next(undefined);});};}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
|
|
@@ -570,7 +570,7 @@ return utils$1.matchAll(/\w+|\[(\w*)]/g,name).map(function(match){return match[0
|
|
|
570
570
|
* @param {string} formData The FormData object to convert to JSON.
|
|
571
571
|
*
|
|
572
572
|
* @returns {Object<string, any> | null} The converted object.
|
|
573
|
-
*/function formDataToJSON(formData){function buildPath(path,value,target,index){var name=path[index++];var isNumericKey=Number.isFinite(+name);var isLast=index>=path.length;name=!name&&utils$1.isArray(target)?target.length:name;if(isLast){if(utils$1.hasOwnProp(target,name)){target[name]=[target[name],value];}else{target[name]=value;}return!isNumericKey;}if(!target[name]||!utils$1.isObject(target[name])){target[name]=[];}var result=buildPath(path,value,target[name],index);if(result&&utils$1.isArray(target[name])){target[name]=arrayToObject(target[name]);}return!isNumericKey;}if(utils$1.isFormData(formData)&&utils$1.isFunction(formData.entries)){var obj={};utils$1.forEachEntry(formData,function(name,value){buildPath(parsePropPath(name),value,obj,0);});return obj;}return null;}/**
|
|
573
|
+
*/function formDataToJSON(formData){function buildPath(path,value,target,index){var name=path[index++];if(name==='__proto__')return true;var isNumericKey=Number.isFinite(+name);var isLast=index>=path.length;name=!name&&utils$1.isArray(target)?target.length:name;if(isLast){if(utils$1.hasOwnProp(target,name)){target[name]=[target[name],value];}else{target[name]=value;}return!isNumericKey;}if(!target[name]||!utils$1.isObject(target[name])){target[name]=[];}var result=buildPath(path,value,target[name],index);if(result&&utils$1.isArray(target[name])){target[name]=arrayToObject(target[name]);}return!isNumericKey;}if(utils$1.isFormData(formData)&&utils$1.isFunction(formData.entries)){var obj={};utils$1.forEachEntry(formData,function(name,value){buildPath(parsePropPath(name),value,obj,0);});return obj;}return null;}/**
|
|
574
574
|
* It takes a string, tries to parse it, and if it fails, it returns the stringified version
|
|
575
575
|
* of the input
|
|
576
576
|
*
|
|
@@ -641,7 +641,7 @@ return /^([a-z][a-z\d+\-.]*:)?\/\//i.test(url);}/**
|
|
|
641
641
|
* @param {string} relativeURL The relative URL
|
|
642
642
|
*
|
|
643
643
|
* @returns {string} The combined URL
|
|
644
|
-
*/function combineURLs(baseURL,relativeURL){return relativeURL?baseURL.replace(
|
|
644
|
+
*/function combineURLs(baseURL,relativeURL){return relativeURL?baseURL.replace(/\/?\/$/,'')+'/'+relativeURL.replace(/^\/+/,''):baseURL;}/**
|
|
645
645
|
* Creates a new URL by combining the baseURL with the requestedURL,
|
|
646
646
|
* only when the requestedURL is not already an absolute URL.
|
|
647
647
|
* If the requestURL is absolute, this function returns the requestedURL untouched.
|
|
@@ -734,7 +734,7 @@ config2=config2||{};var config={};function getMergedValue(target,source,caseless
|
|
|
734
734
|
function mergeDeepProperties(a,b,caseless){if(!utils$1.isUndefined(b)){return getMergedValue(a,b,caseless);}else if(!utils$1.isUndefined(a)){return getMergedValue(undefined,a,caseless);}}// eslint-disable-next-line consistent-return
|
|
735
735
|
function valueFromConfig2(a,b){if(!utils$1.isUndefined(b)){return getMergedValue(undefined,b);}}// eslint-disable-next-line consistent-return
|
|
736
736
|
function defaultToConfig2(a,b){if(!utils$1.isUndefined(b)){return getMergedValue(undefined,b);}else if(!utils$1.isUndefined(a)){return getMergedValue(undefined,a);}}// eslint-disable-next-line consistent-return
|
|
737
|
-
function mergeDirectKeys(a,b,prop){if(prop in config2){return getMergedValue(a,b);}else if(prop in config1){return getMergedValue(undefined,a);}}var mergeMap={url:valueFromConfig2,method:valueFromConfig2,data:valueFromConfig2,baseURL:defaultToConfig2,transformRequest:defaultToConfig2,transformResponse:defaultToConfig2,paramsSerializer:defaultToConfig2,timeout:defaultToConfig2,timeoutMessage:defaultToConfig2,withCredentials:defaultToConfig2,withXSRFToken:defaultToConfig2,adapter:defaultToConfig2,responseType:defaultToConfig2,xsrfCookieName:defaultToConfig2,xsrfHeaderName:defaultToConfig2,onUploadProgress:defaultToConfig2,onDownloadProgress:defaultToConfig2,decompress:defaultToConfig2,maxContentLength:defaultToConfig2,maxBodyLength:defaultToConfig2,beforeRedirect:defaultToConfig2,transport:defaultToConfig2,httpAgent:defaultToConfig2,httpsAgent:defaultToConfig2,cancelToken:defaultToConfig2,socketPath:defaultToConfig2,responseEncoding:defaultToConfig2,validateStatus:mergeDirectKeys,headers:function headers(a,b){return mergeDeepProperties(headersToObject(a),headersToObject(b),true);}};utils$1.forEach(Object.keys(Object.assign({},config1,config2)),function computeConfigValue(prop){var merge=mergeMap[prop]||mergeDeepProperties;var configValue=merge(config1[prop],config2[prop],prop);utils$1.isUndefined(configValue)&&merge!==mergeDirectKeys||(config[prop]=configValue);});return config;}var VERSION="1.6.
|
|
737
|
+
function mergeDirectKeys(a,b,prop){if(prop in config2){return getMergedValue(a,b);}else if(prop in config1){return getMergedValue(undefined,a);}}var mergeMap={url:valueFromConfig2,method:valueFromConfig2,data:valueFromConfig2,baseURL:defaultToConfig2,transformRequest:defaultToConfig2,transformResponse:defaultToConfig2,paramsSerializer:defaultToConfig2,timeout:defaultToConfig2,timeoutMessage:defaultToConfig2,withCredentials:defaultToConfig2,withXSRFToken:defaultToConfig2,adapter:defaultToConfig2,responseType:defaultToConfig2,xsrfCookieName:defaultToConfig2,xsrfHeaderName:defaultToConfig2,onUploadProgress:defaultToConfig2,onDownloadProgress:defaultToConfig2,decompress:defaultToConfig2,maxContentLength:defaultToConfig2,maxBodyLength:defaultToConfig2,beforeRedirect:defaultToConfig2,transport:defaultToConfig2,httpAgent:defaultToConfig2,httpsAgent:defaultToConfig2,cancelToken:defaultToConfig2,socketPath:defaultToConfig2,responseEncoding:defaultToConfig2,validateStatus:mergeDirectKeys,headers:function headers(a,b){return mergeDeepProperties(headersToObject(a),headersToObject(b),true);}};utils$1.forEach(Object.keys(Object.assign({},config1,config2)),function computeConfigValue(prop){var merge=mergeMap[prop]||mergeDeepProperties;var configValue=merge(config1[prop],config2[prop],prop);utils$1.isUndefined(configValue)&&merge!==mergeDirectKeys||(config[prop]=configValue);});return config;}var VERSION="1.6.6";var validators$1={};// eslint-disable-next-line func-names
|
|
738
738
|
['object','boolean','number','function','string','symbol'].forEach(function(type,i){validators$1[type]=function validator(thing){return _typeof(thing)===type||'a'+(i<1?'n ':' ')+type;};});var deprecatedWarnings={};/**
|
|
739
739
|
* Transitional option validator
|
|
740
740
|
*
|
|
@@ -766,7 +766,9 @@ console.warn(formatMessage(opt,' has been deprecated since v'+version+' and will
|
|
|
766
766
|
* @param {?Object} config
|
|
767
767
|
*
|
|
768
768
|
* @returns {Promise} The Promise to be fulfilled
|
|
769
|
-
*/_createClass(Axios,[{key:"request",value:function
|
|
769
|
+
*/_createClass(Axios,[{key:"request",value:(function(){var _request2=_asyncToGenerator(/*#__PURE__*/_regeneratorRuntime().mark(function _callee(configOrUrl,config){var dummy;return _regeneratorRuntime().wrap(function _callee$(_context){while(1)switch(_context.prev=_context.next){case 0:_context.prev=0;_context.next=3;return this._request(configOrUrl,config);case 3:return _context.abrupt("return",_context.sent);case 6:_context.prev=6;_context.t0=_context["catch"](0);dummy={};if(Error.captureStackTrace){Error.captureStackTrace(dummy);}else{dummy.stack=new Error().stack;}// slice off the Error: ... line
|
|
770
|
+
dummy.stack=dummy.stack.replace(/^.+\n/,'');// match without the 2 top stack lines
|
|
771
|
+
if(!_context.t0.stack.endsWith(dummy.stack.replace(/^.+\n.+\n/,''))){_context.t0.stack+='\n'+dummy.stack;}throw _context.t0;case 13:case"end":return _context.stop();}},_callee,this,[[0,6]]);}));function request(_x,_x2){return _request2.apply(this,arguments);}return request;}())},{key:"_request",value:function _request(configOrUrl,config){/*eslint no-param-reassign:0*/ // Allow for axios('example/url'[, config]) a la fetch API
|
|
770
772
|
if(typeof configOrUrl==='string'){config=config||{};config.url=configOrUrl;}else{config=configOrUrl||{};}config=mergeConfig(this.defaults,config);var _config=config,transitional=_config.transitional,paramsSerializer=_config.paramsSerializer,headers=_config.headers;if(transitional!==undefined){validator.assertOptions(transitional,{silentJSONParsing:validators.transitional(validators["boolean"]),forcedJSONParsing:validators.transitional(validators["boolean"]),clarifyTimeoutError:validators.transitional(validators["boolean"])},false);}if(paramsSerializer!=null){if(utils$1.isFunction(paramsSerializer)){config.paramsSerializer={serialize:paramsSerializer};}else{validator.assertOptions(paramsSerializer,{encode:validators["function"],serialize:validators["function"]},true);}}// Set config.method
|
|
771
773
|
config.method=(config.method||this.defaults.method||'get').toLowerCase();// Flatten headers
|
|
772
774
|
var contextHeaders=headers&&utils$1.merge(headers.common,headers[config.method]);headers&&utils$1.forEach(['delete','get','head','post','put','patch','common'],function(method){delete headers[method];});config.headers=AxiosHeaders$1.concat(contextHeaders,headers);// filter out skipped interceptors
|
|
@@ -845,7 +847,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
845
847
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
846
848
|
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
849
|
* @module purecloud-platform-client-v2/ApiClient
|
|
848
|
-
* @version
|
|
850
|
+
* @version 186.0.1
|
|
849
851
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
850
852
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
851
853
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -947,47 +949,104 @@ _this3.config.logger.log('trace',response.status,'POST',"https://login.".concat(
|
|
|
947
949
|
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
950
|
resolve(_this3.authData);})["catch"](function(error){// Log error
|
|
949
951
|
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);});});}/**
|
|
952
|
+
* @description Completes the PKCE Code Authorization.
|
|
953
|
+
* @param {string} clientId - The client ID of an OAuth Code Authorization Grant client
|
|
954
|
+
* @param {string} codeVerifier - code verifier used to generate the code challenge
|
|
955
|
+
* @param {string} authCode - Authorization code
|
|
956
|
+
* @param {string} redirectUri - Authorized redirect URI for your Code Authorization client
|
|
957
|
+
*/},{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
|
|
958
|
+
request.then(function(response){// Logging
|
|
959
|
+
_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
|
|
960
|
+
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
|
|
961
|
+
resolve(_this4.authData);})["catch"](function(error){// Log error
|
|
962
|
+
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);});});}/**
|
|
963
|
+
* @description Generate a random string used as PKCE Code Verifier - length = 43 to 128.
|
|
964
|
+
* @param {number} nChar - code length
|
|
965
|
+
*/},{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
|
|
966
|
+
{var unreservedCharacters="0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-._~";var randomString=Array.from(crypto.getRandomValues(new Uint32Array(nChar))).map(function(x){return unreservedCharacters[x%unreservedCharacters.length];}).join('');return randomString;}}/**
|
|
967
|
+
* @description Compute Base64Url PKCE Code Challenge from Code Verifier.
|
|
968
|
+
* @param {string} code - code verifier used to generate the code challenge
|
|
969
|
+
*/},{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
|
|
970
|
+
{// browser
|
|
971
|
+
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
|
|
972
|
+
return reject(new Error("Code Challenge Error ".concat(error)));});});}}/**
|
|
973
|
+
* @description Initiates the pkce auth code grant login flow. Will attempt to load the token from local storage, if enabled.
|
|
974
|
+
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
975
|
+
* @param {string} redirectUri - The redirect URI of the OAuth Implicit Grant client
|
|
976
|
+
* @param {object} opts - (optional) Additional options
|
|
977
|
+
* @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.
|
|
978
|
+
* @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.
|
|
979
|
+
* @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.
|
|
980
|
+
* @param {string} codeVerifier - (optional) code verifier used to generate the code challenge
|
|
981
|
+
*/},{key:"loginPKCEGrant",value:function loginPKCEGrant(clientId,redirectUri,opts,codeVerifier){var _this5=this;// Need Local Storage or non null codeVerifier as parameter
|
|
982
|
+
if(!this.hasLocalStorage&&!codeVerifier){throw new Error("loginPKCEGrant requires Local Storage or codeVerifier as input parameter");}// Check for auth code in query
|
|
983
|
+
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
|
|
984
|
+
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
|
|
985
|
+
if(query&&query.error){// remove codeVerifier from session storage
|
|
986
|
+
if(_this5.hasLocalStorage){sessionStorage.removeItem("genesys_cloud_sdk_pkce_code_verifier");}// reset access token if any was stored
|
|
987
|
+
_this5._saveSettings({accessToken:undefined});return reject(new Error("[".concat(query.error,"] ").concat(query.error_description)));}// Get token on auth code
|
|
988
|
+
if(query&&query.code){if(!_this5.codeVerifier){// load codeVerifier from session storage
|
|
989
|
+
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
|
|
990
|
+
_this5._testTokenAccess().then(function(){if(!_this5.authData.state&&query.state)_this5.authData.state=query.state;// remove codeVerifier from session storage
|
|
991
|
+
if(_this5.hasLocalStorage){sessionStorage.removeItem("genesys_cloud_sdk_pkce_code_verifier");}resolve(_this5.authData);})["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)));});})["catch"](function(error){// Handle failure response
|
|
994
|
+
_this5._saveSettings({accessToken:undefined});// remove codeVerifier from session storage
|
|
995
|
+
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
|
|
996
|
+
_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
|
|
997
|
+
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,"]")));});});}});}/**
|
|
998
|
+
* @description Parses the URL Query, grabs the code, and clears the query param. If no code is found, no action is taken.
|
|
999
|
+
*/},{key:"_setValuesFromUrlQuery",value:function _setValuesFromUrlQuery(){// Check for window
|
|
1000
|
+
if(!(typeof window!=='undefined'&&window.location.search))return;// Process query string
|
|
1001
|
+
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
|
|
1002
|
+
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
|
|
1003
|
+
if(code){query.code=code;if(state){query.state=state;}}// Remove code from URL
|
|
1004
|
+
// Credit: https://stackoverflow.com/questions/1397329/how-to-remove-the-hash-from-window-location-with-javascript-without-page-refresh/5298684#5298684
|
|
1005
|
+
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
|
|
1006
|
+
scrollV=document.body.scrollTop;scrollH=document.body.scrollLeft;// Remove code
|
|
1007
|
+
history.pushState('',document.title,loc.pathname);// Restore the scroll offset, should be flicker free
|
|
1008
|
+
document.body.scrollTop=scrollV;document.body.scrollLeft=scrollH;}return query;}/**
|
|
950
1009
|
* @description Initiates the Code Authorization. Only available in node apps.
|
|
951
1010
|
* @param {string} clientId - The client ID of an OAuth Code Authorization Grant client
|
|
952
1011
|
* @param {string} clientSecret - The client secret of an OAuth Code Authorization Grant client
|
|
953
1012
|
* @param {string} authCode - Authorization code
|
|
954
1013
|
* @param {string} redirectUri - Authorized redirect URI for your Code Authorization client
|
|
955
|
-
*/},{key:"loginCodeAuthorizationGrant",value:function loginCodeAuthorizationGrant(clientId,clientSecret,authCode,redirectUri){var
|
|
956
|
-
|
|
1014
|
+
*/},{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
|
|
1015
|
+
_this6._handleCodeAuthorizationResponse(request,bodyParam,resolve,reject);});}/**
|
|
957
1016
|
* @description Requests a new access token for Code Authorization. Only available in node apps.
|
|
958
1017
|
* @param {string} clientId - The client ID of an OAuth Code Authorization Grant client
|
|
959
1018
|
* @param {string} clientSecret - The client secret of an OAuth Code Authorization Grant client
|
|
960
1019
|
* @param {string} authCode - Authorization code
|
|
961
1020
|
* @param {string} redirectUri - Authorized redirect URI for your Code Authorization client
|
|
962
|
-
*/},{key:"refreshCodeAuthorizationGrant",value:function refreshCodeAuthorizationGrant(clientId,clientSecret,refreshToken){var
|
|
963
|
-
|
|
1021
|
+
*/},{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
|
|
1022
|
+
_this7._handleCodeAuthorizationResponse(request,bodyParam,resolve,reject);});}/**
|
|
964
1023
|
* @description Handles the response for code auth requests
|
|
965
1024
|
* @param {object} request - Authorization request object
|
|
966
1025
|
* @param {object} bodyParam - Input body data for authorization request
|
|
967
1026
|
* @param {function} resolve - Promise resolve callback
|
|
968
1027
|
* @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){
|
|
1028
|
+
*/},{key:"_handleCodeAuthorizationResponse",value:function _handleCodeAuthorizationResponse(request,bodyParam,resolve,reject){var _this8=this;request.then(function(response){// Logging
|
|
1029
|
+
_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
|
|
1030
|
+
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
|
|
1031
|
+
resolve(_this8.authData);})["catch"](function(error){// Log error
|
|
1032
|
+
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
1033
|
* @description Utility function to create the request for auth requests
|
|
975
1034
|
* @param {string} encodedData - Base64 encoded client and clientSecret pair
|
|
976
1035
|
* @param {object} data - data to url form encode
|
|
977
1036
|
*/},{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
1037
|
* @description Handles an expired access token. Only available in node apps.
|
|
979
1038
|
* @param {string} statusCode - The status code of a request
|
|
980
|
-
*/},{key:"_handleExpiredAccessToken",value:function _handleExpiredAccessToken(){var
|
|
981
|
-
|
|
982
|
-
|
|
1039
|
+
*/},{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
|
|
1040
|
+
_this9.refreshInProgress=false;reject(err);});}else{// Wait refresh_token_wait_max seconds for other thread to complete refresh
|
|
1041
|
+
_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
1042
|
* @description Sleeps for a defined length
|
|
984
1043
|
* @param {int} millis - Length to sleep in milliseconds
|
|
985
1044
|
*/},{key:"_sleep",value:function _sleep(millis){return new Promise(function(resolve){return setTimeout(resolve,millis);});}/**
|
|
986
1045
|
* @description Loads token from storage, if enabled, and checks to ensure it works.
|
|
987
|
-
*/},{key:"_testTokenAccess",value:function _testTokenAccess(){var
|
|
988
|
-
|
|
989
|
-
if(!
|
|
990
|
-
|
|
1046
|
+
*/},{key:"_testTokenAccess",value:function _testTokenAccess(){var _this10=this;return new Promise(function(resolve,reject){// Load from storage
|
|
1047
|
+
_this10._loadSettings();// Check if there is a token to test
|
|
1048
|
+
if(!_this10.authentications['PureCloud OAuth'].accessToken){reject(new Error('Token is not set'));return;}// Test token
|
|
1049
|
+
_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
1050
|
* @description Parses the URL hash, grabs the access token, and clears the hash. If no access token is found, no action is taken.
|
|
992
1051
|
*/},{key:"_setValuesFromUrlHash",value:function _setValuesFromUrlHash(){// Check for window
|
|
993
1052
|
if(!(typeof window!=='undefined'&&window.location.hash))return;// Process hash string into object
|
|
@@ -1032,7 +1091,7 @@ this.setAccessToken(this.authentications['PureCloud OAuth'].accessToken);}/**
|
|
|
1032
1091
|
* @param {String} path The path to append to the base URL.
|
|
1033
1092
|
* @param {Object} pathParams The parameter values to append.
|
|
1034
1093
|
* @returns {String} The encoded path with parameter values substituted.
|
|
1035
|
-
*/},{key:"buildUrl",value:function buildUrl(path,pathParams){var
|
|
1094
|
+
*/},{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
1095
|
* Checks whether the given content type represents JSON.<br>
|
|
1037
1096
|
* JSON content type examples:<br>
|
|
1038
1097
|
* <ul>
|
|
@@ -1073,7 +1132,7 @@ return param.map(this.paramToString);default:throw new Error("Unknown collection
|
|
|
1073
1132
|
* Applies authentication headers to the request.
|
|
1074
1133
|
* @param {Object} request The axios request config object.
|
|
1075
1134
|
* @param {Array.<String>} authNames An array of authentication method names.
|
|
1076
|
-
*/},{key:"applyAuthToRequest",value:function applyAuthToRequest(request,authNames){var
|
|
1135
|
+
*/},{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
1136
|
* @description Sets the proxy agent axios will use for requests
|
|
1078
1137
|
* @param {any} agent - The proxy agent
|
|
1079
1138
|
*/},{key:"setProxyAgent",value:function setProxyAgent(agent){this.proxyAgent=agent;}/**
|
|
@@ -1090,7 +1149,7 @@ return param.map(this.paramToString);default:throw new Error("Unknown collection
|
|
|
1090
1149
|
* @param {Array.<String>} accepts An array of acceptable response MIME types.types or the
|
|
1091
1150
|
* constructor for a complex type.
|
|
1092
1151
|
* @returns {Promise} A Promise object.
|
|
1093
|
-
*/},{key:"callApi",value:function callApi(path,httpMethod,pathParams,queryParams,headerParams,formParams,bodyParam,authNames,contentTypes,accepts){var
|
|
1152
|
+
*/},{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
1153
|
that.applyAuthToRequest(request,authNames);// set header parameters
|
|
1095
1154
|
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
1155
|
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 +1159,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
1100
1159
|
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
1160
|
* Alerting service.
|
|
1102
1161
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1103
|
-
* @version
|
|
1162
|
+
* @version 186.0.1
|
|
1104
1163
|
*/ /**
|
|
1105
1164
|
* Constructs a new AlertingApi.
|
|
1106
1165
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -1257,7 +1316,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
1257
1316
|
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
1317
|
* Analytics service.
|
|
1259
1318
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1260
|
-
* @version
|
|
1319
|
+
* @version 186.0.1
|
|
1261
1320
|
*/ /**
|
|
1262
1321
|
* Constructs a new AnalyticsApi.
|
|
1263
1322
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -1864,7 +1923,7 @@ if(scheduleId===undefined||scheduleId===null){throw'Missing the required paramet
|
|
|
1864
1923
|
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(){/**
|
|
1865
1924
|
* Architect service.
|
|
1866
1925
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
1867
|
-
* @version
|
|
1926
|
+
* @version 186.0.1
|
|
1868
1927
|
*/ /**
|
|
1869
1928
|
* Constructs a new ArchitectApi.
|
|
1870
1929
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -2757,7 +2816,7 @@ if(datatableId===undefined||datatableId===null){throw'Missing the required param
|
|
|
2757
2816
|
if(datatableId===undefined||datatableId===null){throw'Missing the required parameter "datatableId" when calling postFlowsDatatableImportJobs';}// verify the required parameter 'body' is set
|
|
2758
2817
|
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']);}/**
|
|
2759
2818
|
* Create a new row entry for the datatable.
|
|
2760
|
-
* 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" }
|
|
2819
|
+
* 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" }
|
|
2761
2820
|
* @param {String} datatableId id of datatable
|
|
2762
2821
|
* @param {Object.<String, {String: Object}>} dataTableRow
|
|
2763
2822
|
*/},{key:"postFlowsDatatableRows",value:function postFlowsDatatableRows(datatableId,dataTableRow){// verify the required parameter 'datatableId' is set
|
|
@@ -2872,7 +2931,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2872
2931
|
if(datatableId===undefined||datatableId===null){throw'Missing the required parameter "datatableId" when calling putFlowsDatatable';}// verify the required parameter 'body' is set
|
|
2873
2932
|
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']);}/**
|
|
2874
2933
|
* Update a row entry
|
|
2875
|
-
* 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" }
|
|
2934
|
+
* 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" }
|
|
2876
2935
|
* @param {String} datatableId id of datatable
|
|
2877
2936
|
* @param {String} rowId the key for the row
|
|
2878
2937
|
* @param {Object} opts Optional parameters
|
|
@@ -2896,7 +2955,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
2896
2955
|
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(){/**
|
|
2897
2956
|
* Audit service.
|
|
2898
2957
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
2899
|
-
* @version
|
|
2958
|
+
* @version 186.0.1
|
|
2900
2959
|
*/ /**
|
|
2901
2960
|
* Constructs a new AuditApi.
|
|
2902
2961
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -2938,7 +2997,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
2938
2997
|
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(){/**
|
|
2939
2998
|
* Authorization service.
|
|
2940
2999
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
2941
|
-
* @version
|
|
3000
|
+
* @version 186.0.1
|
|
2942
3001
|
*/ /**
|
|
2943
3002
|
* Constructs a new AuthorizationApi.
|
|
2944
3003
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -2992,9 +3051,8 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
2992
3051
|
* @param {String} opts.nextPage next page token
|
|
2993
3052
|
* @param {String} opts.previousPage Previous page token
|
|
2994
3053
|
* @param {Boolean} opts.objectCount Include the count of objects contained in the division (default to false)
|
|
2995
|
-
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
2996
3054
|
* @param {String} opts.name Search term to filter by division name
|
|
2997
|
-
*/},{key:"getAuthorizationDivisions",value:function getAuthorizationDivisions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/authorization/divisions','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'nextPage':opts['nextPage'],'previousPage':opts['previousPage'],'objectCount':opts['objectCount'],'
|
|
3055
|
+
*/},{key:"getAuthorizationDivisions",value:function getAuthorizationDivisions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/authorization/divisions','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'nextPage':opts['nextPage'],'previousPage':opts['previousPage'],'objectCount':opts['objectCount'],'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
2998
3056
|
* Retrieve the home division for the organization.
|
|
2999
3057
|
* Will not include object counts.
|
|
3000
3058
|
*/},{key:"getAuthorizationDivisionsHome",value:function getAuthorizationDivisionsHome(){return this.apiClient.callApi('/api/v2/authorization/divisions/home','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -3043,7 +3101,7 @@ if(permission===undefined||permission===null){throw'Missing the required paramet
|
|
|
3043
3101
|
* Get the organization role specified by its ID.
|
|
3044
3102
|
* @param {String} roleId Role ID
|
|
3045
3103
|
* @param {Object} opts Optional parameters
|
|
3046
|
-
* @param {Object} opts.userCount Fetch the count of users who have this role granted in at least one division (default to true)
|
|
3104
|
+
* @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)
|
|
3047
3105
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand. unusedPermissions returns the permissions not used for the role
|
|
3048
3106
|
*/},{key:"getAuthorizationRole",value:function getAuthorizationRole(roleId,opts){opts=opts||{};// verify the required parameter 'roleId' is set
|
|
3049
3107
|
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']);}/**
|
|
@@ -3249,7 +3307,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
3249
3307
|
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(){/**
|
|
3250
3308
|
* Billing service.
|
|
3251
3309
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
3252
|
-
* @version
|
|
3310
|
+
* @version 186.0.1
|
|
3253
3311
|
*/ /**
|
|
3254
3312
|
* Constructs a new BillingApi.
|
|
3255
3313
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -3273,7 +3331,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
3273
3331
|
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(){/**
|
|
3274
3332
|
* CarrierServices service.
|
|
3275
3333
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
3276
|
-
* @version
|
|
3334
|
+
* @version 186.0.1
|
|
3277
3335
|
*/ /**
|
|
3278
3336
|
* Constructs a new CarrierServicesApi.
|
|
3279
3337
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -3293,7 +3351,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
3293
3351
|
*/},{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(){/**
|
|
3294
3352
|
* Chat service.
|
|
3295
3353
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
3296
|
-
* @version
|
|
3354
|
+
* @version 186.0.1
|
|
3297
3355
|
*/ /**
|
|
3298
3356
|
* Constructs a new ChatApi.
|
|
3299
3357
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -3412,6 +3470,12 @@ if(messageIds===undefined||messageIds===null){throw'Missing the required paramet
|
|
|
3412
3470
|
* getChatsUserMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3413
3471
|
*/},{key:"getChatsUserMessages",value:function getChatsUserMessages(userId,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
3414
3472
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getChatsUserMessages';}return this.apiClient.callApi('/api/v2/chats/users/{userId}/messages','GET',{'userId':userId},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'nextPage':opts['nextPage'],'previousPage':opts['previousPage'],'limit':opts['limit'],'before':opts['before'],'after':opts['after']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3473
|
+
* Get a user's chat settings
|
|
3474
|
+
*
|
|
3475
|
+
* @param {String} userId User ID
|
|
3476
|
+
* getChatsUserSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3477
|
+
*/},{key:"getChatsUserSettings",value:function getChatsUserSettings(userId){// verify the required parameter 'userId' is set
|
|
3478
|
+
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getChatsUserSettings';}return this.apiClient.callApi('/api/v2/chats/users/{userId}/settings','GET',{'userId':userId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3415
3479
|
* Set properties for a room
|
|
3416
3480
|
*
|
|
3417
3481
|
* @param {String} roomJid roomJid
|
|
@@ -3445,6 +3509,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3445
3509
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling patchChatsUserMessage';}// verify the required parameter 'messageId' is set
|
|
3446
3510
|
if(messageId===undefined||messageId===null){throw'Missing the required parameter "messageId" when calling patchChatsUserMessage';}// verify the required parameter 'body' is set
|
|
3447
3511
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchChatsUserMessage';}return this.apiClient.callApi('/api/v2/chats/users/{userId}/messages/{messageId}','PATCH',{'userId':userId,'messageId':messageId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3512
|
+
* Update a user's chat settings
|
|
3513
|
+
*
|
|
3514
|
+
* @param {String} userId User ID
|
|
3515
|
+
* @param {Object} body
|
|
3516
|
+
* patchChatsUserSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3517
|
+
*/},{key:"patchChatsUserSettings",value:function patchChatsUserSettings(userId,body){// verify the required parameter 'userId' is set
|
|
3518
|
+
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling patchChatsUserSettings';}// verify the required parameter 'body' is set
|
|
3519
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchChatsUserSettings';}return this.apiClient.callApi('/api/v2/chats/users/{userId}/settings','PATCH',{'userId':userId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3448
3520
|
* Send a message to a room
|
|
3449
3521
|
*
|
|
3450
3522
|
* @param {String} roomJid roomId
|
|
@@ -3490,7 +3562,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3490
3562
|
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(){/**
|
|
3491
3563
|
* Coaching service.
|
|
3492
3564
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
3493
|
-
* @version
|
|
3565
|
+
* @version 186.0.1
|
|
3494
3566
|
*/ /**
|
|
3495
3567
|
* Constructs a new CoachingApi.
|
|
3496
3568
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -3643,7 +3715,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
3643
3715
|
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(){/**
|
|
3644
3716
|
* ContentManagement service.
|
|
3645
3717
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
3646
|
-
* @version
|
|
3718
|
+
* @version 186.0.1
|
|
3647
3719
|
*/ /**
|
|
3648
3720
|
* Constructs a new ContentManagementApi.
|
|
3649
3721
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -3696,19 +3768,6 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
3696
3768
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
3697
3769
|
*/},{key:"getContentmanagementDocument",value:function getContentmanagementDocument(documentId,opts){opts=opts||{};// verify the required parameter 'documentId' is set
|
|
3698
3770
|
if(documentId===undefined||documentId===null){throw'Missing the required parameter "documentId" when calling getContentmanagementDocument';}return this.apiClient.callApi('/api/v2/contentmanagement/documents/{documentId}','GET',{'documentId':documentId},{'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3699
|
-
* Get a list of audits for a document.
|
|
3700
|
-
* This api is deprecated, use https://developer.genesys.cloud/platform/audit/ instead.
|
|
3701
|
-
* @param {String} documentId Document ID
|
|
3702
|
-
* @param {Object} opts Optional parameters
|
|
3703
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
3704
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
3705
|
-
* @param {String} opts.transactionFilter Transaction filter
|
|
3706
|
-
* @param {String} opts.level level (default to USER)
|
|
3707
|
-
* @param {String} opts.sortBy Sort by
|
|
3708
|
-
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
3709
|
-
* @deprecated
|
|
3710
|
-
*/},{key:"getContentmanagementDocumentAudits",value:function getContentmanagementDocumentAudits(documentId,opts){opts=opts||{};// verify the required parameter 'documentId' is set
|
|
3711
|
-
if(documentId===undefined||documentId===null){throw'Missing the required parameter "documentId" when calling getContentmanagementDocumentAudits';}return this.apiClient.callApi('/api/v2/contentmanagement/documents/{documentId}/audits','GET',{'documentId':documentId},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'transactionFilter':opts['transactionFilter'],'level':opts['level'],'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3712
3771
|
* Download a document.
|
|
3713
3772
|
*
|
|
3714
3773
|
* @param {String} documentId Document ID
|
|
@@ -3851,12 +3910,6 @@ if(workspaceId===undefined||workspaceId===null){throw'Missing the required param
|
|
|
3851
3910
|
* @param {Array.<String>} opts.access Requested access level.
|
|
3852
3911
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
3853
3912
|
*/},{key:"getContentmanagementWorkspaces",value:function getContentmanagementWorkspaces(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/contentmanagement/workspaces','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'access':this.apiClient.buildCollectionParam(opts['access'],'multi'),'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3854
|
-
* Query audits
|
|
3855
|
-
* This api is deprecated, use https://developer.genesys.cloud/platform/audit/ instead.
|
|
3856
|
-
* @param {Object} body Allows for a filtered query returning facet information
|
|
3857
|
-
* @deprecated
|
|
3858
|
-
*/},{key:"postContentmanagementAuditquery",value:function postContentmanagementAuditquery(body){// verify the required parameter 'body' is set
|
|
3859
|
-
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postContentmanagementAuditquery';}return this.apiClient.callApi('/api/v2/contentmanagement/auditquery','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
3860
3913
|
* Update a document.
|
|
3861
3914
|
*
|
|
3862
3915
|
* @param {String} documentId Document ID
|
|
@@ -3945,7 +3998,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
3945
3998
|
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(){/**
|
|
3946
3999
|
* Conversations service.
|
|
3947
4000
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
3948
|
-
* @version
|
|
4001
|
+
* @version 186.0.1
|
|
3949
4002
|
*/ /**
|
|
3950
4003
|
* Constructs a new ConversationsApi.
|
|
3951
4004
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -5669,7 +5722,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
5669
5722
|
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(){/**
|
|
5670
5723
|
* DataExtensions service.
|
|
5671
5724
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
5672
|
-
* @version
|
|
5725
|
+
* @version 186.0.1
|
|
5673
5726
|
*/ /**
|
|
5674
5727
|
* Constructs a new DataExtensionsApi.
|
|
5675
5728
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -5690,7 +5743,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
5690
5743
|
*/},{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(){/**
|
|
5691
5744
|
* Downloads service.
|
|
5692
5745
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
5693
|
-
* @version
|
|
5746
|
+
* @version 186.0.1
|
|
5694
5747
|
*/ /**
|
|
5695
5748
|
* Constructs a new DownloadsApi.
|
|
5696
5749
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -5709,7 +5762,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
5709
5762
|
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(){/**
|
|
5710
5763
|
* Emails service.
|
|
5711
5764
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
5712
|
-
* @version
|
|
5765
|
+
* @version 186.0.1
|
|
5713
5766
|
*/ /**
|
|
5714
5767
|
* Constructs a new EmailsApi.
|
|
5715
5768
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -5727,7 +5780,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
5727
5780
|
*/},{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(){/**
|
|
5728
5781
|
* Events service.
|
|
5729
5782
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
5730
|
-
* @version
|
|
5783
|
+
* @version 186.0.1
|
|
5731
5784
|
*/ /**
|
|
5732
5785
|
* Constructs a new EventsApi.
|
|
5733
5786
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -5752,7 +5805,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
5752
5805
|
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(){/**
|
|
5753
5806
|
* ExternalContacts service.
|
|
5754
5807
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
5755
|
-
* @version
|
|
5808
|
+
* @version 186.0.1
|
|
5756
5809
|
*/ /**
|
|
5757
5810
|
* Constructs a new ExternalContactsApi.
|
|
5758
5811
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -5835,7 +5888,7 @@ if(noteId===undefined||noteId===null){throw'Missing the required parameter "note
|
|
|
5835
5888
|
* @param {Object} opts Optional parameters
|
|
5836
5889
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
5837
5890
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
5838
|
-
* @param {String} opts.sortOrder
|
|
5891
|
+
* @param {String} opts.sortOrder The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. createDate:asc, createDate:desc
|
|
5839
5892
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
5840
5893
|
*/},{key:"getExternalcontactsContactNotes",value:function getExternalcontactsContactNotes(contactId,opts){opts=opts||{};// verify the required parameter 'contactId' is set
|
|
5841
5894
|
if(contactId===undefined||contactId===null){throw'Missing the required parameter "contactId" when calling getExternalcontactsContactNotes';}return this.apiClient.callApi('/api/v2/externalcontacts/contacts/{contactId}/notes','GET',{'contactId':contactId},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortOrder':opts['sortOrder'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -5852,7 +5905,7 @@ if(contactId===undefined||contactId===null){throw'Missing the required parameter
|
|
|
5852
5905
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
5853
5906
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
5854
5907
|
* @param {String} opts.q User supplied search keywords (no special syntax is currently supported)
|
|
5855
|
-
* @param {String} opts.sortOrder
|
|
5908
|
+
* @param {String} opts.sortOrder The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. firstName:asc, title:desc
|
|
5856
5909
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
5857
5910
|
*/},{key:"getExternalcontactsContacts",value:function getExternalcontactsContacts(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/externalcontacts/contacts','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'q':opts['q'],'sortOrder':opts['sortOrder'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5858
5911
|
* Get a schema
|
|
@@ -5890,7 +5943,7 @@ if(externalOrganizationId===undefined||externalOrganizationId===null){throw'Miss
|
|
|
5890
5943
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
5891
5944
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
5892
5945
|
* @param {String} opts.q User supplied search keywords (no special syntax is currently supported)
|
|
5893
|
-
* @param {String} opts.sortOrder
|
|
5946
|
+
* @param {String} opts.sortOrder The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. firstName:asc, title:desc
|
|
5894
5947
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
5895
5948
|
*/},{key:"getExternalcontactsOrganizationContacts",value:function getExternalcontactsOrganizationContacts(externalOrganizationId,opts){opts=opts||{};// verify the required parameter 'externalOrganizationId' is set
|
|
5896
5949
|
if(externalOrganizationId===undefined||externalOrganizationId===null){throw'Missing the required parameter "externalOrganizationId" when calling getExternalcontactsOrganizationContacts';}return this.apiClient.callApi('/api/v2/externalcontacts/organizations/{externalOrganizationId}/contacts','GET',{'externalOrganizationId':externalOrganizationId},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'q':opts['q'],'sortOrder':opts['sortOrder'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -5909,7 +5962,7 @@ if(noteId===undefined||noteId===null){throw'Missing the required parameter "note
|
|
|
5909
5962
|
* @param {Object} opts Optional parameters
|
|
5910
5963
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
5911
5964
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
5912
|
-
* @param {String} opts.sortOrder
|
|
5965
|
+
* @param {String} opts.sortOrder The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. createDate:asc, createDate:desc
|
|
5913
5966
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
5914
5967
|
*/},{key:"getExternalcontactsOrganizationNotes",value:function getExternalcontactsOrganizationNotes(externalOrganizationId,opts){opts=opts||{};// verify the required parameter 'externalOrganizationId' is set
|
|
5915
5968
|
if(externalOrganizationId===undefined||externalOrganizationId===null){throw'Missing the required parameter "externalOrganizationId" when calling getExternalcontactsOrganizationNotes';}return this.apiClient.callApi('/api/v2/externalcontacts/organizations/{externalOrganizationId}/notes','GET',{'externalOrganizationId':externalOrganizationId},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortOrder':opts['sortOrder'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -5920,7 +5973,7 @@ if(externalOrganizationId===undefined||externalOrganizationId===null){throw'Miss
|
|
|
5920
5973
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
5921
5974
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
5922
5975
|
* @param {Object} opts.expand which fields, if any, to expand
|
|
5923
|
-
* @param {String} opts.sortOrder
|
|
5976
|
+
* @param {String} opts.sortOrder The Relationship field to sort by. Any of: [createDate, relationship]. Direction: [asc, desc]. e.g. createDate:asc, relationship:desc
|
|
5924
5977
|
*/},{key:"getExternalcontactsOrganizationRelationships",value:function getExternalcontactsOrganizationRelationships(externalOrganizationId,opts){opts=opts||{};// verify the required parameter 'externalOrganizationId' is set
|
|
5925
5978
|
if(externalOrganizationId===undefined||externalOrganizationId===null){throw'Missing the required parameter "externalOrganizationId" when calling getExternalcontactsOrganizationRelationships';}return this.apiClient.callApi('/api/v2/externalcontacts/organizations/{externalOrganizationId}/relationships','GET',{'externalOrganizationId':externalOrganizationId},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'expand':opts['expand'],'sortOrder':opts['sortOrder']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
5926
5979
|
* Search for external organizations
|
|
@@ -5930,7 +5983,7 @@ if(externalOrganizationId===undefined||externalOrganizationId===null){throw'Miss
|
|
|
5930
5983
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
5931
5984
|
* @param {String} opts.q Search query
|
|
5932
5985
|
* @param {Array.<String>} opts.trustorId Search for external organizations by trustorIds (limit 25). If supplied, the 'q' parameters is ignored. Items are returned in the order requested
|
|
5933
|
-
* @param {String} opts.sortOrder
|
|
5986
|
+
* @param {String} opts.sortOrder The Organization field to sort by. Any of: [companyType, industry, name]. Direction: [asc, desc]. e.g. companyType:asc, industry:desc
|
|
5934
5987
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
5935
5988
|
* @param {Boolean} opts.includeTrustors (true or false) whether or not to include trustor information embedded in the externalOrganization
|
|
5936
5989
|
*/},{key:"getExternalcontactsOrganizations",value:function getExternalcontactsOrganizations(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/externalcontacts/organizations','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'q':opts['q'],'trustorId':this.apiClient.buildCollectionParam(opts['trustorId'],'multi'),'sortOrder':opts['sortOrder'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'includeTrustors':opts['includeTrustors']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -6207,7 +6260,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
6207
6260
|
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(){/**
|
|
6208
6261
|
* Fax service.
|
|
6209
6262
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
6210
|
-
* @version
|
|
6263
|
+
* @version 186.0.1
|
|
6211
6264
|
*/ /**
|
|
6212
6265
|
* Constructs a new FaxApi.
|
|
6213
6266
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -6248,7 +6301,7 @@ if(documentId===undefined||documentId===null){throw'Missing the required paramet
|
|
|
6248
6301
|
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(){/**
|
|
6249
6302
|
* Flows service.
|
|
6250
6303
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
6251
|
-
* @version
|
|
6304
|
+
* @version 186.0.1
|
|
6252
6305
|
*/ /**
|
|
6253
6306
|
* Constructs a new FlowsApi.
|
|
6254
6307
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -6297,7 +6350,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6297
6350
|
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(){/**
|
|
6298
6351
|
* Gamification service.
|
|
6299
6352
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
6300
|
-
* @version
|
|
6353
|
+
* @version 186.0.1
|
|
6301
6354
|
*/ /**
|
|
6302
6355
|
* Constructs a new GamificationApi.
|
|
6303
6356
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -6837,7 +6890,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
6837
6890
|
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(){/**
|
|
6838
6891
|
* GeneralDataProtectionRegulation service.
|
|
6839
6892
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
6840
|
-
* @version
|
|
6893
|
+
* @version 186.0.1
|
|
6841
6894
|
*/ /**
|
|
6842
6895
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
6843
6896
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -6872,7 +6925,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
6872
6925
|
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(){/**
|
|
6873
6926
|
* Geolocation service.
|
|
6874
6927
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
6875
|
-
* @version
|
|
6928
|
+
* @version 186.0.1
|
|
6876
6929
|
*/ /**
|
|
6877
6930
|
* Constructs a new GeolocationApi.
|
|
6878
6931
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -6906,7 +6959,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
6906
6959
|
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(){/**
|
|
6907
6960
|
* Greetings service.
|
|
6908
6961
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
6909
|
-
* @version
|
|
6962
|
+
* @version 186.0.1
|
|
6910
6963
|
*/ /**
|
|
6911
6964
|
* Constructs a new GreetingsApi.
|
|
6912
6965
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -7013,7 +7066,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
7013
7066
|
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(){/**
|
|
7014
7067
|
* Groups service.
|
|
7015
7068
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
7016
|
-
* @version
|
|
7069
|
+
* @version 186.0.1
|
|
7017
7070
|
*/ /**
|
|
7018
7071
|
* Constructs a new GroupsApi.
|
|
7019
7072
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -7146,7 +7199,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
7146
7199
|
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(){/**
|
|
7147
7200
|
* IdentityProvider service.
|
|
7148
7201
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
7149
|
-
* @version
|
|
7202
|
+
* @version 186.0.1
|
|
7150
7203
|
*/ /**
|
|
7151
7204
|
* Constructs a new IdentityProviderApi.
|
|
7152
7205
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -7280,7 +7333,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7280
7333
|
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(){/**
|
|
7281
7334
|
* InfrastructureAsCode service.
|
|
7282
7335
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
7283
|
-
* @version
|
|
7336
|
+
* @version 186.0.1
|
|
7284
7337
|
*/ /**
|
|
7285
7338
|
* Constructs a new InfrastructureAsCodeApi.
|
|
7286
7339
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -7334,7 +7387,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
7334
7387
|
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(){/**
|
|
7335
7388
|
* Integrations service.
|
|
7336
7389
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
7337
|
-
* @version
|
|
7390
|
+
* @version 186.0.1
|
|
7338
7391
|
*/ /**
|
|
7339
7392
|
* Constructs a new IntegrationsApi.
|
|
7340
7393
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -7464,6 +7517,12 @@ if(fileName===undefined||fileName===null){throw'Missing the required parameter "
|
|
|
7464
7517
|
* @param {Object} opts.sortOrder Direction to sort 'sortBy' field. (default to asc)
|
|
7465
7518
|
* @param {Object} opts.secure Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.
|
|
7466
7519
|
*/},{key:"getIntegrationsActionsCategories",value:function getIntegrationsActionsCategories(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/integrations/actions/categories','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'nextPage':opts['nextPage'],'previousPage':opts['previousPage'],'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder'],'secure':opts['secure']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7520
|
+
* Retrieves the available mTLS client certificates in use. This endpoint will return inconsistent results while a certificate rotation is in progress.
|
|
7521
|
+
*
|
|
7522
|
+
* @param {Object} opts Optional parameters
|
|
7523
|
+
* @param {Object} opts.status Indicates the validity of the certificate in question.
|
|
7524
|
+
* @param {Object} opts.type Indicates the type of the certificate.
|
|
7525
|
+
*/},{key:"getIntegrationsActionsCertificates",value:function getIntegrationsActionsCertificates(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/integrations/actions/certificates','GET',{},{'status':opts['status'],'type':opts['type']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
7467
7526
|
* Retrieves all action drafts associated with the filters passed in via query param.
|
|
7468
7527
|
*
|
|
7469
7528
|
* @param {Object} opts Optional parameters
|
|
@@ -7855,7 +7914,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
7855
7914
|
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(){/**
|
|
7856
7915
|
* Journey service.
|
|
7857
7916
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
7858
|
-
* @version
|
|
7917
|
+
* @version 186.0.1
|
|
7859
7918
|
*/ /**
|
|
7860
7919
|
* Constructs a new JourneyApi.
|
|
7861
7920
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -8159,7 +8218,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
8159
8218
|
*/},{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(){/**
|
|
8160
8219
|
* Knowledge service.
|
|
8161
8220
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
8162
|
-
* @version
|
|
8221
|
+
* @version 186.0.1
|
|
8163
8222
|
*/ /**
|
|
8164
8223
|
* Constructs a new KnowledgeApi.
|
|
8165
8224
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -8956,7 +9015,7 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
8956
9015
|
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(){/**
|
|
8957
9016
|
* LanguageUnderstanding service.
|
|
8958
9017
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
8959
|
-
* @version
|
|
9018
|
+
* @version 186.0.1
|
|
8960
9019
|
*/ /**
|
|
8961
9020
|
* Constructs a new LanguageUnderstandingApi.
|
|
8962
9021
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -9212,7 +9271,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
9212
9271
|
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(){/**
|
|
9213
9272
|
* Languages service.
|
|
9214
9273
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
9215
|
-
* @version
|
|
9274
|
+
* @version 186.0.1
|
|
9216
9275
|
*/ /**
|
|
9217
9276
|
* Constructs a new LanguagesApi.
|
|
9218
9277
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -9267,7 +9326,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
9267
9326
|
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(){/**
|
|
9268
9327
|
* Learning service.
|
|
9269
9328
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
9270
|
-
* @version
|
|
9329
|
+
* @version 186.0.1
|
|
9271
9330
|
*/ /**
|
|
9272
9331
|
* Constructs a new LearningApi.
|
|
9273
9332
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -9497,7 +9556,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
9497
9556
|
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(){/**
|
|
9498
9557
|
* License service.
|
|
9499
9558
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
9500
|
-
* @version
|
|
9559
|
+
* @version 186.0.1
|
|
9501
9560
|
*/ /**
|
|
9502
9561
|
* Constructs a new LicenseApi.
|
|
9503
9562
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -9551,7 +9610,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
9551
9610
|
*/},{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(){/**
|
|
9552
9611
|
* Locations service.
|
|
9553
9612
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
9554
|
-
* @version
|
|
9613
|
+
* @version 186.0.1
|
|
9555
9614
|
*/ /**
|
|
9556
9615
|
* Constructs a new LocationsApi.
|
|
9557
9616
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -9610,7 +9669,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9610
9669
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postLocationsSearch';}return this.apiClient.callApi('/api/v2/locations/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return LocationsApi;}();var LogCaptureApi=/*#__PURE__*/function(){/**
|
|
9611
9670
|
* LogCapture service.
|
|
9612
9671
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
9613
|
-
* @version
|
|
9672
|
+
* @version 186.0.1
|
|
9614
9673
|
*/ /**
|
|
9615
9674
|
* Constructs a new LogCaptureApi.
|
|
9616
9675
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -9618,19 +9677,49 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9618
9677
|
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
9619
9678
|
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
9620
9679
|
*/function LogCaptureApi(apiClient){_classCallCheck(this,LogCaptureApi);this.apiClient=apiClient||ApiClient.instance;}/**
|
|
9680
|
+
* Disable browser log capture for the user
|
|
9681
|
+
*
|
|
9682
|
+
* @param {String} userId The id of the user to disable browser log capture
|
|
9683
|
+
*/_createClass(LogCaptureApi,[{key:"deleteDiagnosticsLogcaptureBrowserUser",value:function deleteDiagnosticsLogcaptureBrowserUser(userId){// verify the required parameter 'userId' is set
|
|
9684
|
+
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling deleteDiagnosticsLogcaptureBrowserUser';}return this.apiClient.callApi('/api/v2/diagnostics/logcapture/browser/users/{userId}','DELETE',{'userId':userId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9621
9685
|
* Gets status of async download execution
|
|
9622
9686
|
*
|
|
9623
9687
|
* @param {String} jobId Job ID
|
|
9624
|
-
*/
|
|
9688
|
+
*/},{key:"getDiagnosticsLogcaptureBrowserEntriesDownloadJob",value:function getDiagnosticsLogcaptureBrowserEntriesDownloadJob(jobId){// verify the required parameter 'jobId' is set
|
|
9625
9689
|
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']);}/**
|
|
9690
|
+
* Get log capture configuration for the user
|
|
9691
|
+
*
|
|
9692
|
+
* @param {String} userId The id of the user to get browser log capture configuration
|
|
9693
|
+
*/},{key:"getDiagnosticsLogcaptureBrowserUser",value:function getDiagnosticsLogcaptureBrowserUser(userId){// verify the required parameter 'userId' is set
|
|
9694
|
+
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling getDiagnosticsLogcaptureBrowserUser';}return this.apiClient.callApi('/api/v2/diagnostics/logcapture/browser/users/{userId}','GET',{'userId':userId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9695
|
+
* Get all log capture enabled users for an org
|
|
9696
|
+
*
|
|
9697
|
+
* @param {Object} opts Optional parameters
|
|
9698
|
+
* @param {Boolean} opts.includeExpired Include expired users with log captures still available for search or download (default to false)
|
|
9699
|
+
*/},{key:"getDiagnosticsLogcaptureBrowserUsers",value:function getDiagnosticsLogcaptureBrowserUsers(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/diagnostics/logcapture/browser/users','GET',{},{'includeExpired':opts['includeExpired']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9626
9700
|
* Creates an async download execution
|
|
9627
9701
|
*
|
|
9628
9702
|
* @param {Object} opts Optional parameters
|
|
9629
9703
|
* @param {Object} opts.body
|
|
9630
|
-
*/},{key:"postDiagnosticsLogcaptureBrowserEntriesDownloadJobs",value:function postDiagnosticsLogcaptureBrowserEntriesDownloadJobs(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/diagnostics/logcapture/browser/entries/download/jobs','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}
|
|
9704
|
+
*/},{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']);}/**
|
|
9705
|
+
* Query collected log entries. It returns a limited amount of records, to get all records use download endpoint.
|
|
9706
|
+
*
|
|
9707
|
+
* @param {Object} opts Optional parameters
|
|
9708
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
9709
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
9710
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
9711
|
+
* @param {Object} opts.body
|
|
9712
|
+
*/},{key:"postDiagnosticsLogcaptureBrowserEntriesQuery",value:function postDiagnosticsLogcaptureBrowserEntriesQuery(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/diagnostics/logcapture/browser/entries/query','POST',{},{'before':opts['before'],'after':opts['after'],'pageSize':opts['pageSize']},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9713
|
+
* Enable log capture for a user or update expiration
|
|
9714
|
+
*
|
|
9715
|
+
* @param {String} userId The id of the user to enable browser log capture
|
|
9716
|
+
* @param {Object} opts Optional parameters
|
|
9717
|
+
* @param {Object} opts.body
|
|
9718
|
+
*/},{key:"postDiagnosticsLogcaptureBrowserUser",value:function postDiagnosticsLogcaptureBrowserUser(userId,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
9719
|
+
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling postDiagnosticsLogcaptureBrowserUser';}return this.apiClient.callApi('/api/v2/diagnostics/logcapture/browser/users/{userId}','POST',{'userId':userId},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}}]);return LogCaptureApi;}();var MessagingApi=/*#__PURE__*/function(){/**
|
|
9631
9720
|
* Messaging service.
|
|
9632
9721
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
9633
|
-
* @version
|
|
9722
|
+
* @version 186.0.1
|
|
9634
9723
|
*/ /**
|
|
9635
9724
|
* Constructs a new MessagingApi.
|
|
9636
9725
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -9720,7 +9809,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9720
9809
|
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(){/**
|
|
9721
9810
|
* MobileDevices service.
|
|
9722
9811
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
9723
|
-
* @version
|
|
9812
|
+
* @version 186.0.1
|
|
9724
9813
|
*/ /**
|
|
9725
9814
|
* Constructs a new MobileDevicesApi.
|
|
9726
9815
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -9759,7 +9848,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
9759
9848
|
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(){/**
|
|
9760
9849
|
* Notifications service.
|
|
9761
9850
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
9762
|
-
* @version
|
|
9851
|
+
* @version 186.0.1
|
|
9763
9852
|
*/ /**
|
|
9764
9853
|
* Constructs a new NotificationsApi.
|
|
9765
9854
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -9816,7 +9905,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
9816
9905
|
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(){/**
|
|
9817
9906
|
* OAuth service.
|
|
9818
9907
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
9819
|
-
* @version
|
|
9908
|
+
* @version 186.0.1
|
|
9820
9909
|
*/ /**
|
|
9821
9910
|
* Constructs a new OAuthApi.
|
|
9822
9911
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -9901,7 +9990,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
9901
9990
|
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(){/**
|
|
9902
9991
|
* Objects service.
|
|
9903
9992
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
9904
|
-
* @version
|
|
9993
|
+
* @version 186.0.1
|
|
9905
9994
|
*/ /**
|
|
9906
9995
|
* Constructs a new ObjectsApi.
|
|
9907
9996
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -9933,9 +10022,8 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
9933
10022
|
* @param {String} opts.nextPage next page token
|
|
9934
10023
|
* @param {String} opts.previousPage Previous page token
|
|
9935
10024
|
* @param {Boolean} opts.objectCount Include the count of objects contained in the division (default to false)
|
|
9936
|
-
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
9937
10025
|
* @param {String} opts.name Search term to filter by division name
|
|
9938
|
-
*/},{key:"getAuthorizationDivisions",value:function getAuthorizationDivisions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/authorization/divisions','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'nextPage':opts['nextPage'],'previousPage':opts['previousPage'],'objectCount':opts['objectCount'],'
|
|
10026
|
+
*/},{key:"getAuthorizationDivisions",value:function getAuthorizationDivisions(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/authorization/divisions','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi'),'nextPage':opts['nextPage'],'previousPage':opts['previousPage'],'objectCount':opts['objectCount'],'name':opts['name']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
9939
10027
|
* Retrieve the home division for the organization.
|
|
9940
10028
|
* Will not include object counts.
|
|
9941
10029
|
*/},{key:"getAuthorizationDivisionsHome",value:function getAuthorizationDivisionsHome(){return this.apiClient.callApi('/api/v2/authorization/divisions/home','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -9972,7 +10060,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
9972
10060
|
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(){/**
|
|
9973
10061
|
* OperationalEvents service.
|
|
9974
10062
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
9975
|
-
* @version
|
|
10063
|
+
* @version 186.0.1
|
|
9976
10064
|
*/ /**
|
|
9977
10065
|
* Constructs a new OperationalEventsApi.
|
|
9978
10066
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -9990,7 +10078,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
9990
10078
|
*/},{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(){/**
|
|
9991
10079
|
* Organization service.
|
|
9992
10080
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
9993
|
-
* @version
|
|
10081
|
+
* @version 186.0.1
|
|
9994
10082
|
*/ /**
|
|
9995
10083
|
* Constructs a new OrganizationApi.
|
|
9996
10084
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -10092,7 +10180,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10092
10180
|
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(){/**
|
|
10093
10181
|
* OrganizationAuthorization service.
|
|
10094
10182
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
10095
|
-
* @version
|
|
10183
|
+
* @version 186.0.1
|
|
10096
10184
|
*/ /**
|
|
10097
10185
|
* Constructs a new OrganizationAuthorizationApi.
|
|
10098
10186
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -10415,7 +10503,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
10415
10503
|
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(){/**
|
|
10416
10504
|
* Outbound service.
|
|
10417
10505
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
10418
|
-
* @version
|
|
10506
|
+
* @version 186.0.1
|
|
10419
10507
|
*/ /**
|
|
10420
10508
|
* Constructs a new OutboundApi.
|
|
10421
10509
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -11400,7 +11488,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11400
11488
|
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(){/**
|
|
11401
11489
|
* Presence service.
|
|
11402
11490
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
11403
|
-
* @version
|
|
11491
|
+
* @version 186.0.1
|
|
11404
11492
|
*/ /**
|
|
11405
11493
|
* Constructs a new PresenceApi.
|
|
11406
11494
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -11568,7 +11656,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11568
11656
|
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(){/**
|
|
11569
11657
|
* ProcessAutomation service.
|
|
11570
11658
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
11571
|
-
* @version
|
|
11659
|
+
* @version 186.0.1
|
|
11572
11660
|
*/ /**
|
|
11573
11661
|
* Constructs a new ProcessAutomationApi.
|
|
11574
11662
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -11631,7 +11719,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
11631
11719
|
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(){/**
|
|
11632
11720
|
* Quality service.
|
|
11633
11721
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
11634
|
-
* @version
|
|
11722
|
+
* @version 186.0.1
|
|
11635
11723
|
*/ /**
|
|
11636
11724
|
* Constructs a new QualityApi.
|
|
11637
11725
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -12061,7 +12149,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12061
12149
|
if(calibrationId===undefined||calibrationId===null){throw'Missing the required parameter "calibrationId" when calling putQualityCalibration';}// verify the required parameter 'body' is set
|
|
12062
12150
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putQualityCalibration';}return this.apiClient.callApi('/api/v2/quality/calibrations/{calibrationId}','PUT',{'calibrationId':calibrationId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12063
12151
|
* Update an evaluation
|
|
12064
|
-
* The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation.
|
|
12152
|
+
* The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation. authorizedActions is not returned for this PUT request, and is only returned for GET requests to this endpoint.
|
|
12065
12153
|
* @param {String} conversationId conversationId
|
|
12066
12154
|
* @param {String} evaluationId evaluationId
|
|
12067
12155
|
* @param {Object} body evaluation
|
|
@@ -12102,7 +12190,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
12102
12190
|
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(){/**
|
|
12103
12191
|
* Recording service.
|
|
12104
12192
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
12105
|
-
* @version
|
|
12193
|
+
* @version 186.0.1
|
|
12106
12194
|
*/ /**
|
|
12107
12195
|
* Constructs a new RecordingApi.
|
|
12108
12196
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -12509,7 +12597,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12509
12597
|
*/},{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(){/**
|
|
12510
12598
|
* ResponseManagement service.
|
|
12511
12599
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
12512
|
-
* @version
|
|
12600
|
+
* @version 186.0.1
|
|
12513
12601
|
*/ /**
|
|
12514
12602
|
* Constructs a new ResponseManagementApi.
|
|
12515
12603
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -12625,7 +12713,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
12625
12713
|
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(){/**
|
|
12626
12714
|
* Routing service.
|
|
12627
12715
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
12628
|
-
* @version
|
|
12716
|
+
* @version 186.0.1
|
|
12629
12717
|
*/ /**
|
|
12630
12718
|
* Constructs a new RoutingApi.
|
|
12631
12719
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -12725,6 +12813,14 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
12725
12813
|
* Delete the organization-wide max utilization settings and revert to the system default.
|
|
12726
12814
|
*
|
|
12727
12815
|
*/},{key:"deleteRoutingUtilization",value:function deleteRoutingUtilization(){return this.apiClient.callApi('/api/v2/routing/utilization','DELETE',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
12816
|
+
* Delete a utilization label
|
|
12817
|
+
*
|
|
12818
|
+
* @param {String} labelId Utilization Label ID
|
|
12819
|
+
* @param {Object} opts Optional parameters
|
|
12820
|
+
* @param {Boolean} opts.forceDelete Remove all label usages (if found) without warning (default to false)
|
|
12821
|
+
* deleteRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12822
|
+
*/},{key:"deleteRoutingUtilizationLabel",value:function deleteRoutingUtilizationLabel(labelId,opts){opts=opts||{};// verify the required parameter 'labelId' is set
|
|
12823
|
+
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']);}/**
|
|
12728
12824
|
* Delete an utilization tag
|
|
12729
12825
|
*
|
|
12730
12826
|
* @param {String} tagId Utilization Tag ID
|
|
@@ -13108,6 +13204,27 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
13108
13204
|
* Get the organization-wide max utilization settings.
|
|
13109
13205
|
*
|
|
13110
13206
|
*/},{key:"getRoutingUtilization",value:function getRoutingUtilization(){return this.apiClient.callApi('/api/v2/routing/utilization','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13207
|
+
* Get details about this utilization label
|
|
13208
|
+
*
|
|
13209
|
+
* @param {String} labelId Utilization Label ID
|
|
13210
|
+
* getRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13211
|
+
*/},{key:"getRoutingUtilizationLabel",value:function getRoutingUtilizationLabel(labelId){// verify the required parameter 'labelId' is set
|
|
13212
|
+
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']);}/**
|
|
13213
|
+
* Get list of agent ids associated with a utilization label
|
|
13214
|
+
*
|
|
13215
|
+
* @param {String} labelId Utilization Label ID
|
|
13216
|
+
* getRoutingUtilizationLabelAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13217
|
+
*/},{key:"getRoutingUtilizationLabelAgents",value:function getRoutingUtilizationLabelAgents(labelId){// verify the required parameter 'labelId' is set
|
|
13218
|
+
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']);}/**
|
|
13219
|
+
* Get list of utilization labels
|
|
13220
|
+
*
|
|
13221
|
+
* @param {Object} opts Optional parameters
|
|
13222
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
13223
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
13224
|
+
* @param {Object} opts.sortOrder Sort order by name (default to ascending)
|
|
13225
|
+
* @param {String} opts.name Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*'
|
|
13226
|
+
* getRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13227
|
+
*/},{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']);}/**
|
|
13111
13228
|
* Get details about this utilization tag
|
|
13112
13229
|
*
|
|
13113
13230
|
* @param {String} tagId Utilization Tag ID
|
|
@@ -13145,6 +13262,21 @@ if(codeId===undefined||codeId===null){throw'Missing the required parameter "code
|
|
|
13145
13262
|
* @param {Array.<String>} opts.id Filter by wrapup code ID(s)
|
|
13146
13263
|
* @param {Array.<String>} opts.divisionId Filter by division ID(s)
|
|
13147
13264
|
*/},{key:"getRoutingWrapupcodes",value:function getRoutingWrapupcodes(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/routing/wrapupcodes','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder'],'name':opts['name'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'divisionId':this.apiClient.buildCollectionParam(opts['divisionId'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13265
|
+
* Get a simplified wrap-up code.
|
|
13266
|
+
*
|
|
13267
|
+
* @param {String} codeId Wrapup Code ID
|
|
13268
|
+
*/},{key:"getRoutingWrapupcodesDivisionview",value:function getRoutingWrapupcodesDivisionview(codeId){// verify the required parameter 'codeId' is set
|
|
13269
|
+
if(codeId===undefined||codeId===null){throw'Missing the required parameter "codeId" when calling getRoutingWrapupcodesDivisionview';}return this.apiClient.callApi('/api/v2/routing/wrapupcodes/divisionviews/{codeId}','GET',{'codeId':codeId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13270
|
+
* Get a paged listing of simplified wrapup code objects, filterable by name, wrapup code ID(s), or division ID(s).
|
|
13271
|
+
* Specifying both name and ID parameters is not supported.
|
|
13272
|
+
* @param {Object} opts Optional parameters
|
|
13273
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
13274
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
13275
|
+
* @param {String} opts.name Name (trailing asterisks allowed)
|
|
13276
|
+
* @param {Array.<String>} opts.id Wrapup code ID(s)
|
|
13277
|
+
* @param {Array.<String>} opts.divisionId Division ID(s)
|
|
13278
|
+
* @param {Object} opts.includeState Wrapup code state(s) to include
|
|
13279
|
+
*/},{key:"getRoutingWrapupcodesDivisionviews",value:function getRoutingWrapupcodesDivisionviews(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/routing/wrapupcodes/divisionviews','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'name':opts['name'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'divisionId':this.apiClient.buildCollectionParam(opts['divisionId'],'multi'),'includeState':opts['includeState']},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13148
13280
|
* Get queues for user
|
|
13149
13281
|
*
|
|
13150
13282
|
* @param {String} userId User ID
|
|
@@ -13249,6 +13381,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13249
13381
|
* @param {Object} body Contact Center Settings
|
|
13250
13382
|
*/},{key:"patchRoutingSettingsContactcenter",value:function patchRoutingSettingsContactcenter(body){// verify the required parameter 'body' is set
|
|
13251
13383
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchRoutingSettingsContactcenter';}return this.apiClient.callApi('/api/v2/routing/settings/contactcenter','PATCH',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13384
|
+
* Patch Transcription Settings
|
|
13385
|
+
*
|
|
13386
|
+
* @param {Object} body Organization Settings
|
|
13387
|
+
*/},{key:"patchRoutingSettingsTranscription",value:function patchRoutingSettingsTranscription(body){// verify the required parameter 'body' is set
|
|
13388
|
+
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling patchRoutingSettingsTranscription';}return this.apiClient.callApi('/api/v2/routing/settings/transcription','PATCH',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
13252
13389
|
* Update skill group definition
|
|
13253
13390
|
*
|
|
13254
13391
|
* @param {String} skillGroupId Skill Group ID
|
|
@@ -13421,9 +13558,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13421
13558
|
* Imports a phone number for SMS
|
|
13422
13559
|
*
|
|
13423
13560
|
* @param {Object} body SmsPhoneNumber
|
|
13424
|
-
* postRoutingSmsPhonenumbersImport is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13425
13561
|
*/},{key:"postRoutingSmsPhonenumbersImport",value:function postRoutingSmsPhonenumbersImport(body){// verify the required parameter 'body' is set
|
|
13426
13562
|
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']);}/**
|
|
13563
|
+
* Create a utilization label
|
|
13564
|
+
*
|
|
13565
|
+
* @param {Object} body UtilizationLabel
|
|
13566
|
+
* postRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13567
|
+
*/},{key:"postRoutingUtilizationLabels",value:function postRoutingUtilizationLabels(body){// verify the required parameter 'body' is set
|
|
13568
|
+
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']);}/**
|
|
13427
13569
|
* Create an utilization tag
|
|
13428
13570
|
*
|
|
13429
13571
|
* @param {Object} body UtilizationTag
|
|
@@ -13506,6 +13648,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
13506
13648
|
* @param {Object} body utilization
|
|
13507
13649
|
*/},{key:"putRoutingUtilization",value:function putRoutingUtilization(body){// verify the required parameter 'body' is set
|
|
13508
13650
|
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']);}/**
|
|
13651
|
+
* Update a utilization label
|
|
13652
|
+
*
|
|
13653
|
+
* @param {String} labelId Utilization Label ID
|
|
13654
|
+
* @param {Object} body UtilizationLabel
|
|
13655
|
+
* putRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13656
|
+
*/},{key:"putRoutingUtilizationLabel",value:function putRoutingUtilizationLabel(labelId,body){// verify the required parameter 'labelId' is set
|
|
13657
|
+
if(labelId===undefined||labelId===null){throw'Missing the required parameter "labelId" when calling putRoutingUtilizationLabel';}// verify the required parameter 'body' is set
|
|
13658
|
+
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']);}/**
|
|
13509
13659
|
* Update wrap-up code
|
|
13510
13660
|
*
|
|
13511
13661
|
* @param {String} codeId Wrapup Code ID
|
|
@@ -13531,7 +13681,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
13531
13681
|
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(){/**
|
|
13532
13682
|
* SCIM service.
|
|
13533
13683
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
13534
|
-
* @version
|
|
13684
|
+
* @version 186.0.1
|
|
13535
13685
|
*/ /**
|
|
13536
13686
|
* Constructs a new SCIMApi.
|
|
13537
13687
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -13756,7 +13906,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
13756
13906
|
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(){/**
|
|
13757
13907
|
* Scripts service.
|
|
13758
13908
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
13759
|
-
* @version
|
|
13909
|
+
* @version 186.0.1
|
|
13760
13910
|
*/ /**
|
|
13761
13911
|
* Constructs a new ScriptsApi.
|
|
13762
13912
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -13892,7 +14042,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
13892
14042
|
*/},{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(){/**
|
|
13893
14043
|
* Search service.
|
|
13894
14044
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
13895
|
-
* @version
|
|
14045
|
+
* @version 186.0.1
|
|
13896
14046
|
*/ /**
|
|
13897
14047
|
* Constructs a new SearchApi.
|
|
13898
14048
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -14052,7 +14202,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14052
14202
|
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(){/**
|
|
14053
14203
|
* Settings service.
|
|
14054
14204
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
14055
|
-
* @version
|
|
14205
|
+
* @version 186.0.1
|
|
14056
14206
|
*/ /**
|
|
14057
14207
|
* Constructs a new SettingsApi.
|
|
14058
14208
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -14070,7 +14220,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14070
14220
|
*/},{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(){/**
|
|
14071
14221
|
* SpeechTextAnalytics service.
|
|
14072
14222
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
14073
|
-
* @version
|
|
14223
|
+
* @version 186.0.1
|
|
14074
14224
|
*/ /**
|
|
14075
14225
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
14076
14226
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -14313,7 +14463,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
14313
14463
|
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(){/**
|
|
14314
14464
|
* Stations service.
|
|
14315
14465
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
14316
|
-
* @version
|
|
14466
|
+
* @version 186.0.1
|
|
14317
14467
|
*/ /**
|
|
14318
14468
|
* Constructs a new StationsApi.
|
|
14319
14469
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -14345,7 +14495,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
14345
14495
|
*/},{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(){/**
|
|
14346
14496
|
* Suggest service.
|
|
14347
14497
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
14348
|
-
* @version
|
|
14498
|
+
* @version 186.0.1
|
|
14349
14499
|
*/ /**
|
|
14350
14500
|
* Constructs a new SuggestApi.
|
|
14351
14501
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -14385,7 +14535,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14385
14535
|
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(){/**
|
|
14386
14536
|
* TaskManagement service.
|
|
14387
14537
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
14388
|
-
* @version
|
|
14538
|
+
* @version 186.0.1
|
|
14389
14539
|
*/ /**
|
|
14390
14540
|
* Constructs a new TaskManagementApi.
|
|
14391
14541
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -14727,7 +14877,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
14727
14877
|
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(){/**
|
|
14728
14878
|
* Teams service.
|
|
14729
14879
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
14730
|
-
* @version
|
|
14880
|
+
* @version 186.0.1
|
|
14731
14881
|
*/ /**
|
|
14732
14882
|
* Constructs a new TeamsApi.
|
|
14733
14883
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -14806,7 +14956,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14806
14956
|
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(){/**
|
|
14807
14957
|
* Telephony service.
|
|
14808
14958
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
14809
|
-
* @version
|
|
14959
|
+
* @version 186.0.1
|
|
14810
14960
|
*/ /**
|
|
14811
14961
|
* Constructs a new TelephonyApi.
|
|
14812
14962
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -14820,7 +14970,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14820
14970
|
* Get a SIP message.
|
|
14821
14971
|
* Get the raw form of the SIP message
|
|
14822
14972
|
* @param {String} conversationId Conversation id
|
|
14823
|
-
* getTelephonySipmessagesConversation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14824
14973
|
*/},{key:"getTelephonySipmessagesConversation",value:function getTelephonySipmessagesConversation(conversationId){// verify the required parameter 'conversationId' is set
|
|
14825
14974
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getTelephonySipmessagesConversation';}return this.apiClient.callApi('/api/v2/telephony/sipmessages/conversations/{conversationId}','GET',{'conversationId':conversationId},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14826
14975
|
* Get SIP headers.
|
|
@@ -14828,7 +14977,6 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
14828
14977
|
* @param {String} conversationId Conversation id
|
|
14829
14978
|
* @param {Object} opts Optional parameters
|
|
14830
14979
|
* @param {Array.<String>} opts.keys comma-separated list of header identifiers to query. e.g. ruri,to,from
|
|
14831
|
-
* getTelephonySipmessagesConversationHeaders is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
14832
14980
|
*/},{key:"getTelephonySipmessagesConversationHeaders",value:function getTelephonySipmessagesConversationHeaders(conversationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
14833
14981
|
if(conversationId===undefined||conversationId===null){throw'Missing the required parameter "conversationId" when calling getTelephonySipmessagesConversationHeaders';}return this.apiClient.callApi('/api/v2/telephony/sipmessages/conversations/{conversationId}/headers','GET',{'conversationId':conversationId},{'keys':this.apiClient.buildCollectionParam(opts['keys'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
14834
14982
|
* Fetch SIP metadata
|
|
@@ -14855,7 +15003,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
14855
15003
|
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(){/**
|
|
14856
15004
|
* TelephonyProvidersEdge service.
|
|
14857
15005
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
14858
|
-
* @version
|
|
15006
|
+
* @version 186.0.1
|
|
14859
15007
|
*/ /**
|
|
14860
15008
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
14861
15009
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -15033,8 +15181,9 @@ if(edgeId===undefined||edgeId===null){throw'Missing the required parameter "edge
|
|
|
15033
15181
|
* @param {Boolean} opts.managed Filter by managed
|
|
15034
15182
|
* @param {Boolean} opts.showCloudMedia True to show the cloud media devices in the result. (default to true)
|
|
15035
15183
|
*/},{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']);}/**
|
|
15036
|
-
* Get the list of available languages.
|
|
15184
|
+
* Get the list of available languages. For never released keyword spotting feature. Deprecated, do not use.
|
|
15037
15185
|
*
|
|
15186
|
+
* @deprecated
|
|
15038
15187
|
*/},{key:"getTelephonyProvidersEdgesAvailablelanguages",value:function getTelephonyProvidersEdgesAvailablelanguages(){return this.apiClient.callApi('/api/v2/telephony/providers/edges/availablelanguages','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15039
15188
|
* Get the list of certificate authorities.
|
|
15040
15189
|
*
|
|
@@ -15142,7 +15291,6 @@ if(extensionPoolId===undefined||extensionPoolId===null){throw'Missing the requir
|
|
|
15142
15291
|
* @param {Array.<String>} opts.id ID of the Extension Pools to filter by.
|
|
15143
15292
|
* @param {String} opts.name Name of the Extension Pools to filter by.
|
|
15144
15293
|
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
15145
|
-
* getTelephonyProvidersEdgesExtensionpoolsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15146
15294
|
*/},{key:"getTelephonyProvidersEdgesExtensionpoolsDivisionviews",value:function getTelephonyProvidersEdgesExtensionpoolsDivisionviews(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/telephony/providers/edges/extensionpools/divisionviews','GET',{},{'pageNumber':opts['pageNumber'],'pageSize':opts['pageSize'],'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder'],'id':this.apiClient.buildCollectionParam(opts['id'],'multi'),'name':opts['name'],'divisionId':this.apiClient.buildCollectionParam(opts['divisionId'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15147
15295
|
* Get a listing of extensions
|
|
15148
15296
|
*
|
|
@@ -15347,7 +15495,8 @@ if(siteId===undefined||siteId===null){throw'Missing the required parameter "site
|
|
|
15347
15495
|
* @param {String} opts.name Name
|
|
15348
15496
|
* @param {String} opts.locationId Location Id
|
|
15349
15497
|
* @param {Boolean} opts.managed Filter by managed
|
|
15350
|
-
|
|
15498
|
+
* @param {Array.<String>} opts.expand Fields to expand in the response, comma-separated
|
|
15499
|
+
*/},{key:"getTelephonyProvidersEdgesSites",value:function getTelephonyProvidersEdgesSites(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/telephony/providers/edges/sites','GET',{},{'pageSize':opts['pageSize'],'pageNumber':opts['pageNumber'],'sortBy':opts['sortBy'],'sortOrder':opts['sortOrder'],'name':opts['name'],'location.id':opts['locationId'],'managed':opts['managed'],'expand':this.apiClient.buildCollectionParam(opts['expand'],'multi')},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
15351
15500
|
* Get a list of Edge-compatible time zones
|
|
15352
15501
|
*
|
|
15353
15502
|
* @param {Object} opts Optional parameters
|
|
@@ -15674,7 +15823,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
15674
15823
|
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(){/**
|
|
15675
15824
|
* Textbots service.
|
|
15676
15825
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
15677
|
-
* @version
|
|
15826
|
+
* @version 186.0.1
|
|
15678
15827
|
*/ /**
|
|
15679
15828
|
* Constructs a new TextbotsApi.
|
|
15680
15829
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -15709,7 +15858,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
15709
15858
|
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(){/**
|
|
15710
15859
|
* Tokens service.
|
|
15711
15860
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
15712
|
-
* @version
|
|
15861
|
+
* @version 186.0.1
|
|
15713
15862
|
*/ /**
|
|
15714
15863
|
* Constructs a new TokensApi.
|
|
15715
15864
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -15745,7 +15894,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
15745
15894
|
*/},{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(){/**
|
|
15746
15895
|
* Uploads service.
|
|
15747
15896
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
15748
|
-
* @version
|
|
15897
|
+
* @version 186.0.1
|
|
15749
15898
|
*/ /**
|
|
15750
15899
|
* Constructs a new UploadsApi.
|
|
15751
15900
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -15787,7 +15936,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15787
15936
|
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(){/**
|
|
15788
15937
|
* Usage service.
|
|
15789
15938
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
15790
|
-
* @version
|
|
15939
|
+
* @version 186.0.1
|
|
15791
15940
|
*/ /**
|
|
15792
15941
|
* Constructs a new UsageApi.
|
|
15793
15942
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -15838,7 +15987,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15838
15987
|
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(){/**
|
|
15839
15988
|
* UserRecordings service.
|
|
15840
15989
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
15841
|
-
* @version
|
|
15990
|
+
* @version 186.0.1
|
|
15842
15991
|
*/ /**
|
|
15843
15992
|
* Constructs a new UserRecordingsApi.
|
|
15844
15993
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -15887,7 +16036,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
15887
16036
|
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(){/**
|
|
15888
16037
|
* Users service.
|
|
15889
16038
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
15890
|
-
* @version
|
|
16039
|
+
* @version 186.0.1
|
|
15891
16040
|
*/ /**
|
|
15892
16041
|
* Constructs a new UsersApi.
|
|
15893
16042
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -16546,7 +16695,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
16546
16695
|
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(){/**
|
|
16547
16696
|
* Utilities service.
|
|
16548
16697
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
16549
|
-
* @version
|
|
16698
|
+
* @version 186.0.1
|
|
16550
16699
|
*/ /**
|
|
16551
16700
|
* Constructs a new UtilitiesApi.
|
|
16552
16701
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -16573,7 +16722,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16573
16722
|
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(){/**
|
|
16574
16723
|
* Voicemail service.
|
|
16575
16724
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
16576
|
-
* @version
|
|
16725
|
+
* @version 186.0.1
|
|
16577
16726
|
*/ /**
|
|
16578
16727
|
* Constructs a new VoicemailApi.
|
|
16579
16728
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -16722,7 +16871,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
16722
16871
|
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(){/**
|
|
16723
16872
|
* WebChat service.
|
|
16724
16873
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
16725
|
-
* @version
|
|
16874
|
+
* @version 186.0.1
|
|
16726
16875
|
*/ /**
|
|
16727
16876
|
* Constructs a new WebChatApi.
|
|
16728
16877
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -16855,7 +17004,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16855
17004
|
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(){/**
|
|
16856
17005
|
* WebDeployments service.
|
|
16857
17006
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
16858
|
-
* @version
|
|
17007
|
+
* @version 186.0.1
|
|
16859
17008
|
*/ /**
|
|
16860
17009
|
* Constructs a new WebDeploymentsApi.
|
|
16861
17010
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -16976,7 +17125,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
16976
17125
|
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(){/**
|
|
16977
17126
|
* WebMessaging service.
|
|
16978
17127
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
16979
|
-
* @version
|
|
17128
|
+
* @version 186.0.1
|
|
16980
17129
|
*/ /**
|
|
16981
17130
|
* Constructs a new WebMessagingApi.
|
|
16982
17131
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -16992,7 +17141,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
16992
17141
|
*/_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(){/**
|
|
16993
17142
|
* Widgets service.
|
|
16994
17143
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
16995
|
-
* @version
|
|
17144
|
+
* @version 186.0.1
|
|
16996
17145
|
*/ /**
|
|
16997
17146
|
* Constructs a new WidgetsApi.
|
|
16998
17147
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -17027,7 +17176,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
17027
17176
|
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(){/**
|
|
17028
17177
|
* WorkforceManagement service.
|
|
17029
17178
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
17030
|
-
* @version
|
|
17179
|
+
* @version 186.0.1
|
|
17031
17180
|
*/ /**
|
|
17032
17181
|
* Constructs a new WorkforceManagementApi.
|
|
17033
17182
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -17296,6 +17445,26 @@ if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required
|
|
|
17296
17445
|
if(weekId===undefined||weekId===null){throw'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent';}// verify the required parameter 'scheduleId' is set
|
|
17297
17446
|
if(scheduleId===undefined||scheduleId===null){throw'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent';}// verify the required parameter 'agentId' is set
|
|
17298
17447
|
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']);}/**
|
|
17448
|
+
* Get the performance prediction for the associated schedule
|
|
17449
|
+
*
|
|
17450
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
17451
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
17452
|
+
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
17453
|
+
*/},{key:"getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions",value:function getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions(businessUnitId,weekId,scheduleId){// verify the required parameter 'businessUnitId' is set
|
|
17454
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';}// verify the required parameter 'weekId' is set
|
|
17455
|
+
if(weekId===undefined||weekId===null){throw'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';}// verify the required parameter 'scheduleId' is set
|
|
17456
|
+
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']);}/**
|
|
17457
|
+
* Get recalculated performance prediction result
|
|
17458
|
+
*
|
|
17459
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
17460
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
17461
|
+
* @param {String} scheduleId The ID of the schedule the recalculation belongs to
|
|
17462
|
+
* @param {String} recalculationId The ID of the recalculation request
|
|
17463
|
+
*/},{key:"getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation",value:function getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation(businessUnitId,weekId,scheduleId,recalculationId){// verify the required parameter 'businessUnitId' is set
|
|
17464
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';}// verify the required parameter 'weekId' is set
|
|
17465
|
+
if(weekId===undefined||weekId===null){throw'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';}// verify the required parameter 'scheduleId' is set
|
|
17466
|
+
if(scheduleId===undefined||scheduleId===null){throw'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';}// verify the required parameter 'recalculationId' is set
|
|
17467
|
+
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']);}/**
|
|
17299
17468
|
* Get the list of week schedules for the specified week
|
|
17300
17469
|
* 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
|
|
17301
17470
|
* @param {String} businessUnitId The ID of the business unit
|
|
@@ -17358,6 +17527,17 @@ if(forecastId===undefined||forecastId===null){throw'Missing the required paramet
|
|
|
17358
17527
|
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups';}// verify the required parameter 'weekDateId' is set
|
|
17359
17528
|
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups';}// verify the required parameter 'forecastId' is set
|
|
17360
17529
|
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']);}/**
|
|
17530
|
+
* Get the staffing requirement by planning group for a forecast
|
|
17531
|
+
*
|
|
17532
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
17533
|
+
* @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
|
|
17534
|
+
* @param {String} forecastId The ID of the forecast
|
|
17535
|
+
* @param {Object} opts Optional parameters
|
|
17536
|
+
* @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
|
|
17537
|
+
*/},{key:"getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement",value:function getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement(businessUnitId,weekDateId,forecastId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
17538
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';}// verify the required parameter 'weekDateId' is set
|
|
17539
|
+
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';}// verify the required parameter 'forecastId' is set
|
|
17540
|
+
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']);}/**
|
|
17361
17541
|
* Get short term forecasts
|
|
17362
17542
|
* 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
|
|
17363
17543
|
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
@@ -17674,6 +17854,13 @@ if(serviceGoalTemplateId===undefined||serviceGoalTemplateId===null){throw'Missin
|
|
|
17674
17854
|
* @param {Object} opts.body body
|
|
17675
17855
|
*/},{key:"patchWorkforcemanagementManagementunit",value:function patchWorkforcemanagementManagementunit(managementUnitId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
17676
17856
|
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']);}/**
|
|
17857
|
+
* Update agent configurations
|
|
17858
|
+
*
|
|
17859
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
17860
|
+
* @param {Object} opts Optional parameters
|
|
17861
|
+
* @param {Object} opts.body body
|
|
17862
|
+
*/},{key:"patchWorkforcemanagementManagementunitAgents",value:function patchWorkforcemanagementManagementunitAgents(managementUnitId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
17863
|
+
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']);}/**
|
|
17677
17864
|
* Updates a time off limit object.
|
|
17678
17865
|
* Updates time off limit object properties, but not daily values.
|
|
17679
17866
|
* @param {String} managementUnitId The ID of the management unit.
|
|
@@ -17885,6 +18072,28 @@ if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required
|
|
|
17885
18072
|
if(weekId===undefined||weekId===null){throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekScheduleCopy';}// verify the required parameter 'scheduleId' is set
|
|
17886
18073
|
if(scheduleId===undefined||scheduleId===null){throw'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekScheduleCopy';}// verify the required parameter 'body' is set
|
|
17887
18074
|
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']);}/**
|
|
18075
|
+
* Request a daily recalculation of the performance prediction for the associated schedule
|
|
18076
|
+
*
|
|
18077
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
18078
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
18079
|
+
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
18080
|
+
* @param {Object} opts Optional parameters
|
|
18081
|
+
* @param {Object} opts.body body
|
|
18082
|
+
*/},{key:"postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations",value:function postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations(businessUnitId,weekId,scheduleId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
18083
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';}// verify the required parameter 'weekId' is set
|
|
18084
|
+
if(weekId===undefined||weekId===null){throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';}// verify the required parameter 'scheduleId' is set
|
|
18085
|
+
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']);}/**
|
|
18086
|
+
* Upload daily activity changes to be able to request a performance prediction recalculation
|
|
18087
|
+
*
|
|
18088
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
18089
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
18090
|
+
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
18091
|
+
* @param {Object} opts Optional parameters
|
|
18092
|
+
* @param {Object} opts.body body
|
|
18093
|
+
*/},{key:"postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl",value:function postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl(businessUnitId,weekId,scheduleId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
18094
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';}// verify the required parameter 'weekId' is set
|
|
18095
|
+
if(weekId===undefined||weekId===null){throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';}// verify the required parameter 'scheduleId' is set
|
|
18096
|
+
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']);}/**
|
|
17888
18097
|
* Start a rescheduling run
|
|
17889
18098
|
*
|
|
17890
18099
|
* @param {String} businessUnitId The ID of the business unit
|
|
@@ -18318,7 +18527,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
18318
18527
|
* </pre>
|
|
18319
18528
|
* </p>
|
|
18320
18529
|
* @module purecloud-platform-client-v2/index
|
|
18321
|
-
* @version
|
|
18530
|
+
* @version 186.0.1
|
|
18322
18531
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
18323
18532
|
* The ApiClient constructor.
|
|
18324
18533
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|