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
|
@@ -4923,6 +4923,9 @@ var gOPD = require('gopd');
|
|
|
4923
4923
|
var $TypeError = GetIntrinsic('%TypeError%');
|
|
4924
4924
|
var $floor = GetIntrinsic('%Math.floor%');
|
|
4925
4925
|
|
|
4926
|
+
/** @typedef {(...args: unknown[]) => unknown} Func */
|
|
4927
|
+
|
|
4928
|
+
/** @type {<T extends Func = Func>(fn: T, length: number, loose?: boolean) => T} */
|
|
4926
4929
|
module.exports = function setFunctionLength(fn, length) {
|
|
4927
4930
|
if (typeof fn !== 'function') {
|
|
4928
4931
|
throw new $TypeError('`fn` is not a function');
|
|
@@ -4947,9 +4950,9 @@ module.exports = function setFunctionLength(fn, length) {
|
|
|
4947
4950
|
|
|
4948
4951
|
if (functionLengthIsConfigurable || functionLengthIsWritable || !loose) {
|
|
4949
4952
|
if (hasDescriptors) {
|
|
4950
|
-
define(fn, 'length', length, true, true);
|
|
4953
|
+
define(/** @type {Parameters<define>[0]} */ (fn), 'length', length, true, true);
|
|
4951
4954
|
} else {
|
|
4952
|
-
define(fn, 'length', length);
|
|
4955
|
+
define(/** @type {Parameters<define>[0]} */ (fn), 'length', length);
|
|
4953
4956
|
}
|
|
4954
4957
|
}
|
|
4955
4958
|
return fn;
|
|
@@ -5083,7 +5086,7 @@ module.exports = function getSideChannel() {
|
|
|
5083
5086
|
|
|
5084
5087
|
},{"call-bind/callBound":8,"get-intrinsic":13,"object-inspect":20}],"platformClient":[function(require,module,exports){
|
|
5085
5088
|
(function (global,Buffer){(function (){
|
|
5086
|
-
'use strict';function _toConsumableArray(arr){return _arrayWithoutHoles(arr)||_iterableToArray(arr)||_unsupportedIterableToArray(arr)||_nonIterableSpread();}function _nonIterableSpread(){throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");}function _arrayWithoutHoles(arr){if(Array.isArray(arr))return _arrayLikeToArray(arr);}function _toArray(arr){return _arrayWithHoles(arr)||_iterableToArray(arr)||_unsupportedIterableToArray(arr)||_nonIterableRest();}function _iterableToArray(iter){if(typeof Symbol!=="undefined"&&iter[Symbol.iterator]!=null||iter["@@iterator"]!=null)return Array.from(iter);}function _slicedToArray(arr,i){return _arrayWithHoles(arr)||_iterableToArrayLimit(arr,i)||_unsupportedIterableToArray(arr,i)||_nonIterableRest();}function _nonIterableRest(){throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");}function _unsupportedIterableToArray(o,minLen){if(!o)return;if(typeof o==="string")return _arrayLikeToArray(o,minLen);var n=Object.prototype.toString.call(o).slice(8,-1);if(n==="Object"&&o.constructor)n=o.constructor.name;if(n==="Map"||n==="Set")return Array.from(o);if(n==="Arguments"||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n))return _arrayLikeToArray(o,minLen);}function _arrayLikeToArray(arr,len){if(len==null||len>arr.length)len=arr.length;for(var i=0,arr2=new Array(len);i<len;i++)arr2[i]=arr[i];return arr2;}function _iterableToArrayLimit(r,l){var t=null==r?null:"undefined"!=typeof Symbol&&r[Symbol.iterator]||r["@@iterator"];if(null!=t){var e,n,i,u,a=[],f=!0,o=!1;try{if(i=(t=t.call(r)).next,0===l){if(Object(t)!==t)return;f=!1;}else for(;!(f=(e=i.call(t)).done)&&(a.push(e.value),a.length!==l);f=!0);}catch(r){o=!0,n=r;}finally{try{if(!f&&null!=t["return"]&&(u=t["return"](),Object(u)!==u))return;}finally{if(o)throw n;}}return a;}}function _arrayWithHoles(arr){if(Array.isArray(arr))return arr;}function ownKeys(e,r){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);r&&(o=o.filter(function(r){return Object.getOwnPropertyDescriptor(e,r).enumerable;})),t.push.apply(t,o);}return t;}function _objectSpread(e){for(var r=1;r<arguments.length;r++){var t=null!=arguments[r]?arguments[r]:{};r%2?ownKeys(Object(t),!0).forEach(function(r){_defineProperty(e,r,t[r]);}):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(t)):ownKeys(Object(t)).forEach(function(r){Object.defineProperty(e,r,Object.getOwnPropertyDescriptor(t,r));});}return e;}function _defineProperty(obj,key,value){key=_toPropertyKey(key);if(key in obj){Object.defineProperty(obj,key,{value:value,enumerable:true,configurable:true,writable:true});}else{obj[key]=value;}return obj;}function _classCallCheck(instance,Constructor){if(!(instance instanceof Constructor)){throw new TypeError("Cannot call a class as a function");}}function _defineProperties(target,props){for(var i=0;i<props.length;i++){var descriptor=props[i];descriptor.enumerable=descriptor.enumerable||false;descriptor.configurable=true;if("value"in descriptor)descriptor.writable=true;Object.defineProperty(target,_toPropertyKey(descriptor.key),descriptor);}}function _createClass(Constructor,protoProps,staticProps){if(protoProps)_defineProperties(Constructor.prototype,protoProps);if(staticProps)_defineProperties(Constructor,staticProps);Object.defineProperty(Constructor,"prototype",{writable:false});return Constructor;}function _toPropertyKey(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)
|
|
5089
|
+
'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)
|
|
5087
5090
|
// if there are two placeholders, than the two characters before it
|
|
5088
5091
|
// represent one byte
|
|
5089
5092
|
// if there is only one, then the three characters before it represent 2 bytes
|
|
@@ -5655,7 +5658,7 @@ return utils$1.matchAll(/\w+|\[(\w*)]/g,name).map(function(match){return match[0
|
|
|
5655
5658
|
* @param {string} formData The FormData object to convert to JSON.
|
|
5656
5659
|
*
|
|
5657
5660
|
* @returns {Object<string, any> | null} The converted object.
|
|
5658
|
-
*/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;}/**
|
|
5661
|
+
*/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;}/**
|
|
5659
5662
|
* It takes a string, tries to parse it, and if it fails, it returns the stringified version
|
|
5660
5663
|
* of the input
|
|
5661
5664
|
*
|
|
@@ -5726,7 +5729,7 @@ return /^([a-z][a-z\d+\-.]*:)?\/\//i.test(url);}/**
|
|
|
5726
5729
|
* @param {string} relativeURL The relative URL
|
|
5727
5730
|
*
|
|
5728
5731
|
* @returns {string} The combined URL
|
|
5729
|
-
*/function combineURLs(baseURL,relativeURL){return relativeURL?baseURL.replace(
|
|
5732
|
+
*/function combineURLs(baseURL,relativeURL){return relativeURL?baseURL.replace(/\/?\/$/,'')+'/'+relativeURL.replace(/^\/+/,''):baseURL;}/**
|
|
5730
5733
|
* Creates a new URL by combining the baseURL with the requestedURL,
|
|
5731
5734
|
* only when the requestedURL is not already an absolute URL.
|
|
5732
5735
|
* If the requestURL is absolute, this function returns the requestedURL untouched.
|
|
@@ -5819,7 +5822,7 @@ config2=config2||{};var config={};function getMergedValue(target,source,caseless
|
|
|
5819
5822
|
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
|
|
5820
5823
|
function valueFromConfig2(a,b){if(!utils$1.isUndefined(b)){return getMergedValue(undefined,b);}}// eslint-disable-next-line consistent-return
|
|
5821
5824
|
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
|
|
5822
|
-
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.
|
|
5825
|
+
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
|
|
5823
5826
|
['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={};/**
|
|
5824
5827
|
* Transitional option validator
|
|
5825
5828
|
*
|
|
@@ -5851,7 +5854,9 @@ console.warn(formatMessage(opt,' has been deprecated since v'+version+' and will
|
|
|
5851
5854
|
* @param {?Object} config
|
|
5852
5855
|
*
|
|
5853
5856
|
* @returns {Promise} The Promise to be fulfilled
|
|
5854
|
-
*/_createClass(Axios,[{key:"request",value:function
|
|
5857
|
+
*/_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
|
|
5858
|
+
dummy.stack=dummy.stack.replace(/^.+\n/,'');// match without the 2 top stack lines
|
|
5859
|
+
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
|
|
5855
5860
|
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
|
|
5856
5861
|
config.method=(config.method||this.defaults.method||'get').toLowerCase();// Flatten headers
|
|
5857
5862
|
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
|
|
@@ -5930,7 +5935,7 @@ if(env)this.environment=env;else this.environment=this.host?this.host:'mypureclo
|
|
|
5930
5935
|
this.environment=this.environment.replace(/\/+$/,'');// Strip protocol and subdomain
|
|
5931
5936
|
if(this.environment.startsWith('https://'))this.environment=this.environment.substring(8);if(this.environment.startsWith('http://'))this.environment=this.environment.substring(7);if(this.environment.startsWith('api.'))this.environment=this.environment.substring(4);this.basePath="https://api.".concat(this.environment);this.authUrl="https://login.".concat(this.environment);}},{key:"getConfigString",value:function getConfigString(section,key){if(this.config._sections[section])return this.config._sections[section][key];}},{key:"getConfigBoolean",value:function getConfigBoolean(section,key){if(this.config._sections[section]&&this.config._sections[section][key]!==undefined){if(typeof this.config._sections[section][key]==='string'){return this.config._sections[section][key]==='true';}else return this.config._sections[section][key];}}},{key:"getConfigInt",value:function getConfigInt(section,key){if(this.config._sections[section]&&this.config._sections[section][key]){if(typeof this.config._sections[section][key]==='string'){return parseInt(this.config._sections[section][key]);}else return this.config._sections[section][key];}}}]);return Configuration;}();/**
|
|
5932
5937
|
* @module purecloud-platform-client-v2/ApiClient
|
|
5933
|
-
* @version
|
|
5938
|
+
* @version 186.0.1
|
|
5934
5939
|
*/var ApiClient=/*#__PURE__*/function(){/**
|
|
5935
5940
|
* Manages low level client-server communications, parameter marshalling, etc. There should not be any need for an
|
|
5936
5941
|
* application to use this class directly - the *Api and model classes provide the public API for the service. The
|
|
@@ -6032,47 +6037,104 @@ _this3.config.logger.log('trace',response.status,'POST',"https://login.".concat(
|
|
|
6032
6037
|
var access_token=response.data.access_token;_this3.setAccessToken(access_token);_this3.authData.tokenExpiryTime=new Date().getTime()+response.data['expires_in']*1000;_this3.authData.tokenExpiryTimeString=new Date(_this3.authData.tokenExpiryTime).toUTCString();// Return auth data
|
|
6033
6038
|
resolve(_this3.authData);})["catch"](function(error){// Log error
|
|
6034
6039
|
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);});});}/**
|
|
6040
|
+
* @description Completes the PKCE Code Authorization.
|
|
6041
|
+
* @param {string} clientId - The client ID of an OAuth Code Authorization Grant client
|
|
6042
|
+
* @param {string} codeVerifier - code verifier used to generate the code challenge
|
|
6043
|
+
* @param {string} authCode - Authorization code
|
|
6044
|
+
* @param {string} redirectUri - Authorized redirect URI for your Code Authorization client
|
|
6045
|
+
*/},{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
|
|
6046
|
+
request.then(function(response){// Logging
|
|
6047
|
+
_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
|
|
6048
|
+
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
|
|
6049
|
+
resolve(_this4.authData);})["catch"](function(error){// Log error
|
|
6050
|
+
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);});});}/**
|
|
6051
|
+
* @description Generate a random string used as PKCE Code Verifier - length = 43 to 128.
|
|
6052
|
+
* @param {number} nChar - code length
|
|
6053
|
+
*/},{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
|
|
6054
|
+
{var unreservedCharacters="0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-._~";var randomString=Array.from(crypto.getRandomValues(new Uint32Array(nChar))).map(function(x){return unreservedCharacters[x%unreservedCharacters.length];}).join('');return randomString;}}/**
|
|
6055
|
+
* @description Compute Base64Url PKCE Code Challenge from Code Verifier.
|
|
6056
|
+
* @param {string} code - code verifier used to generate the code challenge
|
|
6057
|
+
*/},{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
|
|
6058
|
+
{// browser
|
|
6059
|
+
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
|
|
6060
|
+
return reject(new Error("Code Challenge Error ".concat(error)));});});}}/**
|
|
6061
|
+
* @description Initiates the pkce auth code grant login flow. Will attempt to load the token from local storage, if enabled.
|
|
6062
|
+
* @param {string} clientId - The client ID of an OAuth Implicit Grant client
|
|
6063
|
+
* @param {string} redirectUri - The redirect URI of the OAuth Implicit Grant client
|
|
6064
|
+
* @param {object} opts - (optional) Additional options
|
|
6065
|
+
* @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.
|
|
6066
|
+
* @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.
|
|
6067
|
+
* @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.
|
|
6068
|
+
* @param {string} codeVerifier - (optional) code verifier used to generate the code challenge
|
|
6069
|
+
*/},{key:"loginPKCEGrant",value:function loginPKCEGrant(clientId,redirectUri,opts,codeVerifier){var _this5=this;// Need Local Storage or non null codeVerifier as parameter
|
|
6070
|
+
if(!this.hasLocalStorage&&!codeVerifier){throw new Error("loginPKCEGrant requires Local Storage or codeVerifier as input parameter");}// Check for auth code in query
|
|
6071
|
+
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
|
|
6072
|
+
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
|
|
6073
|
+
if(query&&query.error){// remove codeVerifier from session storage
|
|
6074
|
+
if(_this5.hasLocalStorage){sessionStorage.removeItem("genesys_cloud_sdk_pkce_code_verifier");}// reset access token if any was stored
|
|
6075
|
+
_this5._saveSettings({accessToken:undefined});return reject(new Error("[".concat(query.error,"] ").concat(query.error_description)));}// Get token on auth code
|
|
6076
|
+
if(query&&query.code){if(!_this5.codeVerifier){// load codeVerifier from session storage
|
|
6077
|
+
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
|
|
6078
|
+
_this5._testTokenAccess().then(function(){if(!_this5.authData.state&&query.state)_this5.authData.state=query.state;// remove codeVerifier from session storage
|
|
6079
|
+
if(_this5.hasLocalStorage){sessionStorage.removeItem("genesys_cloud_sdk_pkce_code_verifier");}resolve(_this5.authData);})["catch"](function(error){// Handle failure response
|
|
6080
|
+
_this5._saveSettings({accessToken:undefined});// remove codeVerifier from session storage
|
|
6081
|
+
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
|
|
6082
|
+
_this5._saveSettings({accessToken:undefined});// remove codeVerifier from session storage
|
|
6083
|
+
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
|
|
6084
|
+
_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
|
|
6085
|
+
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,"]")));});});}});}/**
|
|
6086
|
+
* @description Parses the URL Query, grabs the code, and clears the query param. If no code is found, no action is taken.
|
|
6087
|
+
*/},{key:"_setValuesFromUrlQuery",value:function _setValuesFromUrlQuery(){// Check for window
|
|
6088
|
+
if(!(typeof window!=='undefined'&&window.location.search))return;// Process query string
|
|
6089
|
+
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
|
|
6090
|
+
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
|
|
6091
|
+
if(code){query.code=code;if(state){query.state=state;}}// Remove code from URL
|
|
6092
|
+
// Credit: https://stackoverflow.com/questions/1397329/how-to-remove-the-hash-from-window-location-with-javascript-without-page-refresh/5298684#5298684
|
|
6093
|
+
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
|
|
6094
|
+
scrollV=document.body.scrollTop;scrollH=document.body.scrollLeft;// Remove code
|
|
6095
|
+
history.pushState('',document.title,loc.pathname);// Restore the scroll offset, should be flicker free
|
|
6096
|
+
document.body.scrollTop=scrollV;document.body.scrollLeft=scrollH;}return query;}/**
|
|
6035
6097
|
* @description Initiates the Code Authorization. Only available in node apps.
|
|
6036
6098
|
* @param {string} clientId - The client ID of an OAuth Code Authorization Grant client
|
|
6037
6099
|
* @param {string} clientSecret - The client secret of an OAuth Code Authorization Grant client
|
|
6038
6100
|
* @param {string} authCode - Authorization code
|
|
6039
6101
|
* @param {string} redirectUri - Authorized redirect URI for your Code Authorization client
|
|
6040
|
-
*/},{key:"loginCodeAuthorizationGrant",value:function loginCodeAuthorizationGrant(clientId,clientSecret,authCode,redirectUri){var
|
|
6041
|
-
|
|
6102
|
+
*/},{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
|
|
6103
|
+
_this6._handleCodeAuthorizationResponse(request,bodyParam,resolve,reject);});}/**
|
|
6042
6104
|
* @description Requests a new access token for Code Authorization. Only available in node apps.
|
|
6043
6105
|
* @param {string} clientId - The client ID of an OAuth Code Authorization Grant client
|
|
6044
6106
|
* @param {string} clientSecret - The client secret of an OAuth Code Authorization Grant client
|
|
6045
6107
|
* @param {string} authCode - Authorization code
|
|
6046
6108
|
* @param {string} redirectUri - Authorized redirect URI for your Code Authorization client
|
|
6047
|
-
*/},{key:"refreshCodeAuthorizationGrant",value:function refreshCodeAuthorizationGrant(clientId,clientSecret,refreshToken){var
|
|
6048
|
-
|
|
6109
|
+
*/},{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
|
|
6110
|
+
_this7._handleCodeAuthorizationResponse(request,bodyParam,resolve,reject);});}/**
|
|
6049
6111
|
* @description Handles the response for code auth requests
|
|
6050
6112
|
* @param {object} request - Authorization request object
|
|
6051
6113
|
* @param {object} bodyParam - Input body data for authorization request
|
|
6052
6114
|
* @param {function} resolve - Promise resolve callback
|
|
6053
6115
|
* @param {function} reject - Promise reject callback
|
|
6054
|
-
*/},{key:"_handleCodeAuthorizationResponse",value:function _handleCodeAuthorizationResponse(request,bodyParam,resolve,reject){var
|
|
6055
|
-
|
|
6056
|
-
var access_token=response.data.access_token;var refresh_token=response.data.refresh_token;
|
|
6057
|
-
resolve(
|
|
6058
|
-
if(error.response){
|
|
6116
|
+
*/},{key:"_handleCodeAuthorizationResponse",value:function _handleCodeAuthorizationResponse(request,bodyParam,resolve,reject){var _this8=this;request.then(function(response){// Logging
|
|
6117
|
+
_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
|
|
6118
|
+
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
|
|
6119
|
+
resolve(_this8.authData);})["catch"](function(error){// Log error
|
|
6120
|
+
if(error.response){_this8.config.logger.log('error',error.response.status,'POST',"https://login.".concat(_this8.config.environment,"/oauth/token"),request.headers,error.response.headers,bodyParam,error.response.data);}reject(error);});}/**
|
|
6059
6121
|
* @description Utility function to create the request for auth requests
|
|
6060
6122
|
* @param {string} encodedData - Base64 encoded client and clientSecret pair
|
|
6061
6123
|
* @param {object} data - data to url form encode
|
|
6062
6124
|
*/},{key:"_formAuthRequest",value:function _formAuthRequest(encodedData,data){var request=axios$1({method:"POST",url:"https://login.".concat(this.config.environment,"/oauth/token"),headers:{'Authorization':'Basic '+encodedData,'Content-Type':'application/x-www-form-urlencoded'},data:qs__default["default"].stringify(data)});return request;}/**
|
|
6063
6125
|
* @description Handles an expired access token. Only available in node apps.
|
|
6064
6126
|
* @param {string} statusCode - The status code of a request
|
|
6065
|
-
*/},{key:"_handleExpiredAccessToken",value:function _handleExpiredAccessToken(){var
|
|
6066
|
-
|
|
6067
|
-
|
|
6127
|
+
*/},{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
|
|
6128
|
+
_this9.refreshInProgress=false;reject(err);});}else{// Wait refresh_token_wait_max seconds for other thread to complete refresh
|
|
6129
|
+
_this9._sleep(_this9.config.refresh_token_wait_max).then(function(){if(_this9.refreshInProgress)reject(new Error("Token refresh took longer than ".concat(_this9.config.refresh_token_wait_max," seconds")));else resolve();});}});}/**
|
|
6068
6130
|
* @description Sleeps for a defined length
|
|
6069
6131
|
* @param {int} millis - Length to sleep in milliseconds
|
|
6070
6132
|
*/},{key:"_sleep",value:function _sleep(millis){return new Promise(function(resolve){return setTimeout(resolve,millis);});}/**
|
|
6071
6133
|
* @description Loads token from storage, if enabled, and checks to ensure it works.
|
|
6072
|
-
*/},{key:"_testTokenAccess",value:function _testTokenAccess(){var
|
|
6073
|
-
|
|
6074
|
-
if(!
|
|
6075
|
-
|
|
6134
|
+
*/},{key:"_testTokenAccess",value:function _testTokenAccess(){var _this10=this;return new Promise(function(resolve,reject){// Load from storage
|
|
6135
|
+
_this10._loadSettings();// Check if there is a token to test
|
|
6136
|
+
if(!_this10.authentications['PureCloud OAuth'].accessToken){reject(new Error('Token is not set'));return;}// Test token
|
|
6137
|
+
_this10.callApi('/api/v2/tokens/me','GET',null,null,null,null,null,['PureCloud OAuth'],['application/json'],['application/json']).then(function(){resolve();})["catch"](function(error){_this10._saveSettings({accessToken:undefined});reject(error);});});}/**
|
|
6076
6138
|
* @description Parses the URL hash, grabs the access token, and clears the hash. If no access token is found, no action is taken.
|
|
6077
6139
|
*/},{key:"_setValuesFromUrlHash",value:function _setValuesFromUrlHash(){// Check for window
|
|
6078
6140
|
if(!(typeof window!=='undefined'&&window.location.hash))return;// Process hash string into object
|
|
@@ -6117,7 +6179,7 @@ this.setAccessToken(this.authentications['PureCloud OAuth'].accessToken);}/**
|
|
|
6117
6179
|
* @param {String} path The path to append to the base URL.
|
|
6118
6180
|
* @param {Object} pathParams The parameter values to append.
|
|
6119
6181
|
* @returns {String} The encoded path with parameter values substituted.
|
|
6120
|
-
*/},{key:"buildUrl",value:function buildUrl(path,pathParams){var
|
|
6182
|
+
*/},{key:"buildUrl",value:function buildUrl(path,pathParams){var _this11=this;if(!path.match(/^\//)){path="/".concat(path);}var url=this.config.basePath+path;url=url.replace(/\{([\w-]+)\}/g,function(fullMatch,key){var value;if(pathParams.hasOwnProperty(key)){value=_this11.paramToString(pathParams[key]);}else{value=fullMatch;}return encodeURIComponent(value);});return url;}/**
|
|
6121
6183
|
* Checks whether the given content type represents JSON.<br>
|
|
6122
6184
|
* JSON content type examples:<br>
|
|
6123
6185
|
* <ul>
|
|
@@ -6158,7 +6220,7 @@ return param.map(this.paramToString);default:throw new Error("Unknown collection
|
|
|
6158
6220
|
* Applies authentication headers to the request.
|
|
6159
6221
|
* @param {Object} request The axios request config object.
|
|
6160
6222
|
* @param {Array.<String>} authNames An array of authentication method names.
|
|
6161
|
-
*/},{key:"applyAuthToRequest",value:function applyAuthToRequest(request,authNames){var
|
|
6223
|
+
*/},{key:"applyAuthToRequest",value:function applyAuthToRequest(request,authNames){var _this12=this;authNames.forEach(function(authName){var auth=_this12.authentications[authName];switch(auth.type){case'basic':if(auth.username||auth.password){request.auth={username:auth.username||'',password:auth.password||''};}break;case'apiKey':if(auth.apiKey){var data={};if(auth.apiKeyPrefix){data[auth.name]="".concat(auth.apiKeyPrefix," ").concat(auth.apiKey);}else{data[auth.name]=auth.apiKey;}if(auth['in']==='header'){request.headers=_this12.addHeaders(request.headers,data);}else{request.params=_this12.serialize(data);}}break;case'oauth2':if(auth.accessToken){request.headers=_this12.addHeaders(request.headers,{'Authorization':"Bearer ".concat(auth.accessToken)});}break;default:throw new Error("Unknown authentication type: ".concat(auth.type));}});}/**
|
|
6162
6224
|
* @description Sets the proxy agent axios will use for requests
|
|
6163
6225
|
* @param {any} agent - The proxy agent
|
|
6164
6226
|
*/},{key:"setProxyAgent",value:function setProxyAgent(agent){this.proxyAgent=agent;}/**
|
|
@@ -6175,7 +6237,7 @@ return param.map(this.paramToString);default:throw new Error("Unknown collection
|
|
|
6175
6237
|
* @param {Array.<String>} accepts An array of acceptable response MIME types.types or the
|
|
6176
6238
|
* constructor for a complex type.
|
|
6177
6239
|
* @returns {Promise} A Promise object.
|
|
6178
|
-
*/},{key:"callApi",value:function callApi(path,httpMethod,pathParams,queryParams,headerParams,formParams,bodyParam,authNames,contentTypes,accepts){var
|
|
6240
|
+
*/},{key:"callApi",value:function callApi(path,httpMethod,pathParams,queryParams,headerParams,formParams,bodyParam,authNames,contentTypes,accepts){var _this13=this;return new Promise(function(resolve,reject){sendRequest(_this13);function sendRequest(that){var url=that.buildUrl(path,pathParams);var request={method:httpMethod,url:url,httpsAgent:that.proxyAgent,timeout:that.timeout,params:that.serialize(queryParams)};// apply authentications
|
|
6179
6241
|
that.applyAuthToRequest(request,authNames);// set header parameters
|
|
6180
6242
|
var defaultHeaders=that.defaultHeaders;var normalizedHeaderParams=that.normalizeParams(headerParams);request.headers=that.addHeaders(request.headers,defaultHeaders,normalizedHeaderParams);var contentType=that.jsonPreferredMime(contentTypes);if(contentType){request.headers['Content-Type']=contentType;}else if(!request.headers['Content-Type']){request.headers['Content-Type']='application/json';}if(contentType==='application/x-www-form-urlencoded'){request.data=that.normalizeParams(formParams);}else if(contentType=='multipart/form-data'){var _formParams=that.normalizeParams(formParams);for(var key in _formParams){if(_formParams.hasOwnProperty(key)){// Looks like axios handles files and forms the same way
|
|
6181
6243
|
var formData=new FormData();formData.set(key,_formParams[key]);request.data=formData;}}}else if(bodyParam){request.data=bodyParam;}var accept=that.jsonPreferredMime(accepts);if(accept){request.headers['Accept']=accept;}axios$1.request(request).then(function(response){// Build response object
|
|
@@ -6185,7 +6247,7 @@ resolve(data);})["catch"](function(error){var data=error;if(error.response&&erro
|
|
|
6185
6247
|
that.config.logger.log('error',error.response.status,httpMethod,url,request.headers,error.response.headers,bodyParam,error.response.data);data=that.returnExtended===true?{status:error.response.status,statusText:error.response.statusText,headers:error.response.headers,body:error.response.data,text:error.response.text,error:error}:error.response.data?error.response.data:error.response.text;}reject(data);});}});}}]);return ApiClient;}();var AlertingApi=/*#__PURE__*/function(){/**
|
|
6186
6248
|
* Alerting service.
|
|
6187
6249
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
6188
|
-
* @version
|
|
6250
|
+
* @version 186.0.1
|
|
6189
6251
|
*/ /**
|
|
6190
6252
|
* Constructs a new AlertingApi.
|
|
6191
6253
|
* @alias module:purecloud-platform-client-v2/api/AlertingApi
|
|
@@ -6342,7 +6404,7 @@ if(ruleId===undefined||ruleId===null){throw'Missing the required parameter "rule
|
|
|
6342
6404
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling putAlertingRule';}return this.apiClient.callApi('/api/v2/alerting/rules/{ruleId}','PUT',{'ruleId':ruleId},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return AlertingApi;}();var AnalyticsApi=/*#__PURE__*/function(){/**
|
|
6343
6405
|
* Analytics service.
|
|
6344
6406
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
6345
|
-
* @version
|
|
6407
|
+
* @version 186.0.1
|
|
6346
6408
|
*/ /**
|
|
6347
6409
|
* Constructs a new AnalyticsApi.
|
|
6348
6410
|
* @alias module:purecloud-platform-client-v2/api/AnalyticsApi
|
|
@@ -6949,7 +7011,7 @@ if(scheduleId===undefined||scheduleId===null){throw'Missing the required paramet
|
|
|
6949
7011
|
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(){/**
|
|
6950
7012
|
* Architect service.
|
|
6951
7013
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6952
|
-
* @version
|
|
7014
|
+
* @version 186.0.1
|
|
6953
7015
|
*/ /**
|
|
6954
7016
|
* Constructs a new ArchitectApi.
|
|
6955
7017
|
* @alias module:purecloud-platform-client-v2/api/ArchitectApi
|
|
@@ -7842,7 +7904,7 @@ if(datatableId===undefined||datatableId===null){throw'Missing the required param
|
|
|
7842
7904
|
if(datatableId===undefined||datatableId===null){throw'Missing the required parameter "datatableId" when calling postFlowsDatatableImportJobs';}// verify the required parameter 'body' is set
|
|
7843
7905
|
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']);}/**
|
|
7844
7906
|
* Create a new row entry for the datatable.
|
|
7845
|
-
* 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" }
|
|
7907
|
+
* 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" }
|
|
7846
7908
|
* @param {String} datatableId id of datatable
|
|
7847
7909
|
* @param {Object.<String, {String: Object}>} dataTableRow
|
|
7848
7910
|
*/},{key:"postFlowsDatatableRows",value:function postFlowsDatatableRows(datatableId,dataTableRow){// verify the required parameter 'datatableId' is set
|
|
@@ -7957,7 +8019,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
7957
8019
|
if(datatableId===undefined||datatableId===null){throw'Missing the required parameter "datatableId" when calling putFlowsDatatable';}// verify the required parameter 'body' is set
|
|
7958
8020
|
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']);}/**
|
|
7959
8021
|
* Update a row entry
|
|
7960
|
-
* 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" }
|
|
8022
|
+
* 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" }
|
|
7961
8023
|
* @param {String} datatableId id of datatable
|
|
7962
8024
|
* @param {String} rowId the key for the row
|
|
7963
8025
|
* @param {Object} opts Optional parameters
|
|
@@ -7981,7 +8043,7 @@ if(milestoneId===undefined||milestoneId===null){throw'Missing the required param
|
|
|
7981
8043
|
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(){/**
|
|
7982
8044
|
* Audit service.
|
|
7983
8045
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
7984
|
-
* @version
|
|
8046
|
+
* @version 186.0.1
|
|
7985
8047
|
*/ /**
|
|
7986
8048
|
* Constructs a new AuditApi.
|
|
7987
8049
|
* @alias module:purecloud-platform-client-v2/api/AuditApi
|
|
@@ -8023,7 +8085,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8023
8085
|
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(){/**
|
|
8024
8086
|
* Authorization service.
|
|
8025
8087
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8026
|
-
* @version
|
|
8088
|
+
* @version 186.0.1
|
|
8027
8089
|
*/ /**
|
|
8028
8090
|
* Constructs a new AuthorizationApi.
|
|
8029
8091
|
* @alias module:purecloud-platform-client-v2/api/AuthorizationApi
|
|
@@ -8077,9 +8139,8 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
8077
8139
|
* @param {String} opts.nextPage next page token
|
|
8078
8140
|
* @param {String} opts.previousPage Previous page token
|
|
8079
8141
|
* @param {Boolean} opts.objectCount Include the count of objects contained in the division (default to false)
|
|
8080
|
-
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
8081
8142
|
* @param {String} opts.name Search term to filter by division name
|
|
8082
|
-
*/},{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'],'
|
|
8143
|
+
*/},{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']);}/**
|
|
8083
8144
|
* Retrieve the home division for the organization.
|
|
8084
8145
|
* Will not include object counts.
|
|
8085
8146
|
*/},{key:"getAuthorizationDivisionsHome",value:function getAuthorizationDivisionsHome(){return this.apiClient.callApi('/api/v2/authorization/divisions/home','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -8128,7 +8189,7 @@ if(permission===undefined||permission===null){throw'Missing the required paramet
|
|
|
8128
8189
|
* Get the organization role specified by its ID.
|
|
8129
8190
|
* @param {String} roleId Role ID
|
|
8130
8191
|
* @param {Object} opts Optional parameters
|
|
8131
|
-
* @param {Object} opts.userCount Fetch the count of users who have this role granted in at least one division (default to true)
|
|
8192
|
+
* @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)
|
|
8132
8193
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand. unusedPermissions returns the permissions not used for the role
|
|
8133
8194
|
*/},{key:"getAuthorizationRole",value:function getAuthorizationRole(roleId,opts){opts=opts||{};// verify the required parameter 'roleId' is set
|
|
8134
8195
|
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']);}/**
|
|
@@ -8334,7 +8395,7 @@ if(subjectId===undefined||subjectId===null){throw'Missing the required parameter
|
|
|
8334
8395
|
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(){/**
|
|
8335
8396
|
* Billing service.
|
|
8336
8397
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
8337
|
-
* @version
|
|
8398
|
+
* @version 186.0.1
|
|
8338
8399
|
*/ /**
|
|
8339
8400
|
* Constructs a new BillingApi.
|
|
8340
8401
|
* @alias module:purecloud-platform-client-v2/api/BillingApi
|
|
@@ -8358,7 +8419,7 @@ if(endDate===undefined||endDate===null){throw'Missing the required parameter "en
|
|
|
8358
8419
|
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(){/**
|
|
8359
8420
|
* CarrierServices service.
|
|
8360
8421
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
8361
|
-
* @version
|
|
8422
|
+
* @version 186.0.1
|
|
8362
8423
|
*/ /**
|
|
8363
8424
|
* Constructs a new CarrierServicesApi.
|
|
8364
8425
|
* @alias module:purecloud-platform-client-v2/api/CarrierServicesApi
|
|
@@ -8378,7 +8439,7 @@ if(phoneNumber===undefined||phoneNumber===null){throw'Missing the required param
|
|
|
8378
8439
|
*/},{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(){/**
|
|
8379
8440
|
* Chat service.
|
|
8380
8441
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
8381
|
-
* @version
|
|
8442
|
+
* @version 186.0.1
|
|
8382
8443
|
*/ /**
|
|
8383
8444
|
* Constructs a new ChatApi.
|
|
8384
8445
|
* @alias module:purecloud-platform-client-v2/api/ChatApi
|
|
@@ -8497,6 +8558,12 @@ if(messageIds===undefined||messageIds===null){throw'Missing the required paramet
|
|
|
8497
8558
|
* getChatsUserMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8498
8559
|
*/},{key:"getChatsUserMessages",value:function getChatsUserMessages(userId,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
8499
8560
|
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']);}/**
|
|
8561
|
+
* Get a user's chat settings
|
|
8562
|
+
*
|
|
8563
|
+
* @param {String} userId User ID
|
|
8564
|
+
* getChatsUserSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8565
|
+
*/},{key:"getChatsUserSettings",value:function getChatsUserSettings(userId){// verify the required parameter 'userId' is set
|
|
8566
|
+
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']);}/**
|
|
8500
8567
|
* Set properties for a room
|
|
8501
8568
|
*
|
|
8502
8569
|
* @param {String} roomJid roomJid
|
|
@@ -8530,6 +8597,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8530
8597
|
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling patchChatsUserMessage';}// verify the required parameter 'messageId' is set
|
|
8531
8598
|
if(messageId===undefined||messageId===null){throw'Missing the required parameter "messageId" when calling patchChatsUserMessage';}// verify the required parameter 'body' is set
|
|
8532
8599
|
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']);}/**
|
|
8600
|
+
* Update a user's chat settings
|
|
8601
|
+
*
|
|
8602
|
+
* @param {String} userId User ID
|
|
8603
|
+
* @param {Object} body
|
|
8604
|
+
* patchChatsUserSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8605
|
+
*/},{key:"patchChatsUserSettings",value:function patchChatsUserSettings(userId,body){// verify the required parameter 'userId' is set
|
|
8606
|
+
if(userId===undefined||userId===null){throw'Missing the required parameter "userId" when calling patchChatsUserSettings';}// verify the required parameter 'body' is set
|
|
8607
|
+
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']);}/**
|
|
8533
8608
|
* Send a message to a room
|
|
8534
8609
|
*
|
|
8535
8610
|
* @param {String} roomJid roomId
|
|
@@ -8575,7 +8650,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8575
8650
|
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(){/**
|
|
8576
8651
|
* Coaching service.
|
|
8577
8652
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
8578
|
-
* @version
|
|
8653
|
+
* @version 186.0.1
|
|
8579
8654
|
*/ /**
|
|
8580
8655
|
* Constructs a new CoachingApi.
|
|
8581
8656
|
* @alias module:purecloud-platform-client-v2/api/CoachingApi
|
|
@@ -8728,7 +8803,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
8728
8803
|
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(){/**
|
|
8729
8804
|
* ContentManagement service.
|
|
8730
8805
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
8731
|
-
* @version
|
|
8806
|
+
* @version 186.0.1
|
|
8732
8807
|
*/ /**
|
|
8733
8808
|
* Constructs a new ContentManagementApi.
|
|
8734
8809
|
* @alias module:purecloud-platform-client-v2/api/ContentManagementApi
|
|
@@ -8781,19 +8856,6 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
8781
8856
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
8782
8857
|
*/},{key:"getContentmanagementDocument",value:function getContentmanagementDocument(documentId,opts){opts=opts||{};// verify the required parameter 'documentId' is set
|
|
8783
8858
|
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']);}/**
|
|
8784
|
-
* Get a list of audits for a document.
|
|
8785
|
-
* This api is deprecated, use https://developer.genesys.cloud/platform/audit/ instead.
|
|
8786
|
-
* @param {String} documentId Document ID
|
|
8787
|
-
* @param {Object} opts Optional parameters
|
|
8788
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
8789
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
8790
|
-
* @param {String} opts.transactionFilter Transaction filter
|
|
8791
|
-
* @param {String} opts.level level (default to USER)
|
|
8792
|
-
* @param {String} opts.sortBy Sort by
|
|
8793
|
-
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
8794
|
-
* @deprecated
|
|
8795
|
-
*/},{key:"getContentmanagementDocumentAudits",value:function getContentmanagementDocumentAudits(documentId,opts){opts=opts||{};// verify the required parameter 'documentId' is set
|
|
8796
|
-
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']);}/**
|
|
8797
8859
|
* Download a document.
|
|
8798
8860
|
*
|
|
8799
8861
|
* @param {String} documentId Document ID
|
|
@@ -8936,12 +8998,6 @@ if(workspaceId===undefined||workspaceId===null){throw'Missing the required param
|
|
|
8936
8998
|
* @param {Array.<String>} opts.access Requested access level.
|
|
8937
8999
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
8938
9000
|
*/},{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']);}/**
|
|
8939
|
-
* Query audits
|
|
8940
|
-
* This api is deprecated, use https://developer.genesys.cloud/platform/audit/ instead.
|
|
8941
|
-
* @param {Object} body Allows for a filtered query returning facet information
|
|
8942
|
-
* @deprecated
|
|
8943
|
-
*/},{key:"postContentmanagementAuditquery",value:function postContentmanagementAuditquery(body){// verify the required parameter 'body' is set
|
|
8944
|
-
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']);}/**
|
|
8945
9001
|
* Update a document.
|
|
8946
9002
|
*
|
|
8947
9003
|
* @param {String} documentId Document ID
|
|
@@ -9030,7 +9086,7 @@ if(tagId===undefined||tagId===null){throw'Missing the required parameter "tagId"
|
|
|
9030
9086
|
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(){/**
|
|
9031
9087
|
* Conversations service.
|
|
9032
9088
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
9033
|
-
* @version
|
|
9089
|
+
* @version 186.0.1
|
|
9034
9090
|
*/ /**
|
|
9035
9091
|
* Constructs a new ConversationsApi.
|
|
9036
9092
|
* @alias module:purecloud-platform-client-v2/api/ConversationsApi
|
|
@@ -10754,7 +10810,7 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
10754
10810
|
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(){/**
|
|
10755
10811
|
* DataExtensions service.
|
|
10756
10812
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
10757
|
-
* @version
|
|
10813
|
+
* @version 186.0.1
|
|
10758
10814
|
*/ /**
|
|
10759
10815
|
* Constructs a new DataExtensionsApi.
|
|
10760
10816
|
* @alias module:purecloud-platform-client-v2/api/DataExtensionsApi
|
|
@@ -10775,7 +10831,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
10775
10831
|
*/},{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(){/**
|
|
10776
10832
|
* Downloads service.
|
|
10777
10833
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
10778
|
-
* @version
|
|
10834
|
+
* @version 186.0.1
|
|
10779
10835
|
*/ /**
|
|
10780
10836
|
* Constructs a new DownloadsApi.
|
|
10781
10837
|
* @alias module:purecloud-platform-client-v2/api/DownloadsApi
|
|
@@ -10794,7 +10850,7 @@ if(coretypeName===undefined||coretypeName===null){throw'Missing the required par
|
|
|
10794
10850
|
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(){/**
|
|
10795
10851
|
* Emails service.
|
|
10796
10852
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
10797
|
-
* @version
|
|
10853
|
+
* @version 186.0.1
|
|
10798
10854
|
*/ /**
|
|
10799
10855
|
* Constructs a new EmailsApi.
|
|
10800
10856
|
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
@@ -10812,7 +10868,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
10812
10868
|
*/},{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(){/**
|
|
10813
10869
|
* Events service.
|
|
10814
10870
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
10815
|
-
* @version
|
|
10871
|
+
* @version 186.0.1
|
|
10816
10872
|
*/ /**
|
|
10817
10873
|
* Constructs a new EventsApi.
|
|
10818
10874
|
* @alias module:purecloud-platform-client-v2/api/EventsApi
|
|
@@ -10837,7 +10893,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
10837
10893
|
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(){/**
|
|
10838
10894
|
* ExternalContacts service.
|
|
10839
10895
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
10840
|
-
* @version
|
|
10896
|
+
* @version 186.0.1
|
|
10841
10897
|
*/ /**
|
|
10842
10898
|
* Constructs a new ExternalContactsApi.
|
|
10843
10899
|
* @alias module:purecloud-platform-client-v2/api/ExternalContactsApi
|
|
@@ -10920,7 +10976,7 @@ if(noteId===undefined||noteId===null){throw'Missing the required parameter "note
|
|
|
10920
10976
|
* @param {Object} opts Optional parameters
|
|
10921
10977
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
10922
10978
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
10923
|
-
* @param {String} opts.sortOrder
|
|
10979
|
+
* @param {String} opts.sortOrder The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. createDate:asc, createDate:desc
|
|
10924
10980
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
10925
10981
|
*/},{key:"getExternalcontactsContactNotes",value:function getExternalcontactsContactNotes(contactId,opts){opts=opts||{};// verify the required parameter 'contactId' is set
|
|
10926
10982
|
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']);}/**
|
|
@@ -10937,7 +10993,7 @@ if(contactId===undefined||contactId===null){throw'Missing the required parameter
|
|
|
10937
10993
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
10938
10994
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
10939
10995
|
* @param {String} opts.q User supplied search keywords (no special syntax is currently supported)
|
|
10940
|
-
* @param {String} opts.sortOrder
|
|
10996
|
+
* @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
|
|
10941
10997
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
10942
10998
|
*/},{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']);}/**
|
|
10943
10999
|
* Get a schema
|
|
@@ -10975,7 +11031,7 @@ if(externalOrganizationId===undefined||externalOrganizationId===null){throw'Miss
|
|
|
10975
11031
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
10976
11032
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
10977
11033
|
* @param {String} opts.q User supplied search keywords (no special syntax is currently supported)
|
|
10978
|
-
* @param {String} opts.sortOrder
|
|
11034
|
+
* @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
|
|
10979
11035
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
10980
11036
|
*/},{key:"getExternalcontactsOrganizationContacts",value:function getExternalcontactsOrganizationContacts(externalOrganizationId,opts){opts=opts||{};// verify the required parameter 'externalOrganizationId' is set
|
|
10981
11037
|
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']);}/**
|
|
@@ -10994,7 +11050,7 @@ if(noteId===undefined||noteId===null){throw'Missing the required parameter "note
|
|
|
10994
11050
|
* @param {Object} opts Optional parameters
|
|
10995
11051
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
10996
11052
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
10997
|
-
* @param {String} opts.sortOrder
|
|
11053
|
+
* @param {String} opts.sortOrder The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. createDate:asc, createDate:desc
|
|
10998
11054
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
10999
11055
|
*/},{key:"getExternalcontactsOrganizationNotes",value:function getExternalcontactsOrganizationNotes(externalOrganizationId,opts){opts=opts||{};// verify the required parameter 'externalOrganizationId' is set
|
|
11000
11056
|
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']);}/**
|
|
@@ -11005,7 +11061,7 @@ if(externalOrganizationId===undefined||externalOrganizationId===null){throw'Miss
|
|
|
11005
11061
|
* @param {Number} opts.pageSize Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 20)
|
|
11006
11062
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
11007
11063
|
* @param {Object} opts.expand which fields, if any, to expand
|
|
11008
|
-
* @param {String} opts.sortOrder
|
|
11064
|
+
* @param {String} opts.sortOrder The Relationship field to sort by. Any of: [createDate, relationship]. Direction: [asc, desc]. e.g. createDate:asc, relationship:desc
|
|
11009
11065
|
*/},{key:"getExternalcontactsOrganizationRelationships",value:function getExternalcontactsOrganizationRelationships(externalOrganizationId,opts){opts=opts||{};// verify the required parameter 'externalOrganizationId' is set
|
|
11010
11066
|
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']);}/**
|
|
11011
11067
|
* Search for external organizations
|
|
@@ -11015,7 +11071,7 @@ if(externalOrganizationId===undefined||externalOrganizationId===null){throw'Miss
|
|
|
11015
11071
|
* @param {Number} opts.pageNumber Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (default to 1)
|
|
11016
11072
|
* @param {String} opts.q Search query
|
|
11017
11073
|
* @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
|
|
11018
|
-
* @param {String} opts.sortOrder
|
|
11074
|
+
* @param {String} opts.sortOrder The Organization field to sort by. Any of: [companyType, industry, name]. Direction: [asc, desc]. e.g. companyType:asc, industry:desc
|
|
11019
11075
|
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
11020
11076
|
* @param {Boolean} opts.includeTrustors (true or false) whether or not to include trustor information embedded in the externalOrganization
|
|
11021
11077
|
*/},{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']);}/**
|
|
@@ -11292,7 +11348,7 @@ if(relationshipId===undefined||relationshipId===null){throw'Missing the required
|
|
|
11292
11348
|
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(){/**
|
|
11293
11349
|
* Fax service.
|
|
11294
11350
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
11295
|
-
* @version
|
|
11351
|
+
* @version 186.0.1
|
|
11296
11352
|
*/ /**
|
|
11297
11353
|
* Constructs a new FaxApi.
|
|
11298
11354
|
* @alias module:purecloud-platform-client-v2/api/FaxApi
|
|
@@ -11333,7 +11389,7 @@ if(documentId===undefined||documentId===null){throw'Missing the required paramet
|
|
|
11333
11389
|
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(){/**
|
|
11334
11390
|
* Flows service.
|
|
11335
11391
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
11336
|
-
* @version
|
|
11392
|
+
* @version 186.0.1
|
|
11337
11393
|
*/ /**
|
|
11338
11394
|
* Constructs a new FlowsApi.
|
|
11339
11395
|
* @alias module:purecloud-platform-client-v2/api/FlowsApi
|
|
@@ -11382,7 +11438,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11382
11438
|
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(){/**
|
|
11383
11439
|
* Gamification service.
|
|
11384
11440
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
11385
|
-
* @version
|
|
11441
|
+
* @version 186.0.1
|
|
11386
11442
|
*/ /**
|
|
11387
11443
|
* Constructs a new GamificationApi.
|
|
11388
11444
|
* @alias module:purecloud-platform-client-v2/api/GamificationApi
|
|
@@ -11922,7 +11978,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
11922
11978
|
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(){/**
|
|
11923
11979
|
* GeneralDataProtectionRegulation service.
|
|
11924
11980
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
11925
|
-
* @version
|
|
11981
|
+
* @version 186.0.1
|
|
11926
11982
|
*/ /**
|
|
11927
11983
|
* Constructs a new GeneralDataProtectionRegulationApi.
|
|
11928
11984
|
* @alias module:purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
@@ -11957,7 +12013,7 @@ if(searchValue===undefined||searchValue===null){throw'Missing the required param
|
|
|
11957
12013
|
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(){/**
|
|
11958
12014
|
* Geolocation service.
|
|
11959
12015
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
11960
|
-
* @version
|
|
12016
|
+
* @version 186.0.1
|
|
11961
12017
|
*/ /**
|
|
11962
12018
|
* Constructs a new GeolocationApi.
|
|
11963
12019
|
* @alias module:purecloud-platform-client-v2/api/GeolocationApi
|
|
@@ -11991,7 +12047,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
11991
12047
|
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(){/**
|
|
11992
12048
|
* Greetings service.
|
|
11993
12049
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
11994
|
-
* @version
|
|
12050
|
+
* @version 186.0.1
|
|
11995
12051
|
*/ /**
|
|
11996
12052
|
* Constructs a new GreetingsApi.
|
|
11997
12053
|
* @alias module:purecloud-platform-client-v2/api/GreetingsApi
|
|
@@ -12098,7 +12154,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
12098
12154
|
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(){/**
|
|
12099
12155
|
* Groups service.
|
|
12100
12156
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
12101
|
-
* @version
|
|
12157
|
+
* @version 186.0.1
|
|
12102
12158
|
*/ /**
|
|
12103
12159
|
* Constructs a new GroupsApi.
|
|
12104
12160
|
* @alias module:purecloud-platform-client-v2/api/GroupsApi
|
|
@@ -12231,7 +12287,7 @@ if(groupId===undefined||groupId===null){throw'Missing the required parameter "gr
|
|
|
12231
12287
|
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(){/**
|
|
12232
12288
|
* IdentityProvider service.
|
|
12233
12289
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
12234
|
-
* @version
|
|
12290
|
+
* @version 186.0.1
|
|
12235
12291
|
*/ /**
|
|
12236
12292
|
* Constructs a new IdentityProviderApi.
|
|
12237
12293
|
* @alias module:purecloud-platform-client-v2/api/IdentityProviderApi
|
|
@@ -12365,7 +12421,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
12365
12421
|
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(){/**
|
|
12366
12422
|
* InfrastructureAsCode service.
|
|
12367
12423
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
12368
|
-
* @version
|
|
12424
|
+
* @version 186.0.1
|
|
12369
12425
|
*/ /**
|
|
12370
12426
|
* Constructs a new InfrastructureAsCodeApi.
|
|
12371
12427
|
* @alias module:purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
@@ -12419,7 +12475,7 @@ if(jobId===undefined||jobId===null){throw'Missing the required parameter "jobId"
|
|
|
12419
12475
|
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(){/**
|
|
12420
12476
|
* Integrations service.
|
|
12421
12477
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
12422
|
-
* @version
|
|
12478
|
+
* @version 186.0.1
|
|
12423
12479
|
*/ /**
|
|
12424
12480
|
* Constructs a new IntegrationsApi.
|
|
12425
12481
|
* @alias module:purecloud-platform-client-v2/api/IntegrationsApi
|
|
@@ -12549,6 +12605,12 @@ if(fileName===undefined||fileName===null){throw'Missing the required parameter "
|
|
|
12549
12605
|
* @param {Object} opts.sortOrder Direction to sort 'sortBy' field. (default to asc)
|
|
12550
12606
|
* @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.
|
|
12551
12607
|
*/},{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']);}/**
|
|
12608
|
+
* Retrieves the available mTLS client certificates in use. This endpoint will return inconsistent results while a certificate rotation is in progress.
|
|
12609
|
+
*
|
|
12610
|
+
* @param {Object} opts Optional parameters
|
|
12611
|
+
* @param {Object} opts.status Indicates the validity of the certificate in question.
|
|
12612
|
+
* @param {Object} opts.type Indicates the type of the certificate.
|
|
12613
|
+
*/},{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']);}/**
|
|
12552
12614
|
* Retrieves all action drafts associated with the filters passed in via query param.
|
|
12553
12615
|
*
|
|
12554
12616
|
* @param {Object} opts Optional parameters
|
|
@@ -12940,7 +13002,7 @@ if(ucIntegrationId===undefined||ucIntegrationId===null){throw'Missing the requir
|
|
|
12940
13002
|
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(){/**
|
|
12941
13003
|
* Journey service.
|
|
12942
13004
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
12943
|
-
* @version
|
|
13005
|
+
* @version 186.0.1
|
|
12944
13006
|
*/ /**
|
|
12945
13007
|
* Constructs a new JourneyApi.
|
|
12946
13008
|
* @alias module:purecloud-platform-client-v2/api/JourneyApi
|
|
@@ -13244,7 +13306,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
13244
13306
|
*/},{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(){/**
|
|
13245
13307
|
* Knowledge service.
|
|
13246
13308
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
13247
|
-
* @version
|
|
13309
|
+
* @version 186.0.1
|
|
13248
13310
|
*/ /**
|
|
13249
13311
|
* Constructs a new KnowledgeApi.
|
|
13250
13312
|
* @alias module:purecloud-platform-client-v2/api/KnowledgeApi
|
|
@@ -14041,7 +14103,7 @@ if(knowledgeBaseId===undefined||knowledgeBaseId===null){throw'Missing the requir
|
|
|
14041
14103
|
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(){/**
|
|
14042
14104
|
* LanguageUnderstanding service.
|
|
14043
14105
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
14044
|
-
* @version
|
|
14106
|
+
* @version 186.0.1
|
|
14045
14107
|
*/ /**
|
|
14046
14108
|
* Constructs a new LanguageUnderstandingApi.
|
|
14047
14109
|
* @alias module:purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
@@ -14297,7 +14359,7 @@ if(domainVersionId===undefined||domainVersionId===null){throw'Missing the requir
|
|
|
14297
14359
|
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(){/**
|
|
14298
14360
|
* Languages service.
|
|
14299
14361
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
14300
|
-
* @version
|
|
14362
|
+
* @version 186.0.1
|
|
14301
14363
|
*/ /**
|
|
14302
14364
|
* Constructs a new LanguagesApi.
|
|
14303
14365
|
* @alias module:purecloud-platform-client-v2/api/LanguagesApi
|
|
@@ -14352,7 +14414,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
14352
14414
|
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(){/**
|
|
14353
14415
|
* Learning service.
|
|
14354
14416
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
14355
|
-
* @version
|
|
14417
|
+
* @version 186.0.1
|
|
14356
14418
|
*/ /**
|
|
14357
14419
|
* Constructs a new LearningApi.
|
|
14358
14420
|
* @alias module:purecloud-platform-client-v2/api/LearningApi
|
|
@@ -14582,7 +14644,7 @@ if(moduleId===undefined||moduleId===null){throw'Missing the required parameter "
|
|
|
14582
14644
|
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(){/**
|
|
14583
14645
|
* License service.
|
|
14584
14646
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
14585
|
-
* @version
|
|
14647
|
+
* @version 186.0.1
|
|
14586
14648
|
*/ /**
|
|
14587
14649
|
* Constructs a new LicenseApi.
|
|
14588
14650
|
* @alias module:purecloud-platform-client-v2/api/LicenseApi
|
|
@@ -14636,7 +14698,7 @@ if(featureName===undefined||featureName===null){throw'Missing the required param
|
|
|
14636
14698
|
*/},{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(){/**
|
|
14637
14699
|
* Locations service.
|
|
14638
14700
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
14639
|
-
* @version
|
|
14701
|
+
* @version 186.0.1
|
|
14640
14702
|
*/ /**
|
|
14641
14703
|
* Constructs a new LocationsApi.
|
|
14642
14704
|
* @alias module:purecloud-platform-client-v2/api/LocationsApi
|
|
@@ -14695,7 +14757,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14695
14757
|
if(body===undefined||body===null){throw'Missing the required parameter "body" when calling postLocationsSearch';}return this.apiClient.callApi('/api/v2/locations/search','POST',{},{},{},{},body,['PureCloud OAuth'],['application/json'],['application/json']);}}]);return LocationsApi;}();var LogCaptureApi=/*#__PURE__*/function(){/**
|
|
14696
14758
|
* LogCapture service.
|
|
14697
14759
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
14698
|
-
* @version
|
|
14760
|
+
* @version 186.0.1
|
|
14699
14761
|
*/ /**
|
|
14700
14762
|
* Constructs a new LogCaptureApi.
|
|
14701
14763
|
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
@@ -14703,19 +14765,49 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14703
14765
|
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
14704
14766
|
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
14705
14767
|
*/function LogCaptureApi(apiClient){_classCallCheck(this,LogCaptureApi);this.apiClient=apiClient||ApiClient.instance;}/**
|
|
14768
|
+
* Disable browser log capture for the user
|
|
14769
|
+
*
|
|
14770
|
+
* @param {String} userId The id of the user to disable browser log capture
|
|
14771
|
+
*/_createClass(LogCaptureApi,[{key:"deleteDiagnosticsLogcaptureBrowserUser",value:function deleteDiagnosticsLogcaptureBrowserUser(userId){// verify the required parameter 'userId' is set
|
|
14772
|
+
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']);}/**
|
|
14706
14773
|
* Gets status of async download execution
|
|
14707
14774
|
*
|
|
14708
14775
|
* @param {String} jobId Job ID
|
|
14709
|
-
*/
|
|
14776
|
+
*/},{key:"getDiagnosticsLogcaptureBrowserEntriesDownloadJob",value:function getDiagnosticsLogcaptureBrowserEntriesDownloadJob(jobId){// verify the required parameter 'jobId' is set
|
|
14710
14777
|
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']);}/**
|
|
14778
|
+
* Get log capture configuration for the user
|
|
14779
|
+
*
|
|
14780
|
+
* @param {String} userId The id of the user to get browser log capture configuration
|
|
14781
|
+
*/},{key:"getDiagnosticsLogcaptureBrowserUser",value:function getDiagnosticsLogcaptureBrowserUser(userId){// verify the required parameter 'userId' is set
|
|
14782
|
+
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']);}/**
|
|
14783
|
+
* Get all log capture enabled users for an org
|
|
14784
|
+
*
|
|
14785
|
+
* @param {Object} opts Optional parameters
|
|
14786
|
+
* @param {Boolean} opts.includeExpired Include expired users with log captures still available for search or download (default to false)
|
|
14787
|
+
*/},{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']);}/**
|
|
14711
14788
|
* Creates an async download execution
|
|
14712
14789
|
*
|
|
14713
14790
|
* @param {Object} opts Optional parameters
|
|
14714
14791
|
* @param {Object} opts.body
|
|
14715
|
-
*/},{key:"postDiagnosticsLogcaptureBrowserEntriesDownloadJobs",value:function postDiagnosticsLogcaptureBrowserEntriesDownloadJobs(opts){opts=opts||{};return this.apiClient.callApi('/api/v2/diagnostics/logcapture/browser/entries/download/jobs','POST',{},{},{},{},opts['body'],['PureCloud OAuth'],['application/json'],['application/json']);}
|
|
14792
|
+
*/},{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']);}/**
|
|
14793
|
+
* Query collected log entries. It returns a limited amount of records, to get all records use download endpoint.
|
|
14794
|
+
*
|
|
14795
|
+
* @param {Object} opts Optional parameters
|
|
14796
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
14797
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
14798
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
14799
|
+
* @param {Object} opts.body
|
|
14800
|
+
*/},{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']);}/**
|
|
14801
|
+
* Enable log capture for a user or update expiration
|
|
14802
|
+
*
|
|
14803
|
+
* @param {String} userId The id of the user to enable browser log capture
|
|
14804
|
+
* @param {Object} opts Optional parameters
|
|
14805
|
+
* @param {Object} opts.body
|
|
14806
|
+
*/},{key:"postDiagnosticsLogcaptureBrowserUser",value:function postDiagnosticsLogcaptureBrowserUser(userId,opts){opts=opts||{};// verify the required parameter 'userId' is set
|
|
14807
|
+
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(){/**
|
|
14716
14808
|
* Messaging service.
|
|
14717
14809
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
14718
|
-
* @version
|
|
14810
|
+
* @version 186.0.1
|
|
14719
14811
|
*/ /**
|
|
14720
14812
|
* Constructs a new MessagingApi.
|
|
14721
14813
|
* @alias module:purecloud-platform-client-v2/api/MessagingApi
|
|
@@ -14805,7 +14897,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14805
14897
|
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(){/**
|
|
14806
14898
|
* MobileDevices service.
|
|
14807
14899
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
14808
|
-
* @version
|
|
14900
|
+
* @version 186.0.1
|
|
14809
14901
|
*/ /**
|
|
14810
14902
|
* Constructs a new MobileDevicesApi.
|
|
14811
14903
|
* @alias module:purecloud-platform-client-v2/api/MobileDevicesApi
|
|
@@ -14844,7 +14936,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
14844
14936
|
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(){/**
|
|
14845
14937
|
* Notifications service.
|
|
14846
14938
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
14847
|
-
* @version
|
|
14939
|
+
* @version 186.0.1
|
|
14848
14940
|
*/ /**
|
|
14849
14941
|
* Constructs a new NotificationsApi.
|
|
14850
14942
|
* @alias module:purecloud-platform-client-v2/api/NotificationsApi
|
|
@@ -14901,7 +14993,7 @@ if(channelId===undefined||channelId===null){throw'Missing the required parameter
|
|
|
14901
14993
|
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(){/**
|
|
14902
14994
|
* OAuth service.
|
|
14903
14995
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
14904
|
-
* @version
|
|
14996
|
+
* @version 186.0.1
|
|
14905
14997
|
*/ /**
|
|
14906
14998
|
* Constructs a new OAuthApi.
|
|
14907
14999
|
* @alias module:purecloud-platform-client-v2/api/OAuthApi
|
|
@@ -14986,7 +15078,7 @@ if(clientId===undefined||clientId===null){throw'Missing the required parameter "
|
|
|
14986
15078
|
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(){/**
|
|
14987
15079
|
* Objects service.
|
|
14988
15080
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
14989
|
-
* @version
|
|
15081
|
+
* @version 186.0.1
|
|
14990
15082
|
*/ /**
|
|
14991
15083
|
* Constructs a new ObjectsApi.
|
|
14992
15084
|
* @alias module:purecloud-platform-client-v2/api/ObjectsApi
|
|
@@ -15018,9 +15110,8 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
15018
15110
|
* @param {String} opts.nextPage next page token
|
|
15019
15111
|
* @param {String} opts.previousPage Previous page token
|
|
15020
15112
|
* @param {Boolean} opts.objectCount Include the count of objects contained in the division (default to false)
|
|
15021
|
-
* @param {Array.<String>} opts.id Optionally request specific divisions by their IDs
|
|
15022
15113
|
* @param {String} opts.name Search term to filter by division name
|
|
15023
|
-
*/},{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'],'
|
|
15114
|
+
*/},{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']);}/**
|
|
15024
15115
|
* Retrieve the home division for the organization.
|
|
15025
15116
|
* Will not include object counts.
|
|
15026
15117
|
*/},{key:"getAuthorizationDivisionsHome",value:function getAuthorizationDivisionsHome(){return this.apiClient.callApi('/api/v2/authorization/divisions/home','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
@@ -15057,7 +15148,7 @@ if(divisionId===undefined||divisionId===null){throw'Missing the required paramet
|
|
|
15057
15148
|
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(){/**
|
|
15058
15149
|
* OperationalEvents service.
|
|
15059
15150
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
15060
|
-
* @version
|
|
15151
|
+
* @version 186.0.1
|
|
15061
15152
|
*/ /**
|
|
15062
15153
|
* Constructs a new OperationalEventsApi.
|
|
15063
15154
|
* @alias module:purecloud-platform-client-v2/api/OperationalEventsApi
|
|
@@ -15075,7 +15166,7 @@ if(eventDefinitionId===undefined||eventDefinitionId===null){throw'Missing the re
|
|
|
15075
15166
|
*/},{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(){/**
|
|
15076
15167
|
* Organization service.
|
|
15077
15168
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
15078
|
-
* @version
|
|
15169
|
+
* @version 186.0.1
|
|
15079
15170
|
*/ /**
|
|
15080
15171
|
* Constructs a new OrganizationApi.
|
|
15081
15172
|
* @alias module:purecloud-platform-client-v2/api/OrganizationApi
|
|
@@ -15177,7 +15268,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
15177
15268
|
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(){/**
|
|
15178
15269
|
* OrganizationAuthorization service.
|
|
15179
15270
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
15180
|
-
* @version
|
|
15271
|
+
* @version 186.0.1
|
|
15181
15272
|
*/ /**
|
|
15182
15273
|
* Constructs a new OrganizationAuthorizationApi.
|
|
15183
15274
|
* @alias module:purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
@@ -15500,7 +15591,7 @@ if(trustorOrgId===undefined||trustorOrgId===null){throw'Missing the required par
|
|
|
15500
15591
|
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(){/**
|
|
15501
15592
|
* Outbound service.
|
|
15502
15593
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
15503
|
-
* @version
|
|
15594
|
+
* @version 186.0.1
|
|
15504
15595
|
*/ /**
|
|
15505
15596
|
* Constructs a new OutboundApi.
|
|
15506
15597
|
* @alias module:purecloud-platform-client-v2/api/OutboundApi
|
|
@@ -16485,7 +16576,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16485
16576
|
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(){/**
|
|
16486
16577
|
* Presence service.
|
|
16487
16578
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
16488
|
-
* @version
|
|
16579
|
+
* @version 186.0.1
|
|
16489
16580
|
*/ /**
|
|
16490
16581
|
* Constructs a new PresenceApi.
|
|
16491
16582
|
* @alias module:purecloud-platform-client-v2/api/PresenceApi
|
|
@@ -16653,7 +16744,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
16653
16744
|
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(){/**
|
|
16654
16745
|
* ProcessAutomation service.
|
|
16655
16746
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
16656
|
-
* @version
|
|
16747
|
+
* @version 186.0.1
|
|
16657
16748
|
*/ /**
|
|
16658
16749
|
* Constructs a new ProcessAutomationApi.
|
|
16659
16750
|
* @alias module:purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
@@ -16716,7 +16807,7 @@ if(triggerId===undefined||triggerId===null){throw'Missing the required parameter
|
|
|
16716
16807
|
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(){/**
|
|
16717
16808
|
* Quality service.
|
|
16718
16809
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
16719
|
-
* @version
|
|
16810
|
+
* @version 186.0.1
|
|
16720
16811
|
*/ /**
|
|
16721
16812
|
* Constructs a new QualityApi.
|
|
16722
16813
|
* @alias module:purecloud-platform-client-v2/api/QualityApi
|
|
@@ -17146,7 +17237,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17146
17237
|
if(calibrationId===undefined||calibrationId===null){throw'Missing the required parameter "calibrationId" when calling putQualityCalibration';}// verify the required parameter 'body' is set
|
|
17147
17238
|
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']);}/**
|
|
17148
17239
|
* Update an evaluation
|
|
17149
|
-
* 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.
|
|
17240
|
+
* 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.
|
|
17150
17241
|
* @param {String} conversationId conversationId
|
|
17151
17242
|
* @param {String} evaluationId evaluationId
|
|
17152
17243
|
* @param {Object} body evaluation
|
|
@@ -17187,7 +17278,7 @@ if(customerSurveyUrl===undefined||customerSurveyUrl===null){throw'Missing the re
|
|
|
17187
17278
|
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(){/**
|
|
17188
17279
|
* Recording service.
|
|
17189
17280
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
17190
|
-
* @version
|
|
17281
|
+
* @version 186.0.1
|
|
17191
17282
|
*/ /**
|
|
17192
17283
|
* Constructs a new RecordingApi.
|
|
17193
17284
|
* @alias module:purecloud-platform-client-v2/api/RecordingApi
|
|
@@ -17594,7 +17685,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
17594
17685
|
*/},{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(){/**
|
|
17595
17686
|
* ResponseManagement service.
|
|
17596
17687
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
17597
|
-
* @version
|
|
17688
|
+
* @version 186.0.1
|
|
17598
17689
|
*/ /**
|
|
17599
17690
|
* Constructs a new ResponseManagementApi.
|
|
17600
17691
|
* @alias module:purecloud-platform-client-v2/api/ResponseManagementApi
|
|
@@ -17710,7 +17801,7 @@ if(responseAssetId===undefined||responseAssetId===null){throw'Missing the requir
|
|
|
17710
17801
|
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(){/**
|
|
17711
17802
|
* Routing service.
|
|
17712
17803
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
17713
|
-
* @version
|
|
17804
|
+
* @version 186.0.1
|
|
17714
17805
|
*/ /**
|
|
17715
17806
|
* Constructs a new RoutingApi.
|
|
17716
17807
|
* @alias module:purecloud-platform-client-v2/api/RoutingApi
|
|
@@ -17810,6 +17901,14 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
17810
17901
|
* Delete the organization-wide max utilization settings and revert to the system default.
|
|
17811
17902
|
*
|
|
17812
17903
|
*/},{key:"deleteRoutingUtilization",value:function deleteRoutingUtilization(){return this.apiClient.callApi('/api/v2/routing/utilization','DELETE',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
17904
|
+
* Delete a utilization label
|
|
17905
|
+
*
|
|
17906
|
+
* @param {String} labelId Utilization Label ID
|
|
17907
|
+
* @param {Object} opts Optional parameters
|
|
17908
|
+
* @param {Boolean} opts.forceDelete Remove all label usages (if found) without warning (default to false)
|
|
17909
|
+
* deleteRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17910
|
+
*/},{key:"deleteRoutingUtilizationLabel",value:function deleteRoutingUtilizationLabel(labelId,opts){opts=opts||{};// verify the required parameter 'labelId' is set
|
|
17911
|
+
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']);}/**
|
|
17813
17912
|
* Delete an utilization tag
|
|
17814
17913
|
*
|
|
17815
17914
|
* @param {String} tagId Utilization Tag ID
|
|
@@ -18193,6 +18292,27 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
18193
18292
|
* Get the organization-wide max utilization settings.
|
|
18194
18293
|
*
|
|
18195
18294
|
*/},{key:"getRoutingUtilization",value:function getRoutingUtilization(){return this.apiClient.callApi('/api/v2/routing/utilization','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
18295
|
+
* Get details about this utilization label
|
|
18296
|
+
*
|
|
18297
|
+
* @param {String} labelId Utilization Label ID
|
|
18298
|
+
* getRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18299
|
+
*/},{key:"getRoutingUtilizationLabel",value:function getRoutingUtilizationLabel(labelId){// verify the required parameter 'labelId' is set
|
|
18300
|
+
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']);}/**
|
|
18301
|
+
* Get list of agent ids associated with a utilization label
|
|
18302
|
+
*
|
|
18303
|
+
* @param {String} labelId Utilization Label ID
|
|
18304
|
+
* getRoutingUtilizationLabelAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18305
|
+
*/},{key:"getRoutingUtilizationLabelAgents",value:function getRoutingUtilizationLabelAgents(labelId){// verify the required parameter 'labelId' is set
|
|
18306
|
+
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']);}/**
|
|
18307
|
+
* Get list of utilization labels
|
|
18308
|
+
*
|
|
18309
|
+
* @param {Object} opts Optional parameters
|
|
18310
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
18311
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
18312
|
+
* @param {Object} opts.sortOrder Sort order by name (default to ascending)
|
|
18313
|
+
* @param {String} opts.name Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*'
|
|
18314
|
+
* getRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18315
|
+
*/},{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']);}/**
|
|
18196
18316
|
* Get details about this utilization tag
|
|
18197
18317
|
*
|
|
18198
18318
|
* @param {String} tagId Utilization Tag ID
|
|
@@ -18230,6 +18350,21 @@ if(codeId===undefined||codeId===null){throw'Missing the required parameter "code
|
|
|
18230
18350
|
* @param {Array.<String>} opts.id Filter by wrapup code ID(s)
|
|
18231
18351
|
* @param {Array.<String>} opts.divisionId Filter by division ID(s)
|
|
18232
18352
|
*/},{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']);}/**
|
|
18353
|
+
* Get a simplified wrap-up code.
|
|
18354
|
+
*
|
|
18355
|
+
* @param {String} codeId Wrapup Code ID
|
|
18356
|
+
*/},{key:"getRoutingWrapupcodesDivisionview",value:function getRoutingWrapupcodesDivisionview(codeId){// verify the required parameter 'codeId' is set
|
|
18357
|
+
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']);}/**
|
|
18358
|
+
* Get a paged listing of simplified wrapup code objects, filterable by name, wrapup code ID(s), or division ID(s).
|
|
18359
|
+
* Specifying both name and ID parameters is not supported.
|
|
18360
|
+
* @param {Object} opts Optional parameters
|
|
18361
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
18362
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
18363
|
+
* @param {String} opts.name Name (trailing asterisks allowed)
|
|
18364
|
+
* @param {Array.<String>} opts.id Wrapup code ID(s)
|
|
18365
|
+
* @param {Array.<String>} opts.divisionId Division ID(s)
|
|
18366
|
+
* @param {Object} opts.includeState Wrapup code state(s) to include
|
|
18367
|
+
*/},{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']);}/**
|
|
18233
18368
|
* Get queues for user
|
|
18234
18369
|
*
|
|
18235
18370
|
* @param {String} userId User ID
|
|
@@ -18334,6 +18469,11 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18334
18469
|
* @param {Object} body Contact Center Settings
|
|
18335
18470
|
*/},{key:"patchRoutingSettingsContactcenter",value:function patchRoutingSettingsContactcenter(body){// verify the required parameter 'body' is set
|
|
18336
18471
|
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']);}/**
|
|
18472
|
+
* Patch Transcription Settings
|
|
18473
|
+
*
|
|
18474
|
+
* @param {Object} body Organization Settings
|
|
18475
|
+
*/},{key:"patchRoutingSettingsTranscription",value:function patchRoutingSettingsTranscription(body){// verify the required parameter 'body' is set
|
|
18476
|
+
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']);}/**
|
|
18337
18477
|
* Update skill group definition
|
|
18338
18478
|
*
|
|
18339
18479
|
* @param {String} skillGroupId Skill Group ID
|
|
@@ -18506,9 +18646,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18506
18646
|
* Imports a phone number for SMS
|
|
18507
18647
|
*
|
|
18508
18648
|
* @param {Object} body SmsPhoneNumber
|
|
18509
|
-
* postRoutingSmsPhonenumbersImport is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18510
18649
|
*/},{key:"postRoutingSmsPhonenumbersImport",value:function postRoutingSmsPhonenumbersImport(body){// verify the required parameter 'body' is set
|
|
18511
18650
|
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']);}/**
|
|
18651
|
+
* Create a utilization label
|
|
18652
|
+
*
|
|
18653
|
+
* @param {Object} body UtilizationLabel
|
|
18654
|
+
* postRoutingUtilizationLabels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18655
|
+
*/},{key:"postRoutingUtilizationLabels",value:function postRoutingUtilizationLabels(body){// verify the required parameter 'body' is set
|
|
18656
|
+
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']);}/**
|
|
18512
18657
|
* Create an utilization tag
|
|
18513
18658
|
*
|
|
18514
18659
|
* @param {Object} body UtilizationTag
|
|
@@ -18591,6 +18736,14 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
18591
18736
|
* @param {Object} body utilization
|
|
18592
18737
|
*/},{key:"putRoutingUtilization",value:function putRoutingUtilization(body){// verify the required parameter 'body' is set
|
|
18593
18738
|
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']);}/**
|
|
18739
|
+
* Update a utilization label
|
|
18740
|
+
*
|
|
18741
|
+
* @param {String} labelId Utilization Label ID
|
|
18742
|
+
* @param {Object} body UtilizationLabel
|
|
18743
|
+
* putRoutingUtilizationLabel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18744
|
+
*/},{key:"putRoutingUtilizationLabel",value:function putRoutingUtilizationLabel(labelId,body){// verify the required parameter 'labelId' is set
|
|
18745
|
+
if(labelId===undefined||labelId===null){throw'Missing the required parameter "labelId" when calling putRoutingUtilizationLabel';}// verify the required parameter 'body' is set
|
|
18746
|
+
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']);}/**
|
|
18594
18747
|
* Update wrap-up code
|
|
18595
18748
|
*
|
|
18596
18749
|
* @param {String} codeId Wrapup Code ID
|
|
@@ -18616,7 +18769,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
18616
18769
|
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(){/**
|
|
18617
18770
|
* SCIM service.
|
|
18618
18771
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
18619
|
-
* @version
|
|
18772
|
+
* @version 186.0.1
|
|
18620
18773
|
*/ /**
|
|
18621
18774
|
* Constructs a new SCIMApi.
|
|
18622
18775
|
* @alias module:purecloud-platform-client-v2/api/SCIMApi
|
|
@@ -18841,7 +18994,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
18841
18994
|
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(){/**
|
|
18842
18995
|
* Scripts service.
|
|
18843
18996
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
18844
|
-
* @version
|
|
18997
|
+
* @version 186.0.1
|
|
18845
18998
|
*/ /**
|
|
18846
18999
|
* Constructs a new ScriptsApi.
|
|
18847
19000
|
* @alias module:purecloud-platform-client-v2/api/ScriptsApi
|
|
@@ -18977,7 +19130,7 @@ if(scriptId===undefined||scriptId===null){throw'Missing the required parameter "
|
|
|
18977
19130
|
*/},{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(){/**
|
|
18978
19131
|
* Search service.
|
|
18979
19132
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
18980
|
-
* @version
|
|
19133
|
+
* @version 186.0.1
|
|
18981
19134
|
*/ /**
|
|
18982
19135
|
* Constructs a new SearchApi.
|
|
18983
19136
|
* @alias module:purecloud-platform-client-v2/api/SearchApi
|
|
@@ -19137,7 +19290,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19137
19290
|
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(){/**
|
|
19138
19291
|
* Settings service.
|
|
19139
19292
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
19140
|
-
* @version
|
|
19293
|
+
* @version 186.0.1
|
|
19141
19294
|
*/ /**
|
|
19142
19295
|
* Constructs a new SettingsApi.
|
|
19143
19296
|
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
@@ -19155,7 +19308,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19155
19308
|
*/},{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(){/**
|
|
19156
19309
|
* SpeechTextAnalytics service.
|
|
19157
19310
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
19158
|
-
* @version
|
|
19311
|
+
* @version 186.0.1
|
|
19159
19312
|
*/ /**
|
|
19160
19313
|
* Constructs a new SpeechTextAnalyticsApi.
|
|
19161
19314
|
* @alias module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
@@ -19398,7 +19551,7 @@ if(topicId===undefined||topicId===null){throw'Missing the required parameter "to
|
|
|
19398
19551
|
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(){/**
|
|
19399
19552
|
* Stations service.
|
|
19400
19553
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
19401
|
-
* @version
|
|
19554
|
+
* @version 186.0.1
|
|
19402
19555
|
*/ /**
|
|
19403
19556
|
* Constructs a new StationsApi.
|
|
19404
19557
|
* @alias module:purecloud-platform-client-v2/api/StationsApi
|
|
@@ -19430,7 +19583,7 @@ if(stationId===undefined||stationId===null){throw'Missing the required parameter
|
|
|
19430
19583
|
*/},{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(){/**
|
|
19431
19584
|
* Suggest service.
|
|
19432
19585
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
19433
|
-
* @version
|
|
19586
|
+
* @version 186.0.1
|
|
19434
19587
|
*/ /**
|
|
19435
19588
|
* Constructs a new SuggestApi.
|
|
19436
19589
|
* @alias module:purecloud-platform-client-v2/api/SuggestApi
|
|
@@ -19470,7 +19623,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19470
19623
|
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(){/**
|
|
19471
19624
|
* TaskManagement service.
|
|
19472
19625
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
19473
|
-
* @version
|
|
19626
|
+
* @version 186.0.1
|
|
19474
19627
|
*/ /**
|
|
19475
19628
|
* Constructs a new TaskManagementApi.
|
|
19476
19629
|
* @alias module:purecloud-platform-client-v2/api/TaskManagementApi
|
|
@@ -19812,7 +19965,7 @@ if(schemaId===undefined||schemaId===null){throw'Missing the required parameter "
|
|
|
19812
19965
|
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(){/**
|
|
19813
19966
|
* Teams service.
|
|
19814
19967
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
19815
|
-
* @version
|
|
19968
|
+
* @version 186.0.1
|
|
19816
19969
|
*/ /**
|
|
19817
19970
|
* Constructs a new TeamsApi.
|
|
19818
19971
|
* @alias module:purecloud-platform-client-v2/api/TeamsApi
|
|
@@ -19891,7 +20044,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19891
20044
|
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(){/**
|
|
19892
20045
|
* Telephony service.
|
|
19893
20046
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
19894
|
-
* @version
|
|
20047
|
+
* @version 186.0.1
|
|
19895
20048
|
*/ /**
|
|
19896
20049
|
* Constructs a new TelephonyApi.
|
|
19897
20050
|
* @alias module:purecloud-platform-client-v2/api/TelephonyApi
|
|
@@ -19905,7 +20058,6 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
19905
20058
|
* Get a SIP message.
|
|
19906
20059
|
* Get the raw form of the SIP message
|
|
19907
20060
|
* @param {String} conversationId Conversation id
|
|
19908
|
-
* getTelephonySipmessagesConversation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19909
20061
|
*/},{key:"getTelephonySipmessagesConversation",value:function getTelephonySipmessagesConversation(conversationId){// verify the required parameter 'conversationId' is set
|
|
19910
20062
|
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']);}/**
|
|
19911
20063
|
* Get SIP headers.
|
|
@@ -19913,7 +20065,6 @@ if(conversationId===undefined||conversationId===null){throw'Missing the required
|
|
|
19913
20065
|
* @param {String} conversationId Conversation id
|
|
19914
20066
|
* @param {Object} opts Optional parameters
|
|
19915
20067
|
* @param {Array.<String>} opts.keys comma-separated list of header identifiers to query. e.g. ruri,to,from
|
|
19916
|
-
* getTelephonySipmessagesConversationHeaders is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
19917
20068
|
*/},{key:"getTelephonySipmessagesConversationHeaders",value:function getTelephonySipmessagesConversationHeaders(conversationId,opts){opts=opts||{};// verify the required parameter 'conversationId' is set
|
|
19918
20069
|
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']);}/**
|
|
19919
20070
|
* Fetch SIP metadata
|
|
@@ -19940,7 +20091,7 @@ if(downloadId===undefined||downloadId===null){throw'Missing the required paramet
|
|
|
19940
20091
|
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(){/**
|
|
19941
20092
|
* TelephonyProvidersEdge service.
|
|
19942
20093
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
19943
|
-
* @version
|
|
20094
|
+
* @version 186.0.1
|
|
19944
20095
|
*/ /**
|
|
19945
20096
|
* Constructs a new TelephonyProvidersEdgeApi.
|
|
19946
20097
|
* @alias module:purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
@@ -20118,8 +20269,9 @@ if(edgeId===undefined||edgeId===null){throw'Missing the required parameter "edge
|
|
|
20118
20269
|
* @param {Boolean} opts.managed Filter by managed
|
|
20119
20270
|
* @param {Boolean} opts.showCloudMedia True to show the cloud media devices in the result. (default to true)
|
|
20120
20271
|
*/},{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']);}/**
|
|
20121
|
-
* Get the list of available languages.
|
|
20272
|
+
* Get the list of available languages. For never released keyword spotting feature. Deprecated, do not use.
|
|
20122
20273
|
*
|
|
20274
|
+
* @deprecated
|
|
20123
20275
|
*/},{key:"getTelephonyProvidersEdgesAvailablelanguages",value:function getTelephonyProvidersEdgesAvailablelanguages(){return this.apiClient.callApi('/api/v2/telephony/providers/edges/availablelanguages','GET',{},{},{},{},null,['PureCloud OAuth'],['application/json'],['application/json']);}/**
|
|
20124
20276
|
* Get the list of certificate authorities.
|
|
20125
20277
|
*
|
|
@@ -20227,7 +20379,6 @@ if(extensionPoolId===undefined||extensionPoolId===null){throw'Missing the requir
|
|
|
20227
20379
|
* @param {Array.<String>} opts.id ID of the Extension Pools to filter by.
|
|
20228
20380
|
* @param {String} opts.name Name of the Extension Pools to filter by.
|
|
20229
20381
|
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
20230
|
-
* getTelephonyProvidersEdgesExtensionpoolsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
20231
20382
|
*/},{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']);}/**
|
|
20232
20383
|
* Get a listing of extensions
|
|
20233
20384
|
*
|
|
@@ -20432,7 +20583,8 @@ if(siteId===undefined||siteId===null){throw'Missing the required parameter "site
|
|
|
20432
20583
|
* @param {String} opts.name Name
|
|
20433
20584
|
* @param {String} opts.locationId Location Id
|
|
20434
20585
|
* @param {Boolean} opts.managed Filter by managed
|
|
20435
|
-
|
|
20586
|
+
* @param {Array.<String>} opts.expand Fields to expand in the response, comma-separated
|
|
20587
|
+
*/},{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']);}/**
|
|
20436
20588
|
* Get a list of Edge-compatible time zones
|
|
20437
20589
|
*
|
|
20438
20590
|
* @param {Object} opts Optional parameters
|
|
@@ -20759,7 +20911,7 @@ if(trunkBaseSettingsId===undefined||trunkBaseSettingsId===null){throw'Missing th
|
|
|
20759
20911
|
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(){/**
|
|
20760
20912
|
* Textbots service.
|
|
20761
20913
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
20762
|
-
* @version
|
|
20914
|
+
* @version 186.0.1
|
|
20763
20915
|
*/ /**
|
|
20764
20916
|
* Constructs a new TextbotsApi.
|
|
20765
20917
|
* @alias module:purecloud-platform-client-v2/api/TextbotsApi
|
|
@@ -20794,7 +20946,7 @@ if(launchRequest===undefined||launchRequest===null){throw'Missing the required p
|
|
|
20794
20946
|
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(){/**
|
|
20795
20947
|
* Tokens service.
|
|
20796
20948
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
20797
|
-
* @version
|
|
20949
|
+
* @version 186.0.1
|
|
20798
20950
|
*/ /**
|
|
20799
20951
|
* Constructs a new TokensApi.
|
|
20800
20952
|
* @alias module:purecloud-platform-client-v2/api/TokensApi
|
|
@@ -20830,7 +20982,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
20830
20982
|
*/},{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(){/**
|
|
20831
20983
|
* Uploads service.
|
|
20832
20984
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
20833
|
-
* @version
|
|
20985
|
+
* @version 186.0.1
|
|
20834
20986
|
*/ /**
|
|
20835
20987
|
* Constructs a new UploadsApi.
|
|
20836
20988
|
* @alias module:purecloud-platform-client-v2/api/UploadsApi
|
|
@@ -20872,7 +21024,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20872
21024
|
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(){/**
|
|
20873
21025
|
* Usage service.
|
|
20874
21026
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
20875
|
-
* @version
|
|
21027
|
+
* @version 186.0.1
|
|
20876
21028
|
*/ /**
|
|
20877
21029
|
* Constructs a new UsageApi.
|
|
20878
21030
|
* @alias module:purecloud-platform-client-v2/api/UsageApi
|
|
@@ -20923,7 +21075,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
20923
21075
|
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(){/**
|
|
20924
21076
|
* UserRecordings service.
|
|
20925
21077
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
20926
|
-
* @version
|
|
21078
|
+
* @version 186.0.1
|
|
20927
21079
|
*/ /**
|
|
20928
21080
|
* Constructs a new UserRecordingsApi.
|
|
20929
21081
|
* @alias module:purecloud-platform-client-v2/api/UserRecordingsApi
|
|
@@ -20972,7 +21124,7 @@ if(recordingId===undefined||recordingId===null){throw'Missing the required param
|
|
|
20972
21124
|
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(){/**
|
|
20973
21125
|
* Users service.
|
|
20974
21126
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
20975
|
-
* @version
|
|
21127
|
+
* @version 186.0.1
|
|
20976
21128
|
*/ /**
|
|
20977
21129
|
* Constructs a new UsersApi.
|
|
20978
21130
|
* @alias module:purecloud-platform-client-v2/api/UsersApi
|
|
@@ -21631,7 +21783,7 @@ if(verifierId===undefined||verifierId===null){throw'Missing the required paramet
|
|
|
21631
21783
|
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(){/**
|
|
21632
21784
|
* Utilities service.
|
|
21633
21785
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
21634
|
-
* @version
|
|
21786
|
+
* @version 186.0.1
|
|
21635
21787
|
*/ /**
|
|
21636
21788
|
* Constructs a new UtilitiesApi.
|
|
21637
21789
|
* @alias module:purecloud-platform-client-v2/api/UtilitiesApi
|
|
@@ -21658,7 +21810,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21658
21810
|
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(){/**
|
|
21659
21811
|
* Voicemail service.
|
|
21660
21812
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
21661
|
-
* @version
|
|
21813
|
+
* @version 186.0.1
|
|
21662
21814
|
*/ /**
|
|
21663
21815
|
* Constructs a new VoicemailApi.
|
|
21664
21816
|
* @alias module:purecloud-platform-client-v2/api/VoicemailApi
|
|
@@ -21807,7 +21959,7 @@ if(userId===undefined||userId===null){throw'Missing the required parameter "user
|
|
|
21807
21959
|
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(){/**
|
|
21808
21960
|
* WebChat service.
|
|
21809
21961
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
21810
|
-
* @version
|
|
21962
|
+
* @version 186.0.1
|
|
21811
21963
|
*/ /**
|
|
21812
21964
|
* Constructs a new WebChatApi.
|
|
21813
21965
|
* @alias module:purecloud-platform-client-v2/api/WebChatApi
|
|
@@ -21940,7 +22092,7 @@ if(body===undefined||body===null){throw'Missing the required parameter "body" wh
|
|
|
21940
22092
|
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(){/**
|
|
21941
22093
|
* WebDeployments service.
|
|
21942
22094
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
21943
|
-
* @version
|
|
22095
|
+
* @version 186.0.1
|
|
21944
22096
|
*/ /**
|
|
21945
22097
|
* Constructs a new WebDeploymentsApi.
|
|
21946
22098
|
* @alias module:purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
@@ -22061,7 +22213,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
22061
22213
|
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(){/**
|
|
22062
22214
|
* WebMessaging service.
|
|
22063
22215
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
22064
|
-
* @version
|
|
22216
|
+
* @version 186.0.1
|
|
22065
22217
|
*/ /**
|
|
22066
22218
|
* Constructs a new WebMessagingApi.
|
|
22067
22219
|
* @alias module:purecloud-platform-client-v2/api/WebMessagingApi
|
|
@@ -22077,7 +22229,7 @@ if(deployment===undefined||deployment===null){throw'Missing the required paramet
|
|
|
22077
22229
|
*/_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(){/**
|
|
22078
22230
|
* Widgets service.
|
|
22079
22231
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
22080
|
-
* @version
|
|
22232
|
+
* @version 186.0.1
|
|
22081
22233
|
*/ /**
|
|
22082
22234
|
* Constructs a new WidgetsApi.
|
|
22083
22235
|
* @alias module:purecloud-platform-client-v2/api/WidgetsApi
|
|
@@ -22112,7 +22264,7 @@ if(deploymentId===undefined||deploymentId===null){throw'Missing the required par
|
|
|
22112
22264
|
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(){/**
|
|
22113
22265
|
* WorkforceManagement service.
|
|
22114
22266
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
22115
|
-
* @version
|
|
22267
|
+
* @version 186.0.1
|
|
22116
22268
|
*/ /**
|
|
22117
22269
|
* Constructs a new WorkforceManagementApi.
|
|
22118
22270
|
* @alias module:purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
@@ -22381,6 +22533,26 @@ if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required
|
|
|
22381
22533
|
if(weekId===undefined||weekId===null){throw'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent';}// verify the required parameter 'scheduleId' is set
|
|
22382
22534
|
if(scheduleId===undefined||scheduleId===null){throw'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekScheduleHistoryAgent';}// verify the required parameter 'agentId' is set
|
|
22383
22535
|
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']);}/**
|
|
22536
|
+
* Get the performance prediction for the associated schedule
|
|
22537
|
+
*
|
|
22538
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
22539
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
22540
|
+
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
22541
|
+
*/},{key:"getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions",value:function getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions(businessUnitId,weekId,scheduleId){// verify the required parameter 'businessUnitId' is set
|
|
22542
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';}// verify the required parameter 'weekId' is set
|
|
22543
|
+
if(weekId===undefined||weekId===null){throw'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictions';}// verify the required parameter 'scheduleId' is set
|
|
22544
|
+
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']);}/**
|
|
22545
|
+
* Get recalculated performance prediction result
|
|
22546
|
+
*
|
|
22547
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
22548
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
22549
|
+
* @param {String} scheduleId The ID of the schedule the recalculation belongs to
|
|
22550
|
+
* @param {String} recalculationId The ID of the recalculation request
|
|
22551
|
+
*/},{key:"getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation",value:function getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation(businessUnitId,weekId,scheduleId,recalculationId){// verify the required parameter 'businessUnitId' is set
|
|
22552
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';}// verify the required parameter 'weekId' is set
|
|
22553
|
+
if(weekId===undefined||weekId===null){throw'Missing the required parameter "weekId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';}// verify the required parameter 'scheduleId' is set
|
|
22554
|
+
if(scheduleId===undefined||scheduleId===null){throw'Missing the required parameter "scheduleId" when calling getWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculation';}// verify the required parameter 'recalculationId' is set
|
|
22555
|
+
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']);}/**
|
|
22384
22556
|
* Get the list of week schedules for the specified week
|
|
22385
22557
|
* 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
|
|
22386
22558
|
* @param {String} businessUnitId The ID of the business unit
|
|
@@ -22443,6 +22615,17 @@ if(forecastId===undefined||forecastId===null){throw'Missing the required paramet
|
|
|
22443
22615
|
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups';}// verify the required parameter 'weekDateId' is set
|
|
22444
22616
|
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastPlanninggroups';}// verify the required parameter 'forecastId' is set
|
|
22445
22617
|
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']);}/**
|
|
22618
|
+
* Get the staffing requirement by planning group for a forecast
|
|
22619
|
+
*
|
|
22620
|
+
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
22621
|
+
* @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
|
|
22622
|
+
* @param {String} forecastId The ID of the forecast
|
|
22623
|
+
* @param {Object} opts Optional parameters
|
|
22624
|
+
* @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
|
|
22625
|
+
*/},{key:"getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement",value:function getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement(businessUnitId,weekDateId,forecastId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
22626
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';}// verify the required parameter 'weekDateId' is set
|
|
22627
|
+
if(weekDateId===undefined||weekDateId===null){throw'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitWeekShorttermforecastStaffingrequirement';}// verify the required parameter 'forecastId' is set
|
|
22628
|
+
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']);}/**
|
|
22446
22629
|
* Get short term forecasts
|
|
22447
22630
|
* 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
|
|
22448
22631
|
* @param {String} businessUnitId The ID of the business unit to which the forecast belongs
|
|
@@ -22759,6 +22942,13 @@ if(serviceGoalTemplateId===undefined||serviceGoalTemplateId===null){throw'Missin
|
|
|
22759
22942
|
* @param {Object} opts.body body
|
|
22760
22943
|
*/},{key:"patchWorkforcemanagementManagementunit",value:function patchWorkforcemanagementManagementunit(managementUnitId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
22761
22944
|
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']);}/**
|
|
22945
|
+
* Update agent configurations
|
|
22946
|
+
*
|
|
22947
|
+
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
22948
|
+
* @param {Object} opts Optional parameters
|
|
22949
|
+
* @param {Object} opts.body body
|
|
22950
|
+
*/},{key:"patchWorkforcemanagementManagementunitAgents",value:function patchWorkforcemanagementManagementunitAgents(managementUnitId,opts){opts=opts||{};// verify the required parameter 'managementUnitId' is set
|
|
22951
|
+
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']);}/**
|
|
22762
22952
|
* Updates a time off limit object.
|
|
22763
22953
|
* Updates time off limit object properties, but not daily values.
|
|
22764
22954
|
* @param {String} managementUnitId The ID of the management unit.
|
|
@@ -22970,6 +23160,28 @@ if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required
|
|
|
22970
23160
|
if(weekId===undefined||weekId===null){throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekScheduleCopy';}// verify the required parameter 'scheduleId' is set
|
|
22971
23161
|
if(scheduleId===undefined||scheduleId===null){throw'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekScheduleCopy';}// verify the required parameter 'body' is set
|
|
22972
23162
|
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']);}/**
|
|
23163
|
+
* Request a daily recalculation of the performance prediction for the associated schedule
|
|
23164
|
+
*
|
|
23165
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
23166
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
23167
|
+
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
23168
|
+
* @param {Object} opts Optional parameters
|
|
23169
|
+
* @param {Object} opts.body body
|
|
23170
|
+
*/},{key:"postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations",value:function postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations(businessUnitId,weekId,scheduleId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23171
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';}// verify the required parameter 'weekId' is set
|
|
23172
|
+
if(weekId===undefined||weekId===null){throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';}// verify the required parameter 'scheduleId' is set
|
|
23173
|
+
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']);}/**
|
|
23174
|
+
* Upload daily activity changes to be able to request a performance prediction recalculation
|
|
23175
|
+
*
|
|
23176
|
+
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
23177
|
+
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
23178
|
+
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
23179
|
+
* @param {Object} opts Optional parameters
|
|
23180
|
+
* @param {Object} opts.body body
|
|
23181
|
+
*/},{key:"postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl",value:function postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl(businessUnitId,weekId,scheduleId,opts){opts=opts||{};// verify the required parameter 'businessUnitId' is set
|
|
23182
|
+
if(businessUnitId===undefined||businessUnitId===null){throw'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';}// verify the required parameter 'weekId' is set
|
|
23183
|
+
if(weekId===undefined||weekId===null){throw'Missing the required parameter "weekId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';}// verify the required parameter 'scheduleId' is set
|
|
23184
|
+
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']);}/**
|
|
22973
23185
|
* Start a rescheduling run
|
|
22974
23186
|
*
|
|
22975
23187
|
* @param {String} businessUnitId The ID of the business unit
|
|
@@ -23403,7 +23615,7 @@ if(timeOffLimitId===undefined||timeOffLimitId===null){throw'Missing the required
|
|
|
23403
23615
|
* </pre>
|
|
23404
23616
|
* </p>
|
|
23405
23617
|
* @module purecloud-platform-client-v2/index
|
|
23406
|
-
* @version
|
|
23618
|
+
* @version 186.0.1
|
|
23407
23619
|
*/var platformClient=/*#__PURE__*/_createClass(function platformClient(){_classCallCheck(this,platformClient);/**
|
|
23408
23620
|
* The ApiClient constructor.
|
|
23409
23621
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|